C3D2-Web

Aus C3D2
Zur Navigation springen Zur Suche springen
   
C3D2-Web

status: stable

Beschreibung
Gitea  c3d2/c3d2-web
Hostname  c3d2.de

Über C3D2-Web

C3D2-Web ist der Source Code für die statische Website unter https://www.c3d2.de/ . Alle Member der C3D2 Gitea Orga können in das Repo pushen. Bei fehlenden Berechtigungen wendet man sich bitte an die Owner des Teams.

Wir haben uns bewusst gegen ein CMS wie Wordpress entschieden, da statische Websites unschlagbar in Speed, Sicherheit und Wartungsarmut sind.

Leider wird XSLT aktuell nur von sehr wenigen Personen verstanden und es führt oft zu Diskussionen und soll schon länger ersetzt werden. Dazu gibt es dieses nekische Meme.

XML Sit-Ups sind gar nicht schwer
XML Sit-Ups sind gar nicht schwer

Tor

Das c3d2-web ist per Tor Hidden Service erreichbar.[1]

Wie und Wo?

  1. Repo clonen/pullen
  2. Änderungen lokal vornehmen
  3. lokal Testen mit make
  4. Änderungen committen/adden und pushen


Quickstart

git clone gitea@gitea.c3d2.de:c3d2/c3d2-web.git
cd c3d2-web
make
xdg-open www/news.html

Aktualisieren der Webseite

Das Neubauen der Webseite wird über Drone angestoßen und alle drei Stunden über einen Cron neugebaut, um neue Daten von externen Quellen und vorbereitete News zu aktualisieren.

Bearbeiten

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

Es schadet nicht, mal einen Blick in die Best Practises zu werfen.

Grundlegendes zum Umgang

Verzeichnis Bedeutung
build temporäres Verzeichnis, in dem alle erstellten html-Dateien landen
content/datenspuren Datenspuren-Seiten.
content/pages XML-Dateien mit einzelnen Seiten (Wiki, SILC, Mailingliste etc.)
content/static Statische Inhalte (Bilder, Styles etc.), mit Struktur, wie sie später unter www/ landen sollen. (Datenspuren-Sachen sind auch hier!)
dtd Dokumenttypdefinitionen aufgrund derer einen xmllint anmeckern wird, wenn man Tags falsch benutzt.
scripts Hilfsskripte zum Bauen
xslfo XSL:FO-Geraffel für den imaginären DS-Guide, für welchen kein Inhalt zustande kam
www Das ist nach dem Bauen das fertige Verzeichnis, in dem die Site liegt, wie sie ins htdocs exportiert werden kann.
xsl Hier residieren die Definitionen, aus dem XML-Inhalt XHTML-Webseiten und RSS-Feeds zu bauen.

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 xmllint (bzw. xsltproc) schon erklärende Fehlermeldungen.

Sonderzeichen

Neben UTF-8 können (und müssen teils) Sonderzeichen als XML Entity notiert werden

  • Für & schreibe &, auch im href-Attribut von Links!
  • Optionaler Bindestrich: ­
  • Schmales Leerzeichen:  
  • Festes Leerzeichen:   oder  
  • Deutsche Anführungszeichen: „Text in Anführungszeichen“
  • Englische Quotes: "quoted text"
  • Französische Guillemets: »Qui n’avance pas, recule« (Pfeilspitzen zeigen… Schweizer Verwendung: links, rechts, Deutsche Verwendung: rechts, links)

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 build/ die html- und rss-Dateien gebaut. Wenn alles fertig ist kopiert rsync alles zusammen mit dem Inhalt von content/static nach www/, das ist ganz nützlich um zu sehen, welche Dateien sich tatsächlich verändert haben.

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.

Kalendereintrag anlegen

  1. git clone
  2. Editiere content/events.xml mit deinem Editor. Neue Events gehören ans Ende!
  3. Lokal testen:
    1. make
    2. xdg-open www/calendar.html
  4. git add -p content/events.xml
  5. git commit -m "Add ..."
  6. git push
  7. wait a minute
  8. xdg-open https://c3d2.de/calendar.html

News schreiben

  1. Irgendeine vorhandene News-Seite in c3d2-web/content/news auf c3d2-web/content/news/<dateiname>.xml kopieren.
  2. Der Dateiname sollte mit .xml enden
  3. Dateinamen die mit ta- bzw. event- beginnen werden in Themenabende bzw. Events einsortiert
  4. Inhalt eingeben und Attribute für <item/> setzen.
  5. make und im Browser anschauen
  6. git commit -p

Das sieht dann z.B. so aus:

 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE item SYSTEM "http://www.c3d2.de/dtd/c3d2web.dtd">
 <item title="TA: Ruby &amp; Ruby on Rails" date="2006-03-19T19:00:00" author="Astro">
   <image title="Ruby">http://www.rubygarden.com/ruby.jpg</image>
   <p>
     <dl>
       <dt>Termin</dt>
       <dd>10. März 2006, 19:00 Uhr</dd>
       <dt>Ort</dt>
       <dd>Berufsakademie Dresden, Raum G3, Heideparkstr. 8, 01099 Dresden</dd>
       <dt>Themen</dt>
       <dd>Einführung in Ruby</dd>
       <dd>Ruby-MediaWiki</dd>
       <dd>Einführung in Ruby on Rails</dd>
       <dd>Erstellen eines Wiki mit Rails</dd>
       <dd>Jabber-Library XMPP4R</dd>
     </dl>
   </p>
   <resource title="Vortragsfolien" size="234223" type="application/pdf">http://example.com/slides.pdf</resource>
 </item>

<item/>-Attribute

Attribut Beschreibung
title News-Titel
date News-Datum in standardisierter Form, z.B. für RSS-Feeds und automatisierte Verarbeitung. (Ausgabe von date +%FT%T.)
Daten in der Zukunft werden nicht im Newslisting geführt, sind also pre-published.
author Wer hat's geschrieben?

Inhalt

Muss in ein <p/> einschlossen werden. Vorher darf noch ein einzelnes <image/> stehen, dieses wird dann automatisch linksbündig oder rechtsbündig angeordnet (aktuell deaktiviert). Für weitere, erlaubte Elemente, siehe Seiten bearbeiten.

Erweiterter Inhalt

Seit r324 wird für jede News noch eine Extraseite angelegt. Für Text, der dort erscheinen, aber nicht in der Übersicht stehen soll, darf in <item/> noch zusätzlich ein <addendum/> geschrieben werden. Dort kann alles rein, was auch in eine normale Seite kann.

<resource/>

Damit Downloads als enclosures in RSS und ATOM auftauchen (ein Podcast!11), gibt man sie als <resource/> an. Nebenbei erscheinen sie auch im HTML, schliesslich sollen alle Daten verwurstet werden.

Attribut "url" URL zum Download
Attribut "title" Ein Kurztitel nur fürs HTML, Fallback auf Inhalt
Attribut "size" Contentgröße in Bytes
Attribut "type" MIME-Type
Attribute "hide" Wenn "yes", so wird diese Ressource nicht auf der Nachrichtenübersichtsseite angezeigt. Das ist sinnvoll, wenn es eine Menge Dateien (wie bei DS-Mitschnitten) gibt, die man als Podcast anbieten möchte, jedoch in ihrem vollen Umfang auf der Übersichtsseite stören würden.
Child "alternative" Alternative Dateien (z.B. statt Ogg in MP3), besitzt auch url, size und type

Neue Seite erstellen

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

Zuerst erstellt man eine neue XML-Datei in content/pages nach folgendem Schema (oder man kopiert eine bereits vorhandene):

<page title="Kontakt" pagetitle="E-Mail">
 <p>
  Anfragen an den Chaostreff Dresden bitte an <link href="mailto:mail@c3d2.de">mail@c3d2.de</link>.
 </p>
 <p>
  Diese Adresse geht moderiert an unsere Mailingliste, d. h. an alle dort eingetragenen E-Mailadressen.
 </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

Seite in Navigationsleiste aufnehmen

Dazu bearbeitet man content/navigation.xml. Dort erstellt man ein neues <file/>-Element mit dem Pfad zur Datei unter content aber ohne Erweiterung, z.B. <file>content/kontakt</file>. Als Linktitel wird automatisch 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. git add geänderte Datei
  5. git commit -m "Änderungsnachricht"
  6. git push

In <page/> dürfen die Elemente folgender Abschnitte auftauchen.

<pre/>

Mit <pre/> werden Inhalte so formatiert, wie sie einzugeben sind. Dies ist 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 title="Linux-Unfug-Tag">http://www.linux-unfug-tag.de/logo.png</image>
Attribut Beschreibung
title Hinweis, wird in title und alt gesteckt
Bild hochladen
cp /home/hacker/bild.png content/static/images/bild_vom_hacker.png
git add www/images/bild_vom_hacker.png
git commit -m "Bild vom Hacker hinzugefügt"
git push

<link/>

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

Microformats

Firefox Tails extension, im News-Archiv befinden sich nur Summary und URL
Firefox Tails extension, im News-Archiv befinden sich nur Summary und URL

News zu bestimmten Anlässen kann man mit <event/> versehen. Durch bestimmte standardisierte CSS-Klassen können die Daten dann auch im XHTML gefunden werden.

c3d2-News als iCal per X2V

TODO

  • Kalender auch aus Radionews füttern lassen um das ein paar Schritte jeden Monat zu verkürzen
  • Geokoordinaten zu Events, für bessere Online-Map-Verlinkung
  • images/news/-Pfadlogik entfernen
  • Optimize build process for speed

Neue Startseite

  • Selbstbeschreibung
    • Von whois.xml kopieren?
  • Letzte Podcasts
  • Projekte
    • Von projekte.xml kopieren?
  • Mehrsprachigkeit (Texte übersetzen!)
  • Suche?

Historisches