Template

Diese Seite soll beschreiben, wie ein Seite im Proggen-Wiki aussehen sollte. Bisher machen viele ihren eignen Stil, was allerdings einem einheitlichen Design entgegen läuft.

Als erstes sollte ganz oben der Titel der Seite in der Hauptüberschrift stehen. Diese wird mit 6 Gleichheitszeichen erzeugt:

====== Seitentitel =======

Anschließend sollte eine kurze Einleitung folgen, worum es auf dieser Seite geht, was der Seitentitel zu bedeuten hat, gefolgt von den Unterkapiteln der Seite (Überschriften mit 5 =).

Name der Seite und Namensräume

Der Seitenname sollte in Englisch und möglichst kurz gewählt werden. Also bitte keine Artikel oder ganze Sätze. Nach Möglichkeit nehmt das Schlagwort, das auf dieser Seite verwendet wird. Wenn ihr einen ausführlicheren Artikel schreibt, der in sich allerdings abgeschlossen ist, so besteht die Möglichkeit, einen eigenen Namensraum zu wählen. Zum Beispiel für den Präprozessor C:Pre:. In dem Fall heißt die Übersichtsseite Start. Wer sich also auf den Präprozessor allgemein beziehen möchte, verlinkt nach C:Pre:Start, wer sich auf den Include-Befehl beziehen möchte, wählt C:Pre:Include

Schreibstil

Wir haben uns auf Du/ihr geeinigt. Achtet dennoch bitte darauf, dass ihr keinen flapsigen Schreibstil an den Tag legt und vermeidet Füllwörter und Füllsätze. Es ist nicht schlimm, wenn welche dazwischen sind, aber wenn ihr die Artikel korrekturlest, werft sie möglichst wieder raus.

Nachdem wir das gemacht haben, schauen wir uns nun etwas anderes an.

Schreibt locker, aber bemüht euch um einen Stil, den ihr in einem seriösen Buch vorzufinden erwartet.

Fussnoten

Bisher selten gesehen, aber vom Wiki unterstützt, sind Fussnoten. Kleine Hinweise sollten den Lesefluss nicht stören und können durch doppeltes Klammern 1) hinzugefügt werden:

(( %%((Fussnote))%% ))

Tabellen

Informationen, die tabellarisch dargestellt werden können, sollten auch in Tabellen verpackt werden. Das hilft, das Tutorial auch als Referenz besser zu verwenden. Wie ihr Tabellen darstellen könnt, findet sich in der Syntax-Dokumentation des Wikis.

Quelltexte

Quelltexte bitte mit <code cpp> und </code> einklammern. Die PHP-Jungs benutzen bitte stattdessen <code php>.

Skizzen

Versucht Artikel mit schematischen Darstellungen zu ergänzen (z.B. bei Bäumen). Ich benutze dafür InkScape. Wenn ihr Schwierigkeiten mit Grafiken habt, beschreibt Sie auf ToDo und bittet darum, dass Sie jemand für euch macht. Gerade am Anfang bitte ich darum, derartiges mit mir abzusprechen, damit wir ein Layout für die Grafiken haben. Wenn ihr eure Grafiken selbst macht, speichert die Grafiken bitte im JPG-Format, damit jeder Browser sie anzeigen kann. Die SVG Dateien bitte ich dann auf den Webserver hochzuladen und auf einer Media-Seite (namespace:media) zu verlinken.

Screenshots

Screenshots sind gerne gesehen, aber bitte macht keine Screenshots von einem kompletten Desktop. Der Betrachter hat ebenfalls nur einen Desktop, darauf läuft der Browser und in dessem Fenster wird eine Grafik angezeigt ist, die vielleicht sogar größer ist als der Desktop, die sie anzeigt. Kurz: man sieht nichts. Bitte bildet nur die Teile des Desktops ab, die an diesem Punkt wichtig sind. Wenn ein ganzer Desktop für die Übersicht erforderlich ist, so verkleinert die Grafik. Hierfür kann z.B. Gimp verwendet werden.

Screenshots speichert bitte im JPG-Format bei akzeptabler Qualität, aber bitte achtet darauf, dass eine Seite nicht zu viele Grafiken enthält. Auch Grafiken, die nur minimale Unterschiede haben, sollten vermieden werden. Grafiken verbrauchen in jeder Version Speicher auf dem Wiki-Server, verbrauchen Traffic und nerven Leute, die nur DSL Light in ihrem Ort bekommen.

Links zum Diskussionsthread

Jede Seite sollte einen Diskussionsthread beinhalten, abgetrennt durch eine horizontale Linie.

----
[[https://www.proggen.org/forum/viewtopic.php?f=39&t=231|Autorendiskussion]]

Organisatorisches / ToDo

…tragt bitte auf ToDo ein.

Modifikationen an dieser Seite

…können nur von mir vorgenommen werden. Die Regeln stehen selbstverständlich im Forum zur Diskussion. Diese Seite wird von mir bei Bedarf verändert, es empfielt sich also immer mal wieder reinzugucken.


Diskussion

1) ((Fussnote))