DjangoDocSyntax

Das Dokumentationsformat

Damit alle Dokumentationsseiten am Ende eines Übersetzungsprozesses gleich aussehen, werden die Dokumentationen in einem reinen Text-Format erfasst und von dort in ein einheitliches Layout überführt.

Das Layout

Um sicherzustellen, dass die Formatierung deiner Textdatei stimmt und es später zu keinen unerwünschten Nebeneffekten kommt existiert eine einfache Möglichkeit, die Syntax deiner Datei zu überprüfen:

rst2html datei.txt datei.html

rst2html ist ein Front-End Tool aus dem Python Modul docutils und muß dafür installiert sein. Sollten dabei Fehler angezeigt werden, füge die Fehlermeldung dem Ticket hinzu oder kontaktiere uns im IRC-Raum #django-de.