Aus Das deutschsprachige Scratch-Wiki
Beim Thema lesbarer Quelltext geht es natürlich nicht um Schönschrift, sondern mehr darum, den Seitenquelltext eines Artikels so anzuordnen, dass andere Autoren ihn einfacher lesen und verstehen können.
Als Beispiel für "unordentliche Quelltexte" kann man mal ganz frech den Quelltext von Google nennen. Öffne mal den Quelltext und sage, was du davon hältst, egal ob du weißt was er bedeutet (nicht jeder kann HTML). Hier blickt selbst ein Profi nicht so schnell durch, denn er enthält keine Absätze, Tabulatoren oder ähnliches.
Besonders in einem Wiki (nicht nur hier) ist es wichtig den Quelltext lesbar zu gestalten, denn die Artikel in Wikis sind zum ständigen Verbessern gedacht. Dabei wirkt sich keine der unten angegebenen Regeln bei der Ausführung auf das Ergebnis aus.
Absätze um die Überschrift
Grundsätzlich gibt es eine Regel, die du dir merken solltest:
"Über der Überschrift einer, unter ihr keiner."
Im Prinzip ganz einfach. Ein Beispiel:
Text Text Text
Text Text Text
== Überschrift ==
Text Text Text
Text Text Text
Überschrift
Eine klitzekleine Kleinigkeit noch zu den Überschriften: Bei einer Überschrift jeglicher Ebene wird zwischen dem Überschriftentext und dem/den Gleichheitszeichen ein Leerzeichen eingefügt.
Also:
- falsch:
==Überschrift== - richtig:
== Überschrift ==
Listen
Nicht zwingend nötig, aber auch schön wäre es, wenn du bei (un)geordneten Listen zwischen dem Zeichen für die Liste und dem Text ein Leerzeichen machen würdest.
Also:
* Text Text
# Text Text
statt:
*Text Text
#Text Text
Kommentare
Eine weitere Möglicheit zur Übersichtserhaltung ist der Kommentar. Ihn zu setzen ist aber nicht zwingend nötig.
Ein Kommentar sieht so aus:
<!--Ein kurzer Kommentar-->
<!--
Ein Kommentar, der aufgrund seiner Länge
über mehrere Zeilen verteilt wird.
-->
Kategorien und Magische Wörter
Alle Kategorienelemente kommen ganz nach unten.
Alle Magischen Wörter (außer bei Sachen wie __TOC__ oder __FORCETOC__, wo die Platzierung woanders natürlich sinnvoll ist) kommen ganz nach oben.
Elemente
Wichtig ist (wenn es nichts am wiedergegebenen Ergebnis ändert), dass du im Quelltext bitte zwischen den einzelnen Blöcken (also Fließtext, Listen, Tabellen, divs, Videos, Projekten, Bildern und so weiter) eine Leerzeile lässt.
[wiki=de:Scratch-Wiki:Hilfe:Lesbarer Quelltext]Hilfe:Lesbarer Quelltext[/wiki]
