Hilfe:Vorlagen: Unterschied zwischen den Versionen
K (→Dokumentation Auslagern: den gesamten Quelltext (der im zwischen dem <pre> stand in Vorlage gepackt; bisschen umgeschrieben) |
|||
Zeile 89: | Zeile 89: | ||
*Die Doku wird unter <nowiki>[[<Seitenname>/Doku]]</nowiki> abgespeichert. (Bsp: [[Vorlage:Mein Kunstwerk/Doku]]) | *Die Doku wird unter <nowiki>[[<Seitenname>/Doku]]</nowiki> abgespeichert. (Bsp: [[Vorlage:Mein Kunstwerk/Doku]]) | ||
*In die Vorlage wird die Doku mit <nowiki><noinclude>{{<Seitenname>/Doku}}<noinclude></nowiki> eingefügt. | *In die Vorlage wird die Doku mit <nowiki><noinclude>{{<Seitenname>/Doku}}<noinclude></nowiki> eingefügt. | ||
− | *In der Doku sollte | + | *In der Doku sollte folgende Vorlage (ganz zuunterst) sein: |
<pre> | <pre> | ||
− | + | {{Doku bearbeiten}} | |
</pre> | </pre> | ||
Version vom 18. Juni 2010, 21:03 Uhr
↓ Überblick
|
↓ Bearbeiten
|
↓ Artikel
|
↓ Multimedia
|
↓ Features
|
↓ Pseudo und Anti
|
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?
Siehe vielleicht: 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 {{Name der Vorlage}} eingesetzt.
- Vorlagen können auch Parameter haben, also Informationen, die man der Vorlage übergibt, um sie weiter anzupassen. Vorlagen mit Parametern werden so verwendet: {{Name der Vorlage|erster Parameter|zweiter Parameter|und|so|weiter}}. 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. Goldener Kameltipp: 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 man sich vorher 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 {{Mein Kunstwerk}} in eine andere Seite eingefügt werden würde (korrekt "Vorlage:" kann man sich beim Einbinden sparen).
Spezielle Notationen in Vorlagen
- <noinclude>xxxxxx</noinclude> 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.
- <includeonly>xxxxxx</includeonly> 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.
- <onlyinclude>xxxxxx</onlyinclude> 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 und die benutzt man so:
- {{{1}}}
- {{{link}}}
- {{{1|xxxxx}}} für jeden Parameter kann auch ein Default gesetzt werden
- usw.
Des weiteren können Parameter nach Belieben mehrfach in der selben Vorlage verwendet werden und auch für Funktionen wie Berechnungen und logische Entscheidungen herangezogen werden.
Bemerkung: Werte die ein "=" enthalten, müssen mit benanntem Parameter übergeben werden, also nicht
- {{gg|http://www.google.com/search?hl=de}} sondern
- {{gg|1=http://www.google.com/search?hl=de}}
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...
Kategorie
Vorlagen sind ALLE ohne Ausnahme in einer Kategorie einzufügen!!!! Solltest du anderer Meinung sein, dann lass die Hufe von Vorlagen!
Siehe auch: Kategorie:Vorlage
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 <noinclude>s wegwirft (was aber nix nützt), ist es wichtig darauf zu achten, dass der Text im <noinclude> 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.
- Die Doku wird unter [[<Seitenname>/Doku]] abgespeichert. (Bsp: Vorlage:Mein Kunstwerk/Doku)
- In die Vorlage wird die Doku mit <noinclude>{{<Seitenname>/Doku}}<noinclude> eingefügt.
- In der Doku sollte folgende Vorlage (ganz zuunterst) sein:
{{Doku bearbeiten}}
Das gibt dem Kamel, dass die Vorlage anguckt einen direkten Link zur Doku, um sie anzupassen.
Und nicht vergessen:
<noinclude>[[Kategorie:Vorlagen Dokumentation]]</noinclude>
Siehe auch: 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. <div> ohne </div> am Schluss). Dies kann bei Vorlagen zu völlig unerwarteten Effekten bei der Einbindung führen.