Template:Vorlagendokumentation/doc: Difference between revisions
Template page
More actions
←Created page with '{{incl}} {{notitle}} {{Vorlagendokumentation/Dokuseite}} <onlyinclude>Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text...' |
|||
| Line 12: | Line 12: | ||
== Benutzung == | == Benutzung == | ||
Diese Vorlage erwartet keine Parameter. Es reicht, wenn | Diese Vorlage erwartet keine Parameter. Es reicht, wenn du <code><noinclude><nowiki>{{Vorlagendokumentation}}</nowiki></noinclude></code> '''ans Ende einer Vorlage''' schreibst und die Dokumentationsseite <code><nowiki>[[<Seitenname>/doc]]</nowiki></code> erstellst. Nach dem Generieren der Dokumentation werden Erstellungshilfen bereitgestellt ''(preload).'' | ||
; /doc | ; /doc | ||
Revision as of 16:58, 24 November 2017
Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Seitenname>/doc]] 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 erwartet keine Parameter. Es reicht, wenn du <noinclude>{{Vorlagendokumentation}}</noinclude> ans Ende einer Vorlage schreibst und die Dokumentationsseite [[<Seitenname>/doc]] erstellst. Nach dem Generieren der Dokumentation werden Erstellungshilfen bereitgestellt (preload).
- /doc
<noinclude>{{Vorlagendokumentation/doc}}</noinclude>