Hilfe:Vorlagen/VisualEditor

Aus Wikivoyage

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 – Quickbar Ort, Literatur, Marker, VCard, …
  • 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.

Vorlagen einfügen

Das Bearbeitungswerkzeug bietet im Bearbeitungsmodus zu einer Seite einen Menüpunkt Einfügen Elemente einfügen. In dessen Drop-Down-Bereich befindet sich ein Unterpunkt icon Vorlage, der ein neues Dialogfenster öffnet, das Optionen zum Hinzufügen und Ausfüllen von Vorlagen anbietet. Alternativ kann dieses Dialogfenster auch über die Eingabe von zwei geschweiften öffnenden Klammern {{ an der Cursorposition aufgerufen werden.

Logo
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.
Abbrechen
⧼visualeditor-dialog-transclusion-placeholder⧽
Einfügen

icon ⧼Visualeditor-dialog-transclusion-placeholder⧽
 |  
Vorlage hinzufügen

⧼visualeditor-dialog-transclusion-multiple-mode⧽

Abbrechen
⧼visualeditor-dialog-transclusion-placeholder⧽
Einfügen

icon ⧼Visualeditor-dialog-transclusion-placeholder⧽
 VCar|  
VCard
Vormatierung von Angaben, wie sie auf einer Visitenkarte stehen könnten.
VCard/XML
VCard/Doku
VCard/Sandkasten
Vorlage hinzufügen

⧼visualeditor-dialog-transclusion-multiple-mode⧽
 Info: Wenn der Name einen Schrägstrich / enthält, solltest du ihn in der Regel nicht auswählen, da es sich um eine Unterseite der Vorlage handeln könnte.

Vorlage hinzufügen – übernimmt die Vorlage und zeigt im nächsten Dialogfeld die Parameter zum Ausfüllen an, wenn diese dokumentiert sind.

Dialogfeld rechte Seite – Optionen ausgeblendet
Pflichtangaben werden durch ein Sternchen gekennzeichnet. Das Informationsicon zeigt gegebenenfalls weitere Hinweise zum Parameter an. Siehe auch Beispiel
Abbrechen
Vorlagenname
Einfügen

Kurzbeschreibung[1]


⧼visualeditor-dialog-transclusion-more-template-description⧽[2]
Parameter-1 Beschreibung des Feldes
 |
Parameter-2
  

⧼visualeditor-dialog-transclusion-add-param⧽

 Feldname
Keine unbenutzen Felder



⧼visualeditor-dialog-transclusion-multiple-mode⧽
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.
⧼visualeditor-dialog-transclusion-add-param⧽ – es könnten weitere optionale Parameter vorhanden sein oder es sollen unbenannte Parameter hinzugefügt werden.
 Eingabesuchfeld
– optionale, unbenannte oder nicht über TemplateData dokumentierte Parameter können über das Eingabefeld gefunden oder benannt werden.
Anzeigefeld für optionale Parameter Keine unbenutzten Felder, ein Hinweis, dass laut TemplateData keine weiteren Parameter mehr zur Verfügung stehen, es könnten jedoch nicht dokumentierte Parameter vorhanden sein.

 Info: Bei Parametern, die nicht mit TemplateData zugewiesen wurden, sollte zuvor geprüft werden, wie der Parameter innerhalb der Vorlagenprogrammierung benannt wurde, um zu verhindern, dass Inhalte in falsch benannte oder nicht existierende Felder eingefügt und so nicht angezeigt oder erkannt werden. Daher bitte einen Blick auf die Vorlagenseite werfen.[2]

Abbrechen
Vorlagenname
Einfügen

Kurzbeschreibung


⧼visualeditor-dialog-transclusion-more-template-description⧽
⧼visualeditor-dialog-transclusion-add-param⧽
 1|  
1
unbekanntes Feld

⧼visualeditor-dialog-transclusion-multiple-mode⧽
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.
Abbrechen
Vorlagenname
Einfügen

Kurzbeschreibung


⧼visualeditor-dialog-transclusion-more-template-description⧽
1 Beschreibung des Feldes
 |  
⧼visualeditor-dialog-transclusion-add-param⧽
 Feldname
Keine unbenutzen Felder

⧼visualeditor-dialog-transclusion-multiple-mode⧽
Füge nun den Inhalt in das Eingabefeld ein
Abbrechen
Vorlagenname
Einfügen

Kurzbeschreibung


⧼visualeditor-dialog-transclusion-more-template-description⧽
 |Feldname
Parameter-1
Parameterkurzbeschreibung
Parameter-2
Parameterkurzbeschreibung
Parameter-3
Parameterkurzbeschreibung
x weitere Felder anzeigen

⧼visualeditor-dialog-transclusion-multiple-mode⧽
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.
Abbrechen – Vorgang abbrechen und die Änderung verwerfen.
Einfügen – Vorlage in die Seitenansicht einfügen und anschließend über das Hauptmenü abspeichern.
Dialogfeld mit eingeblendeten Optionen
Wenn du auf die Schaltfläche „⧼visualeditor-dialog-transclusion-multiple-mode⧽“ 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.
Abbrechen
⧼visualeditor-dialog-transclusion-title⧽
Einfügen

icon Vorlagenname
icon Parameter-1
icon Parameter-2
icon Weitere Informationen
icon Vorlagenname
Kurzbeschreibung

⧼visualeditor-dialog-transclusion-more-template-description⧽

Parameter-1 Beschreibung des Feldes
 Inhalt
Parameter-2
  

⧼visualeditor-dialog-transclusion-add-param⧽

 Feldname
Keine unbenutzen Felder
 
icon 00

⧼visualeditor-dialog-transclusion-single-mode⧽
Ein Klick auf einen Eintrag auf der linken Seite springt rechts zur dazu passenden Eingabemöglichkeit
Abbrechen
⧼visualeditor-dialog-transclusion-title⧽
Einfügen

icon Vorlagenname
icon Parameter-1
icon Parameter-2
icon Weitere Informationen
icon Vorlagenname
Kurzbeschreibung

⧼visualeditor-dialog-transclusion-more-template-description⧽

Parameter-1 Beschreibung des Feldes
 Inhalt|
Parameter-2
  

⧼visualeditor-dialog-transclusion-add-param⧽

 Feldname
Keine unbenutzen Felder
 
icon 00

⧼visualeditor-dialog-transclusion-single-mode⧽
 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.
icon 00

icon ⧼visualeditor-dialog-transclusion-placeholder⧽ – Diese Vorlage wird nicht innerhalb der hier bearbeiteten Vorlage eingefügt. Die Schaltfläche Vorlage hinzufügen wird erst aktiv, wenn ein Vorlagenname eingegeben wurde.[3]

icon ⧼visualeditor-dialog-transclusion-placeholder⧽
  
Vorlage hinzufügen

⧼visualeditor-dialog-transclusion-add-param⧽ – vermutlich gehört das Feld direkt zu der zusätzlich möglichen einzufügenden Vorlage.

⧼visualeditor-dialog-transclusion-add-param⧽
 |Feldname

Inhalt hinzufügen – beispielsweise als Einleitungstext zur Vorlage oder Nachsatz.

Inhalt
 |  

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]

Abbrechen
⧼visualeditor-dialog-transclusion-title⧽
Einfügen

Inhalt
Inhalt
 Kurzer Einleitungstext zur Vorlage oder zusätzliche Quellenangabe|  
icon Vorlagenname
Kurzbeschreibung

⧼visualeditor-dialog-transclusion-more-template-description⧽

Parameter-1 Beschreibung des Feldes
 Inhalt
Parameter-2
  

⧼visualeditor-dialog-transclusion-add-param⧽

 Feldname
Keine unbenutzen Felder
icon Vorlagenname
icon Parameter-1
icon Parameter-2
icon Weitere Informationen
 
icon 00

⧼visualeditor-dialog-transclusion-single-mode⧽
– den markierten Eintrag in der Liste weiter nach oben oder unter schieben
– den markierten Eintrag oder Parameter löschen
Abbrechen – Vorgang abbrechen und die Änderung verwerfen.
Einfügen – Vorlage in die Seitenansicht einfügen und anschließend über das Hauptmenü abspeichern.
⧼visualeditor-dialog-transclusion-single-mode⧽ – Die linke Seite wieder ausblenden

Ausfüllen anhand eines Beispiels

Hier wird die Vorlage {{VCard}}, die in keinem Personenartikel fehlen sollte, als Muster verwendet.

Logo
⧼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.
Abbrechen
⧼visualeditor-dialog-transclusion-placeholder⧽
Einfügen

icon ⧼Visualeditor-dialog-transclusion-placeholder⧽
 Personendaten|  
VCard
Formatierung von Angaben…
VCard/Doku
VCard/Sandkasten
VCard/XML
Vorlage hinzufügen
 

⧼visualeditor-dialog-transclusion-multiple-mode⧽
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

Logo
Vorlage VCard 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.
Abbrechen
Personendaten
Einfügen

VCard zum Einfügen von Museen usw.; siehe auch Hilfe:Erstellen einer VCard


⧼visualeditor-dialog-transclusion-more-template-description⧽
Name Beschreibung des Feldes
 |
Namensergänzung
  
Datenobjekt
 
Auto
  
Typ
  
Untertyp
  
Alternativer Name
  

⧼visualeditor-dialog-transclusion-add-param⧽

 Feldname
Keine unbenutzen Felder



⧼visualeditor-dialog-transclusion-multiple-mode⧽
Nicht alle Felder der Vorlage sind eingeblendet, es sind viele optionalen Parameter vorhanden. Erwünscht ist das Ausfüllen aller Felder, Pflicht- oder Mindestangaben sind der Name und Typ eines Objektes. 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.

Vorlagen bearbeiten oder Parameter hinzufügen

Logo
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 werden und anschließend über einen Klick zur Bearbeitung geöffnet werden.
Personendaten
NAME Mustermann, Maximilian
KURZBESCHREIBUNG Musterperson
icon Vorlage
Erzeugt von: Personendaten
Bearbeiten
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.
Abbrechen
Personendaten
Änderungen speichern

icon Personendaten
Personendaten zum Einfügen am Ende des Artikels, hinter die Kategorien; siehe auch Hilfe:Personendaten
⧼visualeditor-dialog-transclusion-more-template-description⧽
Name Beschreibung des Feldes
 Mustermann, Maximilian
Kurzbeschreibung
 Musterperson
⧼visualeditor-dialog-transclusion-add-param⧽
 |Feldname
Alternativnamen ALTERNATIVNAMEN
Geburtsdatum GEBURTSDATUM
Geburtsort
Ortsangaben bitte verlinken[5]
GEBURTSORT
drei weitere Felder anzeigen

⧼visualeditor-dialog-transclusion-multiple-mode⧽
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.
Abbrechen
Personendaten
Änderungen speichern

Personendaten zum Einfügen am Ende des Artikels, hinter die Kategorien; siehe auch Hilfe:Personendaten


⧼visualeditor-dialog-transclusion-more-template-description⧽
Name
 Mustermann, Erika
Alternativnamen
  
Kurzbeschreibung
 Beispielperson, Ausweismuster
Geburtsdatum
 1. Januar 1966  
Geburtsort
Beschreibung des Feldes
Beschreibung des Feldes
Sterbedatum
  
Sterbeort
  

⧼visualeditor-dialog-transclusion-add-param⧽


⧼visualeditor-dialog-transclusion-multiple-mode⧽
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.

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.

Logo
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 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.
Abbrechen
⧼visualeditor-dialog-transclusion-placeholder⧽
Einfügen

icon ⧼Visualeditor-dialog-transclusion-placeholder⧽
 subst:QS|  
Vorlage hinzufügen

⧼visualeditor-dialog-transclusion-multiple-mode⧽
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

Abbrechen
Subst:QS
Einfügen

icon Subst:QS

Die Vorlage „Vorlage:Subst:QS“ hat noch keine Beschreibung, aber vielleicht gibt es einige Informationen auf der Vorlagenseite.[6]
⧼visualeditor-dialog-transclusion-add-param⧽
 |Feldname
Keine unbenutzen Felder

⧼visualeditor-dialog-transclusion-multiple-mode⧽
Hier nun im Suchfeld den Feldnamen mit einer 1 überschreiben und danach das Feld mit der Bezeichnung 1 unbekanntes Feld anklicken
Abbrechen
Subst:QS
Einfügen

icon Subst:QS

Die Vorlage „Vorlage:Subst:QS“ hat noch keine Beschreibung, aber vielleicht gibt es einige Informationen auf der Vorlagenseite.
⧼visualeditor-dialog-transclusion-add-param⧽
 1|  
1
unbekanntes Feld

⧼visualeditor-dialog-transclusion-multiple-mode⧽
In das Eingabefeld unter der 1 nun den Grund für das Setzen des Mangelbausteines einfügen.
Abbrechen
Subst:QS
Einfügen

icon Subst:QS

Die Vorlage „Vorlage:Subst:QS“ hat noch keine Beschreibung, aber vielleicht gibt es einige Informationen auf der Vorlagenseite.

1

 Der Text ist unverständlich, es sind keine Belege vorh|  

⧼visualeditor-dialog-transclusion-add-param⧽
 Feldname
Keine unbenutzen Felder

⧼visualeditor-dialog-transclusion-multiple-mode⧽
Wenn du alle notwendigen Felder ausgefüllt hast, klicke abschließend auf die Schaltfläche „Einfügen“.

Einfügen – diese Vorlage als Quelltextversion in die Seite einfügen
Der Baustein befindet sich nun sichtbar im Artikel.

Dieser Artikel wurde mit der Begründung: Der Text ist unverständlich, es sind keine Belege vorhanden am 30. Mai 2024 um 00:12 durch Beispielnutzer (DiskussionBeiträge) als verbesserungswürdig eingestuft. , ihn zu verbessern
icon Vorlage
Erzeugt von: Subst:QS
Bearbeiten
Vor dem endgültigen Abspeichern 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.

Bearbeiten – Vorlage vor dem Abspeichern nochmals bearbeiten
Änderungen speichern – Inhalt dieser Vorlage im Quelltext der Seite abspeichern

Siehe auch[Bearbeiten]

Hilfeseiten[Bearbeiten]

Anmerkungen[Bearbeiten]

  1. Hier wird eine Kurzbeschreibung zum Zweck der Vorlage eingeblendet, wenn diese auf der zugehörigen Vorlagendokumentationsseite angegeben wurde.
  2. 2,0 2,1 Hier wird direkt auf die Vorlagenseite verlinkt, um eventuell dort vorhandene Parameterbezeichnungen oder Hinweise lesen zu können.
  3. Sie kann nicht in einen Parameter eingefügt werden, sondern wird direkt vor oder hinter dieser Vorlage in den Quelltext übernommen.
  4. Es können beispielsweise zusätzliche Quellenangaben oder über Zitationsvorlagen eingebundene Einzelnachweise an einer Vorlage angebracht werden.
  5. In der Auswahlliste wird der Hinweistext zum Parameter angezeigt, der ansonsten über das Infosymbol abgerufen werden kann, wenn dieser angegeben wurde.
  6. Während der noch nicht erfolgten Vorlagenersetzung steht hier ein nicht zielführender Link