Huif:Vorlogn/VisualEditor
Diese Seite beschreibt, wie Vorlagen mit der Bearbeitungsumgebung VisualEditor eingebunden werden können. Diese wird an der aktuellen Cursorposition eingefügt.
Vorlagenbestandteile
Eine Vorlage, wie die Vorlage:Literatur, kann auf einer Seite eingebunden werden, um einheitliche Formatierungen anzubieten. Vorlagen werden jeweils unter einen spezifischen Namen zumeist im Vorlagennamensraum angelegt. Wenn du eine Vorlage verwenden möchtest, solltest du ihre Funktion und diesen Namen kennen, um sie sinnvoll einzubinden. Das normale Menü mit den Eingabefeldern führt bislang nur wenige Wertüberprüfungen (Validierungen) aus.
- Titel oder Name der Vorlage – Internetquelle, Literatur, Zitat, Personendaten, …
- Vorlagenspezifische Parameter und Pflichtparameter – in vielen Vorlagen muss mindestens ein Parameter als Pflichtangabe ausgefüllt werden
- Inhaltstext für die Parameterwerte – Inhalt eines benannten oder nummerierten Parameters
- Optionale oder unbenutzte Parameter – manche Vorlagen bieten eine Vielzahl an optionalen Parametern an. Bei Zitationsvorlagen sollten nicht verwendete, leere, nicht zutreffende Parameter entfernt werden.
Vorlagensuche
Im Juli 2021 wurde die Suchfunktion optimiert, beim Aufruf erscheint ein Hinweiskasten, der über das 
dauerhaft geschlossen werden kann. Wie eine Vorlage gesucht werden kann, ist im Abschnitt Vorlagen einfügen erklärt.
⧼visualeditor-dialog-transclusion-feedback-message⧽
Vorlagen einfügen
Aktivierung über Unterpunkt 
Vorlage{{ an der Cursorposition aufgerufen werden.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Vorlage an der Cursorposition einfügen | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Im Dialogfeld kannst du den Namen der gewünschten Vorlage in das Eingabefeld einfügen. Sobald du einen Buchstaben einfügst, wird dir eine Auswahlliste der vorhandenen Vorlagen angezeigt, in der du den Namen anklicken kannst. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
↓
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Die Suchauswahl zeigen nun Ergebnisse, die entweder die Zeichenkette im Suchfeld enthalten oder in deren Beschreibung eine solche Zeichenkette enthalten ist. Dies soll helfen eine passende Vorlage zu finden, selbst wenn man ihren genauen Namen nicht kennt.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Dialogfeld rechte Seite – Optionen ausgeblendet | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Pflichtangaben werden durch ein Sternchen  gekennzeichnet. Das Informationsicon  zeigt gegebenenfalls weitere Hinweise zum Parameter an. Siehe auch Beispiel
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Im Dialogfeld werden nun die benannten und (mittels TemplateData) als erwünscht oder explizit erforderlich ausgewiesenen Parameter der Vorlage aufgelistet. Zu jedem Parameter wird ein Eingabefeld oder eine Checkbox angezeigt, um die benötigten Angaben einfügen zu können.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Kurzbeschreibung ⧼visualeditor-dialog-transclusion-more-template-description⧽   ⧼visualeditor-dialog-transclusion-add-param⧽
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Verwende für die Eingabe für die unbenannten Parameter optional fortlaufend die Nummern 1, 2, … als Feldname und klicke das als unbekannt angegebene Feld an, um ihm einen Inhalt zuzuweisen.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Kurzbeschreibung ⧼visualeditor-dialog-transclusion-more-template-description⧽
⧼visualeditor-dialog-transclusion-add-param⧽
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Füge nun den Inhalt in das Eingabefeld ein | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Kurzbeschreibung ⧼visualeditor-dialog-transclusion-more-template-description⧽
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sind alle Parameter optional und wurden nicht als Vorgabe bestimmt, so werden sie unterhalb eines Sucheingabefeldes angezeigt, falls es sich um benannte Parameter handelt. Diese können nun durch Anklicken zur Vorlage hinzugefügt werden. Sind alle Parameter ausgefüllt kannst du die Vorlag übernehmen.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Dialogfeld mit eingeblendeten Optionen | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Wenn du auf die Schaltfläche „Optionen anzeigen“ klickst, öffnet sich die rechte Seite des Dialogfeldes und bietet dir weitere Optionen an. Die jeweils aktive Option wird hellblau markiert. Zunächst werden alle Angaben, die in der oberen Hälfte der rechten Seite des Dialogfeldes vorhanden sind auf der linken Seite als Liste aufgeführt. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Ein Klick auf einen Eintrag auf der linken Seite springt rechts zur dazu passenden Eingabemöglichkeit | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 Info: Die Funktionalität der Menüleiste im unteren Bereich ist derzeit etwas unklar. Sie führt dazu, dass zusätzlich zur eigentlichen Vorlage Elemente zum Seitenquelltext hinzugefügt werden können. So können beispielsweise Einleitungstexte oder zugehörige Untervorlagen, die mit der Vorlage im Zusammenhang stehen direkt vor oder hinter der Vorlage hinzugefügt werden und bilden in der Auswahl der Vorlage dann eine Einheit. Die Angaben lassen sich nur über den Aufruf der Vorlage ändern.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
      
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Inhalt hinzufügen – beispielsweise als Einleitungstext zur Vorlage oder Nachsatz.
Gibt man in die so gekennzeichneten Felder einen Text ein, so wird dieser direkt und ohne Leerraum hinter der Vorlage in den Seitentext eingefügt. Dieser Inhalt kann als sogenannter Wikitext formatiert werden.[4]
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Ausfüllen anhand eines Beispiels
Hier wird die Vorlage {{Personendaten}}, die in keinem Personenartikel fehlen sollte, als Muster verwendet.
| ||||||||||||||||||
| ⧼visualeditor-dialog-transclusion-placeholder⧽ | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Sobald du einen Buchstaben einfügst wird dir eine Auswahlliste der vorhandenen Vorlagen angezeigt, in der du den Namen anklicken kannst. | ||||||||||||||||||
| ||||||||||||||||||
| Durch einen anschließenden Klick auf die Schaltfläche Vorlage hinzufügen übernimmst du diese Vorlage, um nun ihre Parameter auszufüllen. | ||||||||||||||||||
Vorlage ausfüllen
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Vorlage Personendaten ausfüllen | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameter, die mit einem Sternchen  gekennzeichnet sind, sind Pflichtangaben, ohne die die Vorlage nicht eingefügt werden sollte. Diese Parameter lassen sich nicht über die Mülltonnensymbole  entfernen. Falls in der Vorlage Beispielangaben oder Hinweistexte hinterlegt wurden, lassen sich diese über das Informationsicon  aufrufen.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Personendaten zum Einfügen am Ende des Artikels, hinter die Kategorien; siehe auch Hilfe:Personendaten ⧼visualeditor-dialog-transclusion-more-template-description⧽
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alle Felder der Vorlage sind eingeblendet, es sind keine optionalen Parameter vorhanden. Erwünscht ist das Ausfüllen aller Felder, Pflicht- oder Mindestangaben sind der Name und eine kurze Beschreibung zur Person. Die übrigen Parameter sollten „nicht“  entfernt werden, da es sich um Angaben handelt, die möglicherweise erst später mit Inhalt gefüllt werden können, wie beispielsweise die Sterbedaten, bei noch lebenden Personen.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Vorlagen bearbeiten oder Parameter hinzufügen
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Fehlende oder gelöschte Parameter hinzufügen | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Wurden Parameter über die Mülltonnensymbole entfernt oder sind in der Programmierung hinzugekommen, so können diese zur Vorlage hinzugefügt werden. Vorhandene Vorlagen können direkt auf der Seite angeklickt und anschließend über einen Klick zur Bearbeitung geöffnet werden.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| In diesem Beispiel sind bislang nur die Pflichtparameter angegeben worden, normalerweise würden alle optionalen Parameter sofort nach dem Klick auf Bearbeiten wieder in der oberen Hälfte als erwünschte Parameter aufgelistet werden. Hier ist es zur Demonstration so dargestellt, als wenn es sich um rein „optionale“ Parameter handeln würde. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Personendaten
Personendaten zum Einfügen am Ende des Artikels, hinter die Kategorien; siehe auch Hilfe:Personendaten
⧼visualeditor-dialog-transclusion-more-template-description⧽
 ⧼visualeditor-dialog-transclusion-add-param⧽
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Die einzelnen Vorschläge aus der unteren Liste lassen sich durch Anklicken hinzufügen und können anschließend ausgefüllt werden. Bei umfangreichen Vorlagen mit sehr vielen optionalen Parametern wie beispielsweise bei der Vorlage:Literatur können Parameter auch mithilfe des Sucheingabefeldes gefunden werden. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Personendaten zum Einfügen am Ende des Artikels, hinter die Kategorien; siehe auch Hilfe:Personendaten ⧼visualeditor-dialog-transclusion-more-template-description⧽
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sind alle bekannten Angaben ergänzt oder korrigiert wird die Vorlage über Einfügen oder Änderungen speichern in die Seitenansicht übernommen und kann über das Hauptmenü gespeichert werden.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Vorlage entfernen
|
| ||
| Vorhandene Vorlagen von der Seite entfernen. | ||
|---|---|---|
| Manchmal ist es notwendig eine Vorlage wieder aus der Seite zu entfernen weil sie ausgetauscht werden sollen oder weil es sich um Wartungsbausteine handelt, die beispielsweise Mängel an einem Artikel anzeigen. Sind diese Mängel behoben kann der Baustein entfernt werden. Klicke die Vorlage an, um das Dialogfeld zu öffnen. | ||
| ||
| Du hast nun die Möglichkeit die Vorlage durch einen Klick auf die Schaltfläche zu entfernen. Alternativ kannst du zum Löschen auch die Taste Entf der Tastatur verwenden. |
Boolesche Parameter
|
| ||||||||||||||
| Auswahl zwischen zwei Zuständen (boolesche Variablen) | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Es gibt Parameter, die eine einfache Auswahl zwischen zwei definierten Zuständen ermöglichen. Der Parameter erwartet einen Wert 0 für „nein“ oder 1 für „ja“. Eine der beiden Optionen ist als Standard vorgegeben. Beim ersten Aufruf des Parameters wird zumeist ein Texteingabefeld angezeigt, das die Standardwertzuweisung anzeigt. Wird das Feld leer gelassen, wird diese Standardauswahl übernommen. Ist hier bereits eine Eingabe 0 oder 1 erfolgt, wandelt sich das Feld in eine Checkbox. Der Zustand kann von jetzt an durch einfaches Anklicken geändert werden.
| ||||||||||||||
| ||||||||||||||
Der Zustand der Abfrage lässt sich über das Wikitextsymbol  auslesen. Im Falle einer Checkbox werden die Werte 0 oder 1 angezeigt.
| ||||||||||||||
Feldinhalt
Feldinhalt
Anzeige  Commons: Tutorials – Sammlung vo Buidl, Videos und Audiodateien | ||||||||||||||
Über das Wikitextsymbol kann der Wert geändert oder durch einen Text überschrieben werden, was dazu führt, dass das Feld sich wieder in ein Texteingabefeld wandelt. Bei Eingaben, die nicht der booleschen Variable entsprechen, wird der Wert als 1 interpretiert, ein leerer Parameter übernimmt den Standardzustand.
| ||||||||||||||
Anzeige = Standardausgabe Commons: Tutorials – Sammlung vo Buidl, Videos und Audiodateien | ||||||||||||||
Parameter mit Vorschlagsliste
|
| ||||||||||||||||||||||||||||
| Parameterwerte aus einer Vorschlagsliste hinzufügen | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Manche Vorlagen bieten für einzelne Parameter eine Liste mit möglichen Werten an, aus der diese durch anklicken ausgewählt werden können. Als Beispiel dient hier der Parameter lang der Vorlage:Wikisource. Zu erkennen sind diese Parameter an diesem Symbol .
| ||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||
Klickt man das Eingabefeld des Parameters lang an, so öffnet sich automatisch die Vorschlagsliste. Im unteren Beispiel ist zur Veranschaulichung nur dieser Parameter dargestellt.
| ||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||
Das Eingabefeld bietet zudem die Möglichkeit durch manuelle Eingabe nach passenden Einträgen zu suchen. Solange der Inhalt des Eingabefeldes nicht den vorgegebenen Werten entspricht erfolgt eine Warnung. Die Vorschlagsliste zeigt nur die Werte an, die der Eingabe nahe kommen, also in diesem Beispiel mit einem h beginnen..
| ||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||
| Wird in das Eingabefeld etwas eingetragen, das nicht den vorgegebenen Werten entspricht, so erfolgt eine Warnung. Das Aufklappen der Vorschlagsliste funktioniert dann nicht mehr und das Eingabefeld muss manuell geleert werden.
| ||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||
Ein Klick auf das zum Parameter gehörige Infosymbol  erkärt, welche Art von Werten hier erwartet werden.
| ||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||
Vorlagen substituieren
Manchmal sollen Vorlage substituiert werden, um ihren kompletten Quelltext in eine Seite zu integrieren. Dazu muss subst: oder ers: (inklusive Doppelpunkt) vor dem Vorlagennamen eingegeben werden.
|
| ||||||||||||||
| Vorlage durch Substituierung expandieren | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Eine Substituierung auf Seiten im Artikelbereich ist selten sinnvoll, da die dort eingebundenen Vorlagen automatisch die jeweils gültige Version der Vorlage einbinden sollen. Ausnahmen können Bewertungsbausteine sein, mit denen Artikel zusätzlich in der Qualitätssicherung oder ähnlichen Wartungsseiten eingetragen werden sollen. Dort ist unveränderliche Form wichtig, damit sich Inhalte oder Layout der Vorlagen nicht nachträglich versehentlich ändern. | ||||||||||||||
| ||||||||||||||
| Nach dem Klick auf die Schaltfläche „Vorlage hinzufügen“ öffnet sich das Dialogfeld zum Ausfüllen der Parameter. Dort sollten die Parameter mit eingefügt werden, leider werden sie jedoch nicht automatisch erkannt und ein Fehlen von Pflichtparametern kann zu einer Fehlfunktion führen. Vorlage hinzufügen – diese Vorlage auswählen, um ihren Quellcode in die Seite einzubinden | ||||||||||||||
Die Vorlage „Vorlage:Subst:QS“ hat noch keine Beschreibung, aber vielleicht gibt es einige Informationen auf der Vorlagenseite.[6]
⧼visualeditor-dialog-transclusion-add-param⧽
| ||||||||||||||
Hier nun im Suchfeld den Feldnamen mit einer 1 überschreiben und danach das Feld mit der Bezeichnung 1 unbekanntes Feld anklicken
| ||||||||||||||
Die Vorlage „Vorlage:Subst:QS“ hat noch keine Beschreibung, aber vielleicht gibt es einige Informationen auf der Vorlagenseite.
⧼visualeditor-dialog-transclusion-add-param⧽
| ||||||||||||||
In das Eingabefeld unter der 1 nun den Grund für das Setzen des Mangelbausteines einfügen.
| ||||||||||||||
Die Vorlage „Vorlage:Subst:QS“ hat noch keine Beschreibung, aber vielleicht gibt es einige Informationen auf der Vorlagenseite.
1
⧼visualeditor-dialog-transclusion-add-param⧽
| ||||||||||||||
| Wenn du alle notwendigen Felder ausgefüllt hast, klicke abschließend auf die Schaltfläche „Einfügen“. – diese Vorlage als Quelltextversion in die Seite einfügen | ||||||||||||||
| ||||||||||||||
| Vor dem endgültigen Veröffentlichen kann die Vorlage nochmals über die Schaltfläche Bearbeiten aufgerufen werden, falls du noch etwas am Text verändern möchtest. Über das Hauptmenü kannst du die Änderungen dann in den Seiteninhalt übernehmen oder sie dir zuvor im Versionsvergleich für den Quelltext noch einmal ansehen. Nach dem Speichern ist dieser Eintrag nicht mehr als Vorlageneinbindung bearbeitbar, sondern verhält sich wie normaler Seiteninhalt. In diesem Beispiel wäre es eine Tabellenformatierung.
Löschen – Vorlage wieder entfernen | ||||||||||||||
Weitere Informationen
Werkeln- Hilfe:Vorlagen – technische Beschreibung zur Vorlagennutzung.
- Hilfe:TemplateData und Hilfe:TemplateData/VisualEditor – Beschreibung der TemplateData-Dokumentation von Vorlagen.
- Hilfe:Seiten einbinden – Hinweise zur Einbindung von Seiteninhalten in andere Seiten.
- Hilfe:VisualEditor/Verwendete Vorlagen – Beschreibung, wie man sich die auf der Seite eingebundenen Vorlagen anzeigen lassen kann.
- Wikipedia:Textbausteine – Übersicht über vorgefertigte Vorlagen für spezielle Funktionen.
Anmerkungen
Werkeln- ↑ Hier wird eine Kurzbeschreibung zum Zweck der Vorlage eingeblendet, wenn diese auf der zugehörigen Vorlagendokumentationsseite angegeben wurde.
- ↑ 2,0 2,1 Hier wird direkt auf die Vorlagenseite verlinkt, um eventuell dort vorhandene Parameterbezeichnungen oder Hinweise lesen zu können.
- ↑ Sie kann nicht in einen Parameter eingefügt werden, sondern wird direkt vor oder hinter dieser Vorlage in den Quelltext übernommen.
- ↑ Es können beispielsweise zusätzliche Quellenangaben oder über Zitationsvorlagen eingebundene Einzelnachweise an einer Vorlage angebracht werden.
- ↑ In der Auswahlliste wird der Hinweistext zum Parameter angezeigt, der ansonsten über das Infosymbol
abgerufen werden kann, wenn dieser angegeben wurde.
- ↑ Während der noch nicht erfolgten Vorlagenersetzung steht hier ein nicht zielführender Link