Vorlagen: Unterschied zwischen den Versionen

Aus Chemie digital
Wechseln zu: Navigation, Suche
(Wie setzt man sie ein?)
Zeile 15: Zeile 15:
 
== Wie setzt man sie ein? ==
 
== Wie setzt man sie ein? ==
  
Im einfachsten Fall fügst du eine Vorlage mit <code><nowiki>{{Vorlagennamen}}</nowiki></code> ein. Beim Anzeigen der Seite ersetzt die MediaWiki-Software dies dann durch den Inhalt der Vorlage „Vorlagennamen“. Ändert jemand die Vorlage, ändert sich dadurch auch die Darstellung.
+
Im einfachsten Fall fügst du eine Vorlage mit <code><nowiki>{{Vorlagenname}}</nowiki></code> ein. Beim Anzeigen der Seite ersetzt die MediaWiki-Software dies dann durch den Inhalt der Vorlage ''„Vorlagenname“''. Ändert jemand die Vorlage, ändert sich dadurch auch die Darstellung.
  
  
 +
{|
 +
|-
 +
|[[File:Transclusion simple.svg|300px]]|| Das Bild verdeutlicht, wie es funktioniert. Die Seite B ist eine Vorlage, was man im Wiki normalerweise daran erkennt, dass der Seitenname die Bezeichnung des Namensraumes "Vorlage:" vorangestellt hat. Bei der Benutzung des Codes <code><nowiki>{{B}}</nowiki></code> (erkennbar im unteren Bereich) wird auf der Seite A der Inhalt von B eingefügt, ohne dass man erkennt, dass es von einer anderen Seite kommt. Übrigens wird sich auch Formatierungen wie Seitenumbrüche in B auf die Seite A aus. Das muss dann in B korrigiert werden, wenn
 +
|}
  
  
Eine Vorlage wird mittels doppelter geschweifter Klammern in der Form {{Vorlagenname}} eingebunden.
+
=== Parameter einfügen und verwenden ===
  
<nowiki>{{Vorlagenname|Option1|Option2|...}}</nowiki>
+
Oft sollen in einer Vorlage Inhalte auftauchen, die sich jedoch von Seite zu Seite ändern, zum Beispiel die Nummerierung einer Aufgabe, die Beschriftung eines Bildes oder die Aufgabenstellungen. Das erreicht man mit '''Parametern'''.
  
An erster Stelle in den geschweiften Klammern steht immer der '''Vorlagenname'''. Dann kann Benutzerdefinierter Text an die Vorlage übergeben werden, der vom Vorlagennamen mit einem senkrechten Strich "|" getrennt ist. Je nach Vorlage muss kein oder es müssen auch mehrere "Texte" eingegeben werden.
+
Auf der Vorlagen-Seite selber kennzeichnet man durch drei geschweifte Klammern <nowiki>{{{1}}}</nowiki> Stellen als Platzhalter; diese werden meist durchnummeriert. Alternativ kann man auch Namen dafür verwenden, was auf dem Chemie-digital-Wiki aber bisher nicht gemacht wird.
 +
 
 +
Ein Platzhalter kann auch als einfacher Text ausgegeben werden oder auch beliebig anders eingesetzt werden. Etwa als interner Link, wenn er seinerseits in der Vorlage mit zwei eckigen Klammern umgeben ist, wie zum Beispiel in <nowiki>[[{{{1}}}]]</nowiki>, beliebig formatiert oder kombiniert mit anderen Ausgaben um etwa einen externen Link anzusteuern.
 +
 
 +
Eine Vorlage mit Parametern verwendet man, indem man nach dem Namen der Vorlage, getrennt mit jeweils einem senkrechten Strich die gewünschten Werte der Parameter angibt.
 +
 
 +
'''Beispiel:'''
 +
 
 +
Wenn man eine Vorlage mit dem Namen „Vorlage:Titel 1“ hat, die folgenden Text enthält
 +
<nowiki>Nach Angaben von Wikipedianer {{{1}}} ist diese Seite kopiert von {{{2}}}</nowiki>
 +
Und die Vorlage so auf einer beliebigen Seite einbindet:
 +
<nowiki>{{Titel 1|wikiwichtel|http://www.irgendwo.de/}}</nowiki>
 +
Entsteht dort der Text
 +
Nach Angaben von Wikipedianer wikiwichtel ist diese Seite kopiert von http://www.irgendwo.de/
 +
 
 +
Bei der Angabe der Parameter ist die Reihenfolge zu beachten, die entsprechend der Nummern der Platzhalter in der Vorlage sein muss. Alternativ könnte man zwar auch folgendes verwenden ...
 +
<nowiki>{{Titel 1|2=http://www.irgendwo.de/|1=wikiwichtel}}</nowiki>
 +
aber es geht ja auch einfacher.
 +
 
 +
Wenn für einen Parameter kein Wert übergeben wird, so erscheint er leer bzw. es wird der Platzhalter <nowiki>{{{1}}}</nowiki> angezeigt.
 +
 
 +
Wird ein Parameter nachträglich in eine bestehende Vorlage eingefügt, so müssten eventuell die verwendenden Artikel entsprechend geändert werden. Deshalb sollte dies vermieden werden!
 +
 
 +
=== Problem: Aufzählungszeichen ===
 +
* Will man Aufzählungszeichen (<code>*</code> oder <code>#</code>), wie am Anfang dieser Zeile eines steht, als Parameterwert benutzen, so sollte in der Vorlage vor dem Parameter eine neue Zeile begonnen werden. Natürlich kann man dies auch bei der Anwendung der Vorlage einfügen:
 +
<nowiki>{{Vorlagenamen|</nowiki>
 +
* Aufzählungstext
 +
* Aufzählungstext
 +
}}
 +
 
 +
=== Problem: Gleichheitszeichen in Parameterwerten ===
 +
Übergibt man einer Vorlage als Parameterwert einen Text, der ein Gleichheitszeichen enthält, nimmt die MediaWiki-Software an, vor dem ersten Gleichheitszeichen stünde der Name eines Parameters, dem der Rest des Textes hinter dem ersten Gleichheitszeichen als Wert zugewiesen werden solle.  
 +
 
 +
Dieses Problem tritt etwa auf, wenn man als Parameterwert an eine Vorlage eine URL übergeben will, in der ein Gleichheitszeichen enthalten ist (z.&nbsp;B.:&nbsp;<nowiki>http://de.wikipedia.org/w/index.php?title=Hilfe:Vorlagen&action=edit&section=3</nowiki>), oder auch einen Text mit enthaltenen „<code>style</code>“-Abschnitten.
 +
 
 +
Die Abhilfe gegen diese unerwünschte Interpretation ist, dass man dem Parameterwert den numerischen Index des Parameters und ein ''weiteres'' Gleichheitszeichen voranstellt. Dann wird wie gewünscht interpretiert, dass der Parameterwert erst hinter dem (hinzugefügten) ersten Gleichheitszeichen beginnt, und der diesem vorangestellte Index bezeichnet unmissverständlich den ''Zielparameter'' für den Wert. Die Zählung der Parameter beginnt dabei mit 1 beim ersten Parameter nach dem Vorlagennamen.
 +
 
 +
{|
 +
|Statt:
 +
|<code><nowiki>{{Vorlagenname|http://…/index.php?title=…&action=edit&section=3}}</nowiki></code>
 +
|-
 +
|Richtig:
 +
|<code><nowiki>{{Vorlagenname|</nowiki><span style="color:#0000ff;">'''1='''</span><nowiki>http://…/index.php?title=…&action=edit&section=3}}</nowiki></code>
 +
|}
 +
 
 +
 
 +
Danach folgende unbenannte Parameter müssen ebenfalls nummeriert werden, da die automatische Zählung die explizite Nummerierung nicht berücksichtigt, d.&nbsp;h. bei <code><nowiki>{{Vorlagenname|erster Wert|2=zweiter Wert|dritter Wert}}</nowiki></code> würde <code>zweiter Wert</code> durch <code>dritter Wert</code> ersetzt werden.
 +
 
 +
Im normalen Fließtext, in dem das Gleichheitszeichen keine syntaktische Bedeutung hat, kann das Gleichheitszeichen durch '''&amp;#61;''' ersetzt werden.
  
 
== Wie erstellt man eigene Vorlagen? ==
 
== Wie erstellt man eigene Vorlagen? ==

Version vom 17. März 2013, 09:58 Uhr

Quellen:

Inhaltsverzeichnis

Was sind Vorlagen?

Eine Vorlage ist eine Seite, die die Einbindung häufig verwendeter Elemente in andere Seiten erleichtert. Im einfachsten Fall handelt es sich dabei um einen vorformulierten Textbaustein, der auf einer anderen Seite eingefügt werden kann.

Häufig enthalten Vorlagen auch die Möglichkeit, veränderliche Daten einzufügen, binden grafische Elemente ein und verwenden eine einfache Programmierung.

Vorteile von solchen Vorlagen sind:

  • Man muss sich nicht jedes Mal mit einer kompliziertes Definition von Kästchen und deren Formatierung beschäftigen, sondern hat einen einfachen Befehl.
  • Der Text erhält dadurch wieder erkennbare Elemente, an denen sich der Leser orientieren kann.
  • Die Vorlage kann an einer Stelle verändert werden und muss nicht auf vielen Seiten korrigiert werden.

Wie setzt man sie ein?

Im einfachsten Fall fügst du eine Vorlage mit {{Vorlagenname}} ein. Beim Anzeigen der Seite ersetzt die MediaWiki-Software dies dann durch den Inhalt der Vorlage „Vorlagenname“. Ändert jemand die Vorlage, ändert sich dadurch auch die Darstellung.


Transclusion simple.svg Das Bild verdeutlicht, wie es funktioniert. Die Seite B ist eine Vorlage, was man im Wiki normalerweise daran erkennt, dass der Seitenname die Bezeichnung des Namensraumes "Vorlage:" vorangestellt hat. Bei der Benutzung des Codes {{B}} (erkennbar im unteren Bereich) wird auf der Seite A der Inhalt von B eingefügt, ohne dass man erkennt, dass es von einer anderen Seite kommt. Übrigens wird sich auch Formatierungen wie Seitenumbrüche in B auf die Seite A aus. Das muss dann in B korrigiert werden, wenn


Parameter einfügen und verwenden

Oft sollen in einer Vorlage Inhalte auftauchen, die sich jedoch von Seite zu Seite ändern, zum Beispiel die Nummerierung einer Aufgabe, die Beschriftung eines Bildes oder die Aufgabenstellungen. Das erreicht man mit Parametern.

Auf der Vorlagen-Seite selber kennzeichnet man durch drei geschweifte Klammern {{{1}}} Stellen als Platzhalter; diese werden meist durchnummeriert. Alternativ kann man auch Namen dafür verwenden, was auf dem Chemie-digital-Wiki aber bisher nicht gemacht wird.

Ein Platzhalter kann auch als einfacher Text ausgegeben werden oder auch beliebig anders eingesetzt werden. Etwa als interner Link, wenn er seinerseits in der Vorlage mit zwei eckigen Klammern umgeben ist, wie zum Beispiel in [[{{{1}}}]], beliebig formatiert oder kombiniert mit anderen Ausgaben um etwa einen externen Link anzusteuern.

Eine Vorlage mit Parametern verwendet man, indem man nach dem Namen der Vorlage, getrennt mit jeweils einem senkrechten Strich die gewünschten Werte der Parameter angibt.

Beispiel:

Wenn man eine Vorlage mit dem Namen „Vorlage:Titel 1“ hat, die folgenden Text enthält

Nach Angaben von Wikipedianer {{{1}}} ist diese Seite kopiert von {{{2}}}

Und die Vorlage so auf einer beliebigen Seite einbindet:

{{Titel 1|wikiwichtel|http://www.irgendwo.de/}}

Entsteht dort der Text

Nach Angaben von Wikipedianer wikiwichtel ist diese Seite kopiert von http://www.irgendwo.de/

Bei der Angabe der Parameter ist die Reihenfolge zu beachten, die entsprechend der Nummern der Platzhalter in der Vorlage sein muss. Alternativ könnte man zwar auch folgendes verwenden ...

{{Titel 1|2=http://www.irgendwo.de/|1=wikiwichtel}}

aber es geht ja auch einfacher.

Wenn für einen Parameter kein Wert übergeben wird, so erscheint er leer bzw. es wird der Platzhalter {{{1}}} angezeigt.

Wird ein Parameter nachträglich in eine bestehende Vorlage eingefügt, so müssten eventuell die verwendenden Artikel entsprechend geändert werden. Deshalb sollte dies vermieden werden!

Problem: Aufzählungszeichen

  • Will man Aufzählungszeichen (* oder #), wie am Anfang dieser Zeile eines steht, als Parameterwert benutzen, so sollte in der Vorlage vor dem Parameter eine neue Zeile begonnen werden. Natürlich kann man dies auch bei der Anwendung der Vorlage einfügen:
{{Vorlagenamen|
* Aufzählungstext 
* Aufzählungstext
}}

Problem: Gleichheitszeichen in Parameterwerten

Übergibt man einer Vorlage als Parameterwert einen Text, der ein Gleichheitszeichen enthält, nimmt die MediaWiki-Software an, vor dem ersten Gleichheitszeichen stünde der Name eines Parameters, dem der Rest des Textes hinter dem ersten Gleichheitszeichen als Wert zugewiesen werden solle.

Dieses Problem tritt etwa auf, wenn man als Parameterwert an eine Vorlage eine URL übergeben will, in der ein Gleichheitszeichen enthalten ist (z. B.: http://de.wikipedia.org/w/index.php?title=Hilfe:Vorlagen&action=edit&section=3), oder auch einen Text mit enthaltenen „style“-Abschnitten.

Die Abhilfe gegen diese unerwünschte Interpretation ist, dass man dem Parameterwert den numerischen Index des Parameters und ein weiteres Gleichheitszeichen voranstellt. Dann wird wie gewünscht interpretiert, dass der Parameterwert erst hinter dem (hinzugefügten) ersten Gleichheitszeichen beginnt, und der diesem vorangestellte Index bezeichnet unmissverständlich den Zielparameter für den Wert. Die Zählung der Parameter beginnt dabei mit 1 beim ersten Parameter nach dem Vorlagennamen.

Statt: {{Vorlagenname|http://…/index.php?title=…&action=edit&section=3}}
Richtig: {{Vorlagenname|1=http://…/index.php?title=…&action=edit&section=3}}


Danach folgende unbenannte Parameter müssen ebenfalls nummeriert werden, da die automatische Zählung die explizite Nummerierung nicht berücksichtigt, d. h. bei {{Vorlagenname|erster Wert|2=zweiter Wert|dritter Wert}} würde zweiter Wert durch dritter Wert ersetzt werden.

Im normalen Fließtext, in dem das Gleichheitszeichen keine syntaktische Bedeutung hat, kann das Gleichheitszeichen durch &#61; ersetzt werden.

Wie erstellt man eigene Vorlagen?

Übersicht der Vorlagen

Dies sollte eventuell ausgelagert werden, auf eigene Seiten!

Abschnitte auf den Seiten

Symbole

Informationen Anwendung Aussehen
{{Hinweis|Hinweistext}} Hinweistext Gedacht als Kurzinformation, vor allem für Begriffe, die einer kurzen Erläuterung bedürfen. Wenn etwa die Verlinkung auf einen Wikipedia-Artikel keinen Sinn macht.
{{Wichtig|Hinweistext}} ACHTUNG:Hinweistext Gedacht als Kurzinformation, wenn der Leser etwas wichtiges zu beachten hat. Dies soll sozusagen einer erneute Erinnerung sein, was zum Beispiel vorher schon einmal erwähnt wurde.
{{Video}} UbuntuStudio-Icons-Video Production.svg Soll als Hinweis für Links auf einen Film verwendet werden.
{{Audio}} Etwas zum Anhören Soll als Hinweis für Links auf eine Audio-Datei verwendet werden.
{{}} 2 3
{{}} 2 3
{{}} 2 3
{{}} 2 3




Etwas zum Anhören