Difference between revisions of "Hilfe:Dokumentation/doc"

From VoWi
Jump to navigation Jump to search
(Die Seite wurde neu angelegt: {{Dokumentation/Unterseite}} {{WIP}} Seiten in dem Zusammenhang: * Vorlage:TemplateDokumentation * Vorlage:TemplateDokumentation/docname * [[Vorlage:Vorlage Un...)
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Dokumentation/Unterseite}}
{{Dokumentation/Unterseite}}
{{WIP}}


Seiten in dem Zusammenhang:
Das VorlesungsWiki verwendet ein auf den ersten Blick kompliziertes System zur Dokumentation, welches stark an das der englischen Wikipedia angelehnt ist, viele Vorlagen wurden auch fast 1:1 kopiert.
* [[Vorlage:TemplateDokumentation]]
=== Anwendung ===
* [[Vorlage:TemplateDokumentation/docname]]
Willst du eine Dokumentationsseite schreiben musst du nur die [[Vorlage:Dokumentation]] einbinden.
* [[Vorlage:Vorlage Unterseite]]
<nowiki>{{Dokumentation}}</nowiki>
* [[Vorlage:TemplateDokumentation/preload]]


=== Usage ===


=== See also ===
Wenn es sich bei der zu dokumentierenden Seite um eine Vorlage handelt, musst du sie zusätzlich in noinclude-tags fassen:
<pre><nowiki>
<includeonly>Dies ist der Text, der eingebunden wird</includeonly><noinclude>
{{Dokumentation}}</noinclude>
</nowiki></pre>


<includeonly>
Durch die Verwendung der [[Vorlage:Dokumentation]] wird automatisch die Unterseite [[/doc]] in einem blauen Rahmen eingebunden.
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->


</includeonly>
=== Technische Funktionsweise ===
Im Wesentlichen sind nur einige wenige Vorlagen für die Dokumentation relevant:
; [[Vorlage:Dokumentation]] : Macht den blauen Rahmen und bindet die /doc-Unterseite ein
; [[Vorlage:Dokumentation/docname]] : Wird auch irgendwie gebraucht.
; [[Vorlage:Dokumentation/Unterseite]] : Wird die /doc-Unterseite direkt angesehen, wird dieser Warnhinweis angezeigt.
; [[Vorlage:Dokumentation/Vorlage]] : Erstellt jemand (mittels dem Button, den der blaue Rahmen anzeigt) eine neue /doc-Unterseite, enthält die neue Seite automatisch diesen Text.

Latest revision as of 11:01, 10 July 2008

Dies ist die Dokumentation für die Dokumentation-Vorlage. Um die Dokumentation zu bearbeiten, editiere diese Seite, die Vorlage selber findest du unter Hilfe:Dokumentation. Falls du dich für das System zur Dokumentation von Vorlagen interessierst, siehe bitte Hilfe:Vorlagendokumentation.

Das VorlesungsWiki verwendet ein auf den ersten Blick kompliziertes System zur Dokumentation, welches stark an das der englischen Wikipedia angelehnt ist, viele Vorlagen wurden auch fast 1:1 kopiert.

Anwendung[edit]

Willst du eine Dokumentationsseite schreiben musst du nur die Vorlage:Dokumentation einbinden.

{{Dokumentation}}


Wenn es sich bei der zu dokumentierenden Seite um eine Vorlage handelt, musst du sie zusätzlich in noinclude-tags fassen:

 <includeonly>Dies ist der Text, der eingebunden wird</includeonly><noinclude>
 {{Dokumentation}}</noinclude>

Durch die Verwendung der Vorlage:Dokumentation wird automatisch die Unterseite /doc in einem blauen Rahmen eingebunden.

Technische Funktionsweise[edit]

Im Wesentlichen sind nur einige wenige Vorlagen für die Dokumentation relevant:

Vorlage:Dokumentation
Macht den blauen Rahmen und bindet die /doc-Unterseite ein
Vorlage:Dokumentation/docname
Wird auch irgendwie gebraucht.
Vorlage:Dokumentation/Unterseite
Wird die /doc-Unterseite direkt angesehen, wird dieser Warnhinweis angezeigt.
Vorlage:Dokumentation/Vorlage
Erstellt jemand (mittels dem Button, den der blaue Rahmen anzeigt) eine neue /doc-Unterseite, enthält die neue Seite automatisch diesen Text.