C3D2-Web: Unterschied zwischen den Versionen

Aus C3D2
Zur Navigation springen Zur Suche springen
(→‎Web: Triggerbot)
K (bugfix)
Zeile 63: Zeile 63:
==News schreiben==
==News schreiben==
#'''c3d2-web/content/news.xml''' öffnen
#'''c3d2-web/content/news.xml''' öffnen
#Oberstes '''<news/>'''-Element kopieren
#Oberstes '''<item/>'''-Element kopieren
#Gewünschte Attribute und Inhalt eingeben
#Gewünschte Attribute und Inhalt eingeben
#'''make''' und im Browser anschauen
#'''make''' und im Browser anschauen
#'''svn commit'''
#'''svn commit'''
News befinden sich in der Datei ''c3d2-web/content/news.xml''. Hier fügt man im ''<news/>''-Element ganz oben ein neues ''<item/>'' ein.


Das sieht dann so aus:
Das sieht dann so aus:

Version vom 20. Dezember 2005, 15:33 Uhr

Über C3D2-Web

C3D2-Web ist die neue Website für http://www.c3d2.de/

Bevor zu viele Leute enttäuscht werden, soll diese erstmal testweise ausgerollt werden, damit an der Seite interessierte Leute damit rumexperimentieren können.

Propaganda

Wir verlassen uns hier nicht auf irgendein CMS, sondern verwenden standardisierte, etablierte Techniken. Für XSLT gibt es mehr als eine Implementation. Des weiteren ist es bereits so, dass das System schon von mehr als einer Person kapiert wird.

Als Side-effect sollte noch gesagt werden, dass sämtliche Seiten statisch sind. Wir sind also gegen XSS und xyz-Injection gefeit. Passwortabfragen können wir immernoch mit .htaccess lösen.

Wo?

SVN

Subversion bietet uns praktisch Wiki-Funktionalität:

  • Jeder darf bearbeiten
  • Änderungen sind verfolgbar

Um mitzumachen kann man sich das ganze Paket mit folgendem Befehl holen:

svn co svn://svn.cccv.de/c3d2-web/trunk c3d2-web

Danach hat man ein Verzeichnis c3d2-web/ auf Platte, mit dem man herumexperimentieren kann. Um es auf den neuesten Stand zu bringen, reicht es in diesem Verzeichnis den folgenden Befehl auszuführen:

svn up

Für die aktive Beteiligung braucht man natürlich einen Account mit Schreibrechten. Für einen solchen muss man nur Sven benachrichtigen. Nach diesem Account wird beim nächsten svn ci gefragt.

Web

Stündlich gebaut: http://ωωω.c3d2.de/ (bzw. http://newwww.c3d2.de/)

Wenn zudem etwas in das SVN eingecheckt wird, dann werden Commit-Messages per Jabber empfangen. Ein spezieller Triggerbot empfängt diese ebenfalls, wird dann die Homepage sofort neubauen und publizieren.

Bearbeiten

Während das hier alles nach viel aussieht, gibt es den entscheidenden Vorteil: XML ist selbsterklärend!

Grundlegendes zum Umgang

Verzeichnis Bedeutung
www/ Hier hinein kommen die HTML-Dateien. Daneben gibt es bereits CSS- und Bildchen-Dateien.
xsl/ Hier residieren die Definitionen, aus dem XML-Inhalt XHTML-Webseiten und RSS-Feeds zu bauen.
content/ XML-Dateien mit Inhalten

Den gewöhnlichen Autor interessieren eigentlich nur die Dateien in content/. Dort kann er die XML-Dateien nach unten genannten Schemata bearbeiten. Wenn kein gültiges XML eingefüttert wird, spuckt xsltproc schon erklärende Fehlermeldungen.

Zeichensätze

Die sind wichtig. Alle XML-Dateien werden als UTF-8 kodiert. Für vim-Benutzer mit ISO8859-Terminal:

:set termencoding=latin1
:set fileencoding=utf8

Build

Um zu schauen, wie sich die eigenen Änderungen machen, gibt man im c3d2-web/-Verzeichnis make (unter *BSD: gmake) ein. Dann werden mithilfe xsltproc (oft in libxslt paketiert) in Windeseile in www/ die html- und rss-Dateien gebaut.

Beim Build-Prozess wird http://www.ccc.de/updates/chaosupdates.rdf für die Seitenleiste gesaugt. Das passiert aber nur einmal, bis man make clean ausführt.

News schreiben

  1. c3d2-web/content/news.xml öffnen
  2. Oberstes <item/>-Element kopieren
  3. Gewünschte Attribute und Inhalt eingeben
  4. make und im Browser anschauen
  5. svn commit

Das sieht dann so aus:

<?xml version="1.0" encoding="UTF-8"?>

<page title="News">
 <news>

  <item title="Atom-Powered Robots Run Amok"
        date="Tue, 23 May 2038 23:05:23 CEST"
        nicedate="Dienstag, 23. Mai"
        author="Fnordic walker"
        category="Allgemein">
   <p>
     <image class="left"
            title="Robots running amok">http://www.cnn.com/breaking_news/20380523_23.png</image>
     Asimov's First Law horribly violated!
    </p>
  </item>

  [alte news-items]

 </news>
</page>

<item/>-Attribute

Attribut Beschreibung
title News-Titel
date News-Datum in standardisierter Form, z.B. für RSS-Feeds und automatisierte Verarbeitung
nicedate News-Datum, wie es auf der Website angezeigt werden soll
author Wer hats geschrieben?
category Eine Kategorie (sowas hatte die alte Seite auch)

Inhalt

Den sollte man in ein <p/> einschliessen. Bilder kann man mit class="left" für linksbündige oder class="right" für rechtsbündige Bilder versehen. Für weitere, erlaubte Elemente, siehe Seiten bearbeiten.

Neue Seite erstellen

Siehe auch: Schritt-für-Schritt-Anleitung

Zuerst erstellt man eine neue XML-Datei in content/ nach folgendem Schemata:

<?xml version="1.0" encoding="UTF-8"?>

<page title="Warum wir leete Haxxorz sind" pagetitle="Warum?">
 <p>
   Wir sind einfach cool!
  </p>
</page>

Natürlich sind mehrere <p/>-Elemente möglich.

Diese Datei muss dann mit svn add dem Repository hinzugefügt werden, womit sie beim nächsten svn commit hochgeladen wird.

<page/>-Attribute

Attribut Beschreibung
title Allgemeiner Seitentitel
pagetitle Optionaler langer Seitentitel

Makefile bearbeiten

In der Makefile fügt man seinen Dateinamen ohne Pfad und Erweiterung an die Zeile mit CONTENT= an. Weiterhin kopiert man eine Regel für eine andere Seite für seine, zum Beispiel die für www/wiki.html.

Seite in Navigationsleiste aufnehmen

Dazu bearbeitet man content/navigation.xml. Dort erstellt man ein neues <file/>-Element mit dem Dateinamen der Seite ohne Pfad und Erweiterung. Als Linktitel wird das pagetitle-Attribut der entsprechenden Seite verwendet.

Seiten bearbeiten

  1. c3d2-web/content/wasichbearbeitenwill.xml öffnen
  2. Gewünschte Änderungen vornehmen
  3. make und im Browser testen
  4. svn commit


In <page/> dürfen folgende Elemente auftauchen:

<pre/>

Hier werden Inhalte wie eingegeben formatiert. Geeignet für Skripte, Konsolenausgaben, ...

<pre>% uname -sr
 FreeBSD 6.0-STABLE</pre>

Hinweis: Laut XHTML darf <pre/> nicht in <p/> vorkommen!

<p/>

<p>Ein Absatz. Mindestens einer wird empfohlen.</p>

<image/>

<image class="right" title="Linux-Unfug-Tag">http://www.linux-unfug-tag.de/logo.png</image>
Attribut Beschreibung
class Art der Darstellung, entweder left oder right
title Hinweis, wird in title und alt gesteckt

Bild hochladen

cp /home/hacker/bild.png www/images/bild_vom_hacker.png
svn add www/images/bild_vom_hacker.png
svn ci  # Braucht Account mit Schreibrechten

<link/>

<link>http://www.ccc.de/</link>
<link href="http://www.ccc.de/">CCC</link>
Attribut Beschreibung
href Linkziel, falls ausgelassen wird der Inhalt verwendet