Vorlage:Syn-H
Name
Der Name der Vorlage ist eine Abkürzung für Syntax-Heading.
Verwendungszweck
Feststellung
Sowohl die Eigenschaften, als auch die Methoden aller Objekte werden jeweils mit ihrem syntaktischen, englischen Namen bezeichnet.
Diese Namen sind jeweils eigentliche Syntax, also dann in ihrer praktischen Verwendung: Code.
Wie allgemein üblich, so wird auch im SELFHTML-Wiki jeder Code, sowohl in den Beispielen, als auch als einzelne Schnipsel in den Erklärungen, in nicht-proportionaler Schriftart (monospace) ausgegeben.
Diese gute und sinnvolle Praxis ausgerechnet in den Abteilungsüberschriften aufzugeben, stellt einen schwer wiegenden Formatierungsfehler dar. Die Vorlage behebt nun genau diesen Formatierungsmangel.
Den Namen der Eigenschaften und Methoden folgt, im Regelfall, eine in Klammer gesetzte kurze Erklärung auf deutsch.
Diese kurze Erklärung ist auch, insbesondere für Anfänger und für alle des Englischen nicht so mächtigen Benutzer sehr wichtig.
Für fortgeschrittene Benutzer wäre die deutsche Erklärung oft sogar entbehrlich, da sie die Bedeutung des Terms eigentlich kennen.
Die deutsche Erklärung ist standardmäßig, ab h3, ebenfalls fett formatiert und „klebt“ außerdem etwas nah am eher wichtigen Begriff.
Maßnahmen
In dieser Vorlage ist folgender Code eingeschlossen:
- Bei eigentlich gleicher Schriftgröße fallen Monospace-Schriftarten dennoch immer ein bisschen kleiner aus als proportionale Schriftarten. Zum Ausgleich hierzu wurde die Schriftgröße daher leicht angehoben.
- Die für viele Benutzer nicht so wichtige deutsche Erklärung wurde entfettet und verkleinert, außerdem, zur besseren Lesbarkeit der gesamten Überschrift, leicht vom wichtigen syntaktischen Namen abgesetzt.
Verwendung
Die Vorlage erwartet in aller Regel zwei Parameter:
Sollte die deutsche Erklärung manchmal ausnahmsweise sogar wegfallen,
so kann die Vorlage auch nur mit dem ersten Parameter verwendet werden.
Praktisches Beispiel zur Verwendung:
Visuelles Resultat
== onchange (bei erfolgter Änderung) == === onchange (bei erfolgter Änderung) === ==== onchange (bei erfolgter Änderung) ==== ===== onchange (bei erfolgter Änderung) ===== ====== onchange (bei erfolgter Änderung) ======
onchange (bei erfolgter Änderung)
onchange (bei erfolgter Änderung)
onchange (bei erfolgter Änderung)
onchange (bei erfolgter Änderung)
onchange (bei erfolgter Änderung)
== {{Syn-H|onchange|(bei erfolgter Änderung)}} ==
=== {{Syn-H|onchange|(bei erfolgter Änderung)}} ===
==== {{Syn-H|onchange|(bei erfolgter Änderung)}} ====
===== {{Syn-H|onchange|(bei erfolgter Änderung)}} =====
====== {{Syn-H|onchange|(bei erfolgter Änderung)}} ======
onchange (bei erfolgter Änderung)
onchange (bei erfolgter Änderung)
onchange (bei erfolgter Änderung)
onchange (bei erfolgter Änderung)
onchange (bei erfolgter Änderung)
Anmerkungen
- Auf den Seiten wo die Objekte erklärt werden, sind die Eigenschaften und Methoden regelmäßig die H2-Überschriften.
Die Verwendung der Vorlage:Syn-H in Heading2 kommt dem zufolge in der Praxis gar nicht vor.
- Die natürliche Verwendung der Vorlage Syntax-Heading ist deshalb ihre Verwendung in H3.
- Dazu einige weitere Beispiele:
onblur (beim Verlassen)
onclick (beim Anklicken)
onkeypress (bei gedrückt gehaltener Taste)
onmouseover (beim Überfahren des Elements mit der Maus)
javascript: (bei Verweisen)
- Auf Verwendung der Vorlage in H6-Überschriften sollte wohl ganz verzichtet werden. In der Praxis ist dies ja auch nicht nötig.
- Weder auf die Formatierung des Inhaltsverzeichnisses, noch auf die Verlinkungs-Syntax hat die Vorlage irgendeinen Einfluss.
