Formatierungskonventionen

Hier sollen Empfehlungen für die Formatierung der Dokumente in diesem Bereich des Wikis festgehalten werden. Mögliche Formatierungen können in der DokuWiki-Dokumentation nachgeschlagen werden.

Code

Code-Beispiele sollten immer über die DokuWiki-Tags eingebunden werden:

<code php>
<?php // Code [...]
</code>

Analog für alle anderen Programmiersprachen. Soll kein Syntax-Highlighting aktiviert werden, kann als Sprache einfach 'text' übergeben werden.

Links

Links erhalten immer aussagekräftige Namen, 'hier' ist somit absolut inakzeptabel als Linkbeschreibung.

Meta-Informationen

Ist eine Seite nicht mehr auf dem aktuellen Stand oder noch unvollständig, so sollte diese Zeile am Ende des Dokuments eingefügt werden:

{{tag>code:veraltet}}

Zu bearbeitende Sektionen sollten mit dem Fixme-Smiley hervorgehoben werden.

Textformatierung

Mit Textformatierungen muss nicht gespart werden, aber es sollte eine gewisse Konsequenz herrschen (wer einmal Pfadnamen in bestimmter Weise hervorgehoben hat, sollte dies z.B. auch beibehalten), bestimmte Vorgaben gibt es dabei allerdings nicht. Variablen, Pfade, Strings aus Codebeispielen könnten hervorgehoben werden.

 
code/konventionen/formatierung.txt · Zuletzt geändert: 15.05.2009 04:22 (Externe Bearbeitung)
 
Recent changes RSS feed Valid XHTML 1.0 Valid CSS Driven by DokuWiki