User:Lilyuserin/Vorlagendokumentation/doc

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search

Contact

Email Usertalk

This is a Wikimedia Commons user page. If you find this page on any site other than Wikimedia Commons, you are viewing a mirror site. Be aware that the page may be outdated, and that the user this page belongs to may have no personal affiliation with any site other than Wikimedia Commons itself. The original page is located at https://commons.wikimedia.org/wiki/User:Lilyuserin/Vorlagendokumentation/doc.

العربية ∙ azərbaycanca ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ čeština ∙ Deutsch ∙ Deutsch (Sie-Form) ∙ English ∙ Esperanto ∙ español ∙ فارسی ∙ suomi ∙ français ∙ Frysk ∙ galego ∙ עברית ∙ हिन्दी ∙ magyar ∙ հայերեն ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ ລາວ ∙ македонски ∙ മലയാളം ∙ Bahasa Melayu ∙ မြန်မာဘာသာ ∙ Nederlands ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ slovenščina ∙ shqip ∙ svenska ∙ ไทย ∙ Tagalog ∙ Türkçe ∙ українська ∙ Tiếng Việt ∙ 简体中文 ∙ 繁體中文 ∙ 正體中文（臺灣） ∙ +/−

Wikimedia Commons
Wikimedia Commons

Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Seitenname>/doc]] ein.

Begründung

[edit]

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

[edit]

Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <noinclude>{{Dokumentation}}</noinclude> ans Ende einer Vorlage schreibt und die Dokumentationsseite [[<Seitenname>/doc]] erstellt. Nach dem Generieren der Dokumentation werden Erstellungshilfen bereitgestellt (preload).

In den Unterseiten stellen folgende Codezeilen den Rückbezug sicher:

/doc
<noinclude>{{Dokumentation/doc}}</noinclude>
/Test
<noinclude>{{Dokumentation/Testseite}}</noinclude>
/Wartung
<noinclude>{{Dokumentation/Wartungsseite}}</noinclude>
/Editnotice
<noinclude>{{Dokumentation/Editnoticeseite}}</noinclude>
/Unterseite
<noinclude>{{Dokumentation/Unterseite}}</noinclude>

Unterseiten

[edit]
/Wartung
Sollte es eine Wartungsseite für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben.
/Test
Ein Hinweis wird auch für Testunterseiten ausgegeben.
/Editnotice
Ein spezieller Hinweis, der beim Bearbeiten angezeigt wird.

Unterseiten anlegen

[edit]
Unterseiten
Links auf diese Seite
Alle Lilyuserin-Seiten
Retrieved from "https://commons.wikimedia.org/w/index.php?title=User:Lilyuserin/Vorlagendokumentation/doc&oldid=265200574"