Hilfe:Vorlagen

Wozu braucht Kamel Vorlagen?
Um einen gewissen Look and Feel der Kamelo zu gewährleisten, werden einzelne Artikelteile standardisiert. Damit sie auch immer gleich aussehen und um es dem Kamel zu vereinfachen, gibt es Vorlagen. Ein beliebte Vorlage ist Beispielsweise Vorlage:Begriffsklärung

Wie fügt Kamel eine Vorlage ein?
SV undefined Unser Sortiment unter Kamelopedia:Vorlagen

Hast du eine passende Vorlage gefunden, kannst du sie in deinem Artikel (oder auch sonstwo) verwenden und zwar so:


 * Vorlagen werden mit   eingesetzt.
 * Vorlagen können auch Parameter haben, also Informationen, die man der Vorlage übergibt, um sie weiter anzupassen. Vorlagen mit Parametern werden so verwendet:  . Welche Parameter welche Bedeutung haben, sollte aus der Doku zu jeder Vorlage ersichtlich sein, wenn nicht, erschlage das Kamel, dass sie gebaut hat.
 * Wo auf einer Seite die Vorlage eingesetzt werden sollte, ist a) unterschiedlich (einige Tipps stehen bei den einzelnen Vorlagen) und b) umstritten bzw. Geschmackssache. Vorschau benutzen!
 * Ob überhaupt eine Vorlage eingesetzt werden sollte, ist eine wichtige und berechtigte Frage!

Wie baut Kamel eine Vorlage?
Zuerst sollte Kamel sich Gedanken darüber machen, ob dies auch Sinn macht. Unbedingt zu vermeiden ist eine Vorlagenflut!

Folgende Überlegungen sollte Kamel sich vorher (also vor dem Speichern) machen:
 * Ist es möglich eine bestehende Vorlage zu erweitern?
 * Rechtfertigt die zu erwartende Nutzung eine neue Vorlage?

Eine Vorlage wird ähnlich wie eine Artikel gemacht, zB. Vorlage:Mein Kunstwerk würde eine Vorlage ergeben, die später mit   in eine andere Seite eingefügt werden würde (korrekt "Vorlage:" kann man sich beim Einbinden sparen).

Spezielle Notationen in Vorlagen

 *  xxxxxx  Diese Konfiguration bedeutet, dass xxxxxx nicht an die einbindende Seite weitergereicht wird (xxxxxx kann durchaus mit etwas Intelligenterem ersetzt werden.). Werden Vorlagen in andere Seiten eingebunden, wird grundsätzlich alles, was die Vorlage beinhaltet, weitervererbt. Dies ist unter Umständen nicht wünschenswert, da Kommentare und Kategorien, die dem Vorlagenbau dienen nicht weitergereicht werden sollen.


 *  xxxxxx  Diese Konfiguration bedeutet, dass xxxxxx in der Vorlage nicht ausgewertet wird und auch nicht angezeigt wird. Dies kann dienlich sein, um zB. der einbindenden Seite eine Kategorie zu geben, ohne dass die Vorlage selbst in diese Kategorie fällt. Ansonsten dient es der Kosmetik, zB. dem verstecken von Dingen die erst beim Einbinden funktionieren und sonst bei der Betrachtung der Vorlage hässliche Fehler und Falschdarstellungen verursachen.


 *  xxxxxx  Diese Konfiguration ist eine Kombination der anderen 2 und übergibt nur das xxxxxxx. Es kann mehrmals unverschachtelt in der selben Vorlage benutzt werden.

Parameter
Um die Vorlagen flexibel zu machen, hat man den Kamelen Parameter gegeben.

Parameter: Zusammenhang zwischen Artikel und Vorlage:
Im Artikel werden die Parameter innerhalb der geschweiften Klammern der Vorlageneinbindung ( ) übergeben und sind jeweils mit einem "|" getrennt (hier am Beispiel eines Artikels der eine Vorlage namens Textfarbe (also Vorlage:Textfarbe) einbindet):
 *  

In der Vorlage Text-Farbe stehen dann die übergebenen Werte am Ort ihrer Platzhalter zur Verfügung:
 *   würde dann beim Aufruf mit "green" und  mit "Ich bin grün" ersetzt werden.

Wir gehen mal davon aus, dass Folgendes in der Vorlage Textfarbe steht:
 *   

Im Artikel würde man es vielleicht so einsetzen:
 * Die politische Gesinnung kann auch durch die Farbe ausgedrückt werden: 

Was dann als Ergebnis im Artikel etwa so aussehen würde:
 * Die politische Gesinnung kann auch durch die Farbe ausgedrückt werden: 
 * …oder so ähnlich :-)

Parameter: Varianten
Theoretisch bestehen alle übergebenen Parameter aus einem Namen, einem "=" und einem Wert, der Einfachheit halber wurde angenommen, dass unbenannte Parameter Nummern als Namen haben. Also würde es eigentlich so heissen:


 *  </tt>

Der dritte Parameter würde dann "3=" heissen der Vierte "4=" usw.

Sollen mehrere Parameter übergeben werden, ist es oft sinnvoll "sprechende" Namen zu wählen wie zB. "Text=", "Farbe=", "Breite=" usw. (Bsp: Vorlage:Systematik Film) damit Kamel auch gleich weiss, was es zu bedeuten hat. Im Beispiel der Vorlage Text-Farbe würde das dann so aussehen:


 *  </tt>

Und in der Vorlage selbst stünden dann die Parameter unter den entsprechenden Namen bereit:
 *  </tt> hätte dann den Inhalt "green</tt>" und der Parameter   </tt> hätte dann "Ich bin grün</tt>" drin

Und so müsste dann der tatsächliche Inhalt der Vorlage Text-Farbe aussehen:
 *  <span style="color:"> </tt>

Parameter: Verhalten

 * Parameter die nicht benutzt werden, werden im Artikel nicht dargestellt und werden als leer ausgegeben. Allerdings werden sie innerhalb der Vorlagenverarbeitung nicht einfach als leer angenommen, sondern die Verarbeitung wird an Huf des Strings "" ausgeführt: Die Operation wird, wenn der Parameter 1 nicht angegeben wird, eine "{" ausgeben.


 * Für die Parameter kann in der Vorlage jeweils ein Defaultwert (dt.: Vorgabewert) eingesetzt werden:
 * Nehmen wir mal an, wir erweitern in der Vorlage Textfarbe den Parameter 1 zu . Wird nun  Aufgerufen ergibt sich:
 * „Leer“ und „nicht verwendet“ ist nicht identisch! Damit das Defaultwert-Dingens tut, muss der Parameter beim Aufruf komplett weggelassen werden, oder in der Vorlage anders abgefangen werden (sowas wie: )
 * Der Nutzen von liegt darin, dass ein Defaultwert von "" (nichts) angenommen wird und in der Vorlagenverarbeitung auch diesen Wert annimmt.


 * Werte die ein "=" enthalten, müssen mit benanntem Parameter übergeben werden, also nicht
 * sondern


 * Dies, weil sonst Wiki denkt, dass man einen Parameter mit dem Namen " http://www.google.com/search?hl " mit dem Wert "de" übergeben möchte...


 * Weitere Problemzeichen:
 * Werden folgende Zeichen in Parameterwerten benötigt, müssen sie vor Wiki "versteckt" werden:



!Zeichen !Ersatz !Ersatz, wenn es für Tabellen benötigt wird
 * &#124;||&amp;#124;|| |
 * &#123;&#124;|| &amp;#123;&amp;#124; || {|
 * &#124;&#125;|| &amp;#124;&amp;#125; || |}
 * }
 * &#124;&#125;|| &amp;#124;&amp;#125; || |}
 * }
 * }

Kategorie
Vorlagen sind ALLE ohne Ausnahme in einer Kategorie einzufügen!!!! Solltest du anderer Meinung sein, dann lass die Hufe von Vorlagen!

Kategorie:Vorlagen

Dokumentation
Da Wiki etwas doof ist und den gesamten Inhalt einer Vorlage beim Parsen zuerst mal lädt und erst nachdem das Memory versaut ist die s wegwirft (was aber nix nützt), ist es wichtig darauf zu achten, dass der Text im so sparsam wie möglich ist oder aber ausgelagert wird.

Dokumentation Auslagern
Die Doku sollte spätestens dann ausgelagert werden, wenn die Vorlage innerhalb der gleichen Seite mehrmals geladen werden soll, das spart Systemmemory und man kann viiiiel mehr Vorlagen in eine Seite quetschen.

[ Diese Doku bearbeiten]
 * Die Doku wird unter <Seitenname>/Doku abgespeichert. (Bsp: Vorlage:Mein Kunstwerk/Doku)
 * In die Vorlage wird die Doku mit eingefügt.
 * In der Doku sollte Folgendes (ganz zuunterst) enthalten sein:

Das gibt dem Kamel, dass die Vorlage anguckt einen direkten Link zur Doku, um sie anzupassen.

Und nicht vergessen:

Kategorie:Vorlagen Dokumentation

Verwaltung
Damit Vorlagen auch anderen Kamelen zugänglich gemacht werden können, sollten diese an 2 Orten eingetragen werden:


 * Kamelopedia:Vorlagen
 * Hilfe:Edittools.js (Dort sind die Klick-Vorlagen rechts vom Editfeld beim "Bearbeiten", Cache leeren nicht vergessen)

Beides ist leider nicht grade selbsterklärend...

Zu beachten

 * Es ist eine Unsitte HTML-Tags offen zu lassen (also zB. ohne  am Schluss). Dies kann bei Vorlagen zu völlig unerwarteten Effekten bei der Einbindung führen.

Weiterführende Literatur

 * wiki:Hilfe:Vorlagen
 * wiki:Hilfe:Vorlagenprogrammierung