Vorlage:Dokumentation: Unterschied zwischen den Versionen
wp>PM3 (... und die Balken auf volle Breite, das sieht besser aus) |
wp>CarsracBot K (r2.6.4) (Bot: Ergänze: als, ar, ba, bar, bg, bs, ca, ckb, cs, cy, da, diq, dsb, el, en, eo, es, et, eu, fa, fr, gl, he, hsb, hu, hy, ia, id, it, ja, ko, ku, la, ltg, ml, nds-nl, nl, no, nso, pl, pt, ro, ru, simple, sk, sl, sq, sr, stq, sv, sw, te...) |
||
Zeile 80: | Zeile 80: | ||
{{#ifeq:{{NAMESPACE}}|{{ns:2}}||{{#ifexist: {{SUBJECTPAGENAME}}/Meta|{{{{SUBJECTPAGENAME}}/Meta}} | {{#ifeq:{{NAMESPACE}}|{{ns:2}}||{{#ifexist: {{SUBJECTPAGENAME}}/Meta|{{{{SUBJECTPAGENAME}}/Meta}} | ||
}}}} | }}}} | ||
}}<hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0em; height:0.7ex;" /></onlyinclude> | }}<hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0em; height:0.7ex;" /></onlyinclude><noinclude> | ||
[[als:Vorlage:Dokumentation]] | |||
[[ar:قالب:توثيق]] | |||
[[ba:Ҡалып:Doc]] | |||
[[bar:Vorlage:Dokumentation]] | |||
[[bg:Шаблон:Документация]] | |||
[[bs:Šablon:Dokumentacija]] | |||
[[ca:Plantilla:Ús de la plantilla]] | |||
[[ckb:داڕێژە:Documentation]] | |||
[[cs:Šablona:Dokumentace]] | |||
[[cy:Nodyn:Doc]] | |||
[[da:Skabelon:Dokumentation]] | |||
[[diq:Template:Documentation]] | |||
[[dsb:Pśedłoga:Dokumentacija]] | |||
[[el:Πρότυπο:Τεκμηρίωση προτύπου]] | |||
[[en:Template:Documentation]] | |||
[[eo:Ŝablono:Dok]] | |||
[[es:Plantilla:Documentación]] | |||
[[et:Mall:Dokumentatsioon]] | |||
[[eu:Txantiloi:Txantiloi dokumentazioa]] | |||
[[fa:الگو:توضیحات]] | |||
[[fr:Modèle:Documentation]] | |||
[[gl:Modelo:Uso de marcador]] | |||
[[he:תבנית:תיעוד]] | |||
[[hsb:Předłoha:Dokumentacija]] | |||
[[hu:Sablon:Sablondokumentáció]] | |||
[[hy:Կաղապար:Փաստաթղթեր]] | |||
[[ia:Patrono:Documentation]] | |||
[[id:Templat:Dokumentasi]] | |||
[[it:Template:Man]] | |||
[[ja:Template:Documentation]] | |||
[[ko:틀:틀 설명문서]] | |||
[[ku:Şablon:Belgekirin]] | |||
[[la:Formula:Documentation]] | |||
[[ltg:Taiss:Dokumentaceja]] | |||
[[ml:ഫലകം:വിവരണം]] | |||
[[nds-nl:Mal:Dokumentatie]] | |||
[[nl:Sjabloon:Sjabdoc]] | |||
[[no:Mal:Dokumentasjon]] | |||
[[nso:Template:Documentation]] | |||
[[pl:Szablon:Dokumentacja]] | |||
[[pt:Predefinição:Documentação]] | |||
[[ro:Format:Documentație]] | |||
[[ru:Шаблон:Doc]] | |||
[[simple:Template:Documentation]] | |||
[[sk:Šablóna:Dokumentácia]] | |||
[[sl:Predloga:Dokumentacija]] | |||
[[sq:Stampa:Dokumentacion]] | |||
[[sr:Шаблон:Документација]] | |||
[[stq:Foarloage:Dokumentation]] | |||
[[sv:Mall:Dokumentation]] | |||
[[sw:Kigezo:Documentation]] | |||
[[te:మూస:Documentation]] | |||
[[tl:Suleras:Documentation]] | |||
[[tpi:Template:Template doc]] | |||
[[tr:Şablon:Belgeleme]] | |||
[[tt:Калып:Doc]] | |||
[[uk:Шаблон:Документація]] | |||
[[ur:سانچہ:Documentation]] | |||
[[war:Template:Documentation]] | |||
[[yo:Àdàkọ:Aṣàlàyé]] | |||
[[zh:Template:Documentation]] | |||
</noinclude> |
Version vom 16. November 2011, 20:12 Uhr
Diese Vorlage ist vielfach eingebunden. Wenn du die Auswirkungen genau kennst, kannst du sie bearbeiten. Meist ist es jedoch sinnvoll, Änderungswünsche erst auf Vorlage Diskussion:Dokumentation abzustimmen. |
Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Seitenname>/Doku]]
ein.
Begründung
Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher.
- Insbesondere führt eine kleine Änderung in der Dokumentation nicht dazu, dass Tausende einbindender Seiten neu generiert werden müssen.
- In der Versionsgeschichte der Programmierungsseite erscheinen nur noch Änderungen, die die wirksamen Einbindungen betreffen.
Benutzung
Diese Vorlage benötigt meist keine Parameter. Es reicht, wenn der programmierte Code in <onlyinclude>
sowie </onlyinclude>
eingeschlossen wird und dann {{Dokumentation}}
an das Ende einer Vorlage geschrieben wird; danach kann die Dokumentationsseite [[<Seitenname>/Doku]]
erstellt werden. Nach dem Generieren der Dokumentation werden Erstellungshilfen bereitgestellt (preload).
In den Unterseiten stellen folgende Codezeilen am Anfang der Seite den Rückbezug sicher:
- /Doku
<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
- Am Ende der Seite werden die Kategorien von
<includeonly></includeonly>
eingeschlossen. - /Test
<noinclude>{{Dokumentation/Testseite}}</noinclude>
- /Unterseite
<noinclude>{{Dokumentation/Unterseite}}</noinclude>
- /Wartung
<noinclude>{{Dokumentation/Wartungsseite}}</noinclude>
- /styles
<noinclude>{{Dokumentation/styleSeite}}</noinclude>
- /Editnotice
<noinclude>{{Dokumentation/Editnoticeseite}}</noinclude>
- /Meta
- Diese Methode ist veraltet und wird nicht mehr unterstützt (integriert in /Doku).
Spezielle Unterseiten
/Test
- Eine Testunterseite enthält umfangreiche Beispiele zur Demonstration und Erprobung der korrekten Funktion.
- Nur wenige, kurze Beispiele sind besser direkt in der Dokumentationsseite aufgehoben.
/Wartung
- Sollte es eine Wartungsseite für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben.
- Eine eigene Wartungsseite lohnt sich jedoch nur für umfangreiche Analysen. Ansonsten ist es besser, dies in die Doku-Unterseite zu integrieren, weil ansonsten nur sehr selten einmal ein zufälliger Besucher auch die Wartungsseite öffnet und nach anstehenden Aufgaben sucht.
/XML
- Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben.
- /styles
- /styles.css
- Siehe TemplateStyles
/Editnotice
- Ein spezieller Hinweis, der beim Bearbeiten angezeigt wird.
/Meta
- Eine solche Unterseite war vor allem für vollgeschützte Seiten gedacht, die ansonsten nicht kategorisiert werden konnten, und sie sollte Interwiki-Bots das Beschreiben ermöglichen, ohne durch Halbschutz blockiert zu werden und auf den Beobachtungslisten zu stören. Diese Unterseite nahm auch Kategorisierungen auf.
- Interwiki-Links befinden sich inzwischen auf Wikidata.
- Es bleiben nur wenige Zeilen für die Kategorisierung, die inzwischen in
<includeonly>
eingeschlossen am Ende von/Doku
eingefügt werden. - Eine separate Unterseite lohnt nicht mehr und verkompliziert nur noch; Restbestände sind bis April 2018 aufgelöst worden.
- Siehe Hilfe:Vorlagendokumentation #Meta-Daten.
Unterseiten anlegen
Parameter
Zurzeit wird ein Parameter für Sonderfälle angeboten:
- TOC
- Vorgezogenes Inhaltsverzeichnis anzeigen.
- Für Vorlagendokumentationen, bei denen rechts eine hohe Tabelle erscheint (etwa Infoboxen), kann links oben der Sprung zur Dokumentation ermöglicht werden.
1
– Inhaltsverzeichnis vor dem Dokumentationsabschnitt
Interne Wartung
Fehlerhafte Einbindungen werden aufgelistet in der Kategorie:Regiowiki:Vorlagenfehler/Vorlage:Dokumentation – aktuell keine
(5. Oktober 2024 06:19)
Weitere Informationen
Interne Hilfsvorlagen, einzeln für besondere Fälle nutzbar:
- Vorlage:Dokumentation/ruler – einheitliche Trennlinie
- Vorlage:Dokumentation/header – Große Überschrift
- Vorlage:Dokumentation/footer – Fußbereich mit standardisierten Zusatzinfos
Bei Fragen zu dieser Vorlage kannst Du Dich an die Vorlagenwerkstatt wenden. |
|
als:Vorlage:Dokumentation ar:قالب:توثيق ba:Ҡалып:Doc bar:Vorlage:Dokumentation bg:Шаблон:Документация bs:Šablon:Dokumentacija ca:Plantilla:Ús de la plantilla ckb:داڕێژە:Documentation cs:Šablona:Dokumentace cy:Nodyn:Doc da:Skabelon:Dokumentation diq:Template:Documentation dsb:Pśedłoga:Dokumentacija el:Πρότυπο:Τεκμηρίωση προτύπου en:Template:Documentation eo:Ŝablono:Dok es:Plantilla:Documentación et:Mall:Dokumentatsioon eu:Txantiloi:Txantiloi dokumentazioa fa:الگو:توضیحات fr:Modèle:Documentation gl:Modelo:Uso de marcador he:תבנית:תיעוד hsb:Předłoha:Dokumentacija hu:Sablon:Sablondokumentáció hy:Կաղապար:Փաստաթղթեր ia:Patrono:Documentation id:Templat:Dokumentasi it:Template:Man ja:Template:Documentation ko:틀:틀 설명문서 ku:Şablon:Belgekirin la:Formula:Documentation ltg:Taiss:Dokumentaceja ml:ഫലകം:വിവരണം nds-nl:Mal:Dokumentatie nl:Sjabloon:Sjabdoc no:Mal:Dokumentasjon nso:Template:Documentation pl:Szablon:Dokumentacja pt:Predefinição:Documentação ro:Format:Documentație ru:Шаблон:Doc simple:Template:Documentation sk:Šablóna:Dokumentácia sl:Predloga:Dokumentacija sq:Stampa:Dokumentacion sr:Шаблон:Документација stq:Foarloage:Dokumentation sv:Mall:Dokumentation sw:Kigezo:Documentation te:మూస:Documentation tl:Suleras:Documentation tpi:Template:Template doc tr:Şablon:Belgeleme tt:Калып:Doc uk:Шаблон:Документація ur:سانچہ:Documentation war:Template:Documentation yo:Àdàkọ:Aṣàlàyé zh:Template:Documentation