Vorlog:Dokumentation

Aus Wikipedia
Wexln zua: Navigation, Suach
Dokumentation

De Vurlog solltat bei ålle Vurlong Heagnomma werdn.

De Begryndung[VE | Weakln]

Wenn ma de Dokumentation vom Programmcode trent, håt ma a beßare Ywersichtlichkait.

Dea Hauptgrund is aber, dass da Parser weniga Afbatn muas: Bei jeda Åwendung låd da den gånzn Vurlagntext mit samt da Dokumentation aini und zum Schluss låßt da de Dokumentation sowiiso wiida weg. Trotzdem werdn <noinclude>s voa da richtign Eibindung ausgwertet, so dass ma dii „Pre-expand include size“ sagrisch drukkn ko, wenn ma de Dokumentationen in Untaseiten schraibt. Dåher soit dii Beschraibung immer aus da aigntlichn Vurlog ausglagert werdn. So kånn ma mehra Vurlong pro Artiklseitn nutzn.

So nimmt ma se her[VE | Weakln]

De Vurlog braucht koane Parameter. `S raicht, wenn ma <noinclude>{{Dokumentation}}</noinclude> ans End vo da Vurlog schraibt und dii entsprechende Dokumentationsseitn erstoit. A Untasaitn /Meta ko ma dann dii Metadatn fyr dii Vurlog enthoitn (hiazu bittschön den Abschnitt Besonderheitn lesn), ansonstn kenna de mit in dii noinclude-tags åm End vo da Vurlog platziert werdn. Zua den Metadatn gkearn de Kategorien und Interwikilinks. Nach `m Erststöin dea Dokumentation werdn oam Erstöllungshuifn ozoagt (preload).

In de Unterseitn san folgende Codezailn hintalegt, damit ma wiider zrukkkommt:

/Doku <noinclude>{{Dokumentation/Dokuseitn}}</noinclude>
/Meta <noinclude>{{Dokumentation/Metaseitn}}</noinclude><includeonly> … Meta … </includeonly>
/Test <noinclude>{{Dokumentation/Testseitn}}</noinclude>
/Wartung <noinclude>{{Dokumentation/Wartungsseitn}}</noinclude>

Besonderheitn[VE | Weakln]

Wenn dii Vurlog im Benutzanamensraum aibundn weard, werdn de Metadatn ned eibundn und weder de Vurlog, no de Unterseitn, werdn in Kategorien aisortiirt.

Untaseitn[VE | Weakln]

/Meta
A soiche Unterseitn is vorållem fyr vollgsperrte Seitn da, dii ansonstn ned interwikifiziirt werdn kenna.
/XML
Wenn de Vurlog nebn da Dokumentation no a XML-Beschreibung fyr `n Vurlognmaista håt, wead a entsprechenda Hinwais ausgebn (→ XML-Hinwais).
/Wartung
Soitats a es a Wartungsseitn fyr de Vurlog gebn, so wead ebenfois a Hinwais ausgeben (→ Wartungshinwais).
/Test
A Hinweis wead fyr Testuntaseitn ausgeben.

Untasein ålegn[VE | Weakln]

Wenn ma sai vector.css (oda monobook.css) um
.metadata { display:block !important; }
.metadata-inline { display:inline !important; }
erweitert, kriagt ma auf da Vurlognseitn mit Dokumentation Links zum eifacheren Anlegen bzw. Bearbatn dea Untasaitn åzoagt.