C3D2-Web: Unterschied zwischen den Versionen

Aktuelle Version vom 22. Juni 2022, 20:08 Uhr

C3D2-Web
Die Homepage www.c3d2.de
Home:	https://www.c3d2.de/
Meta
Sprachen:	XSLT, Makefile, Bash
Plattformen:	Beliebig
Links
Source-Browser Dokumentation
Repository
git:	gitolite@git.c3d2.de:c3d2-web.git http://www.c3d2.de/c3d2-web.git/

Über C3D2-Web

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

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.

Sämtliche Seiten sind statisch. Wir sind also gegen SQL-Injection gefeit. Passwortabfragen können wir immernoch mit .htaccess lösen.

Fragen? Probleme?

Oder einfach keinen Bock auf spitze Klammern nur um einen Podcast zu publizieren? Schicks Astro, der hilft dir!

Zugang

..hat jede Person des Vertrauens mit einem Pubkey auf dem Webserver. Zugang gibt es auf Antrag an

_john
eri!
vv01f
oder Astro

Wie und Wo?

Repo clonen/pullen
Änderungen lokal vornehmen
lokal Testen mit make
Änderungen committen/adden und pushen

Quickstart

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

Aktualisieren der Webseite

Das Neubauen der Webseite wird einerseits über einen Githook angestoßen und andererseits mit Hilfe stündlich über einen Systemd Timer (/etc/systemd/system/wwwbuild.(timer|service)), 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!

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.

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

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 &nbsp;
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.

Damit das ganze unter dem super coolen Non-Nerd-Os Mac OS X funktioniert, muss bei der Installation von libxslt die Datei /opt/local/var/macports/sources/rsync.macports.org/release/ports/textproc/libxslt/Portfile abgeändert werden, dass da anstelle --without-crypto --with-crypto steht, sonst klappt das nicht, und man muss Astro bemühen die Arbeit zu erledigen...

Kalendereintrag anlegen

git clone
geany content/events.xml
Lokal testen:
1. make
2. firefox www/calendar.html
git add content/events.xml
git commit -m "events: …"
git push
firefox https://c3d2.de/calendar.html

News schreiben

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

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

TODO: iTunes-Extensions

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

c3d2-web/content/wasichbearbeitenwill.xml öffnen
Gewünschte Änderungen vornehmen
```
make
```
und im Browser testen
```
git add geänderte Datei
```
```
git commit -m "Änderungsnachricht"
```
```
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  # 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

Microformats

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
c3d2-web git: content/static/datenspuren in eigenes Submodul stecken
- hier liegen viele Binärdateien in den Fahrplänen
- blähen History + Verzeichnisse auf (142MB für content/static/datenspuren)
- fahrplan wird meistens nur von einer Person/einem Skript gepflegt, news bauen auch so
- bei bedarf auschecken möglich
- es muss das Makefile angepasst werden: mit/ohne submodul bauen
  - erster schritt: datenspuren auskommentiert in git branch no-ds
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?