Seitennamen im Wiki

Foruminternes: Ankündigungen, Bekanntmachungen, Spielregeln
Antworten
Benutzeravatar
Xin
nur zu Besuch hier
Beiträge: 8859
Registriert: Fr Jul 04, 2008 11:10 pm
Wohnort: /home/xin
Kontaktdaten:

Seitennamen im Wiki

Beitrag von Xin » Mi Jan 11, 2012 11:06 am

Aus aktuellem Anlass möchte ich gerne auf die Wiki-Seite

http://www.proggen.org/doku.php?id=pagenames

hinweisen. In mehreren Tutorials gibt es derzeit einige "Standards", so dass man sich viele Seitennamen vergleichsweise einfach herleiten kann.

Darunter fällt zum einen, kurze und eindeutige englische Begriffe zu verwenden. Benutzt Namensräume und verschachtelt sie. Bitte keine kryptischen Abkürzungen ("zeichfu"). Um eine Sammlung von Funktionen zu beschreiben hat sich ein Unternamensraum "lib" in verschiedenen Tutorials ergeben. tutorial:lib:funktionsname. In dem Fall werden viele Funktionen zusammengefasst - kein Problem, ich dachte bei "zeichfu" an Zeichen-Funktionen - von Zeichnen, wie Malen. Es sind aber Zeichenketten: wie wäre es mit tutorial:lib:string?

Bitte verwendet die Namen im Wiki nicht als Verzeichnis: "01_firststep" heißt einfach firststep. Vielleicht kommt irgendwann eine Seite "00_why" und eine Seite "-1_history" und schließlich eine Seite "00b_why2". Gebt den Seiten einen eindeutigen Namen.

Bitte verwendet im Seitennamen keine Leerzeichen und möglichst keine Unterstriche.

Achtet darauf, dass die Seiten in eurem Namensraum stehen.

Bei Fragen, wie man eine Seite nennen soll ist es absolut legitim, im Forum - z.B. als Antwort auf diesen Post - nachzufragen.

Wer derzeit an Tutorials schreibt, muss jetzt nicht alles über den Haufen werfen. Aber gerade der C-Namensraum hat größere Umbauten aufgrund der Namensgebung diverser Seiten hinter sich. Aus diesem Umbau haben sich die obenstehenden Lehren gezogen.
Merke: Wer Ordnung hellt ist nicht zwangsläufig eine Leuchte.

Ich beantworte keine generellen Programmierfragen per PN oder Mail. Dafür ist das Forum da.

Antworten