Sjabloon:Documentation/doc: verschil tussen versies

Uit Touhou Wiki
Naar navigatie springen Naar zoeken springen
(Nieuwe pagina aangemaakt met '{{Documentation subpage}} <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE YOU CAN EDIT THE TEMPLATE DOCUMENTATION BELOW THIS COMMENT --...')
 
kGeen bewerkingssamenvatting
 
(3 tussenliggende versies door 2 gebruikers niet weergegeven)
Regel 1: Regel 1:
{{Documentation subpage}}
<noinclude>
<!--
{{documentation subpagina|Documentation}}
    PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE
</noinclude>
    YOU CAN EDIT THE TEMPLATE DOCUMENTATION BELOW THIS COMMENT
Dit is de {{tl|documentation}} sjabloon.
-->
This is the {{tl|documentation}} template.


This template displays a green doc box like you are seeing now, and automatically loads the content from a /doc subpage. It can also load the content from other places if instructed to.
Deze sjabloon laat een groene box zien (zoals deze) en haalt autmatisch content van een /doc subpagina. Dit kan ook gehaald worden van andere pagina's.


This template is intended for documenting templates and other pages which are [[Wikipedia:Transclusion|transcluded]] onto other pages. It can be used in template space and most other namespaces.
Deze sjabloon is vooruitsluitend bedoelt voor documentatie van sjablonen.


Use of this template allows templates to be protected where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.
===Gebruik===
Gebruikelijk is het om dit zonder enige parameters te gebruiken. Dit moet op deze manier:
<code>&lt;noinclude&gt;</code>:


===Usage===
<pre><!--Laatste lijn van de sjabloon code--><noinclude>
Normally this template is used without any parameters, placed at the bottom of the template or page being documented, within <code>&lt;noinclude&gt;</code>:
 
<pre><!--Last line of your template code--><noinclude>
{{documentation}}
{{documentation}}
<!-- Add categories and interwikis to the /doc subpage, not here! -->
</noinclude></pre>
</noinclude></pre>


Then this template automatically loads the content from the /doc subpage of the template it is used on.
Hiermee word alles wat er op de /doc subpagina staat geladen en op de pagina geplaatst.


This template can also load the content from any other page. Like this:
Het kan ook ergens anders vandaan worden gehaald. Op deze manier:


<pre><!--Last line of your template code--><noinclude>
<pre><!--Laatste lijn van de sjabloon code--><noinclude>
{{documentation|Template:Other page/doc}}
{{documentation|Sjabloon:Andere pagina/doc}}
</noinclude></pre>
</noinclude></pre>


Note that when loading the documentation from another page than the local /doc page it becomes tricky to handle the categories and interwiki links.
Je kan ook direct tekst invoeren. Op deze manier:
 
<pre><!--Laatste lijn van de sjabloon code--><noinclude>
The content can also be fed directly as text. Like this:
 
<pre><!--Last line of your template code--><noinclude>
{{documentation
{{documentation
| content = Some documentation text.
| content = Tekst hier.
}}
}}
</noinclude></pre>
</noinclude></pre>
Regel 60: Regel 53:
===The heading===
===The heading===
When in Template space this template shows this heading:
When in Template space this template shows this heading:
:[[File:Template-info.png|32px]] '''Template documentation'''
:'''Template documentation'''


In most other namespaces, such as "Wikipedia:", it shows this heading:
In most other namespaces, such as "Wikipedia:", it shows this heading:
Regel 89: Regel 82:
===Automatic functions===
===Automatic functions===
If the documentation page doesn't exist, the [create] link includes a [[mw:Manual:Creating pages with preloaded text|preload]] page so that clicking it will pre-fill the edit form with the basic documentation page format. Preload text is also used for the /sandbox and /testcases <small>(create)</small> links.
If the documentation page doesn't exist, the [create] link includes a [[mw:Manual:Creating pages with preloaded text|preload]] page so that clicking it will pre-fill the edit form with the basic documentation page format. Preload text is also used for the /sandbox and /testcases <small>(create)</small> links.
When this template is on a protected template page it now automatically adds {{tl|pp-template}} which shows the grey or red padlock in the top right corner. So no need to manually add {{tlf|pp-template}} to templates that use {{tl|documentation}}.
When this template is on a /sandbox subpage it automatically adds the {{tl|template sandbox notice}}.


===Subject space vs talk space===
===Subject space vs talk space===
Regel 109: Regel 98:


===Technical details===
===Technical details===
This template calls {{tl|documentation/start box2}} and {{tl|documentation/end box2}} which in turn call {{tl|documentation/start box}} and {{tl|documentation/end box}}. /start box (and /end box) hold most of the code, while this template and /start box2 (and /end box2) do parameter preprocessing.
Deze sjabloon haalt {{tl|documentation/start box2}} en {{tl|documentation/end box2}} wie beide ook weer {{tl|documentation/start box}} en {{tl|documentation/end box}} halen. /start box (en /end box) gebruiken de meeste codering, terwijl deze sjabloon en /start box2 (en /end box2) de voorbewerking doen.
 
The preload page for the /doc [create] link is [[Template:Documentation/preload]], but in File space it is [[Template:Documentation/preload-filespace]]. The preload pages for the /sandbox and /testcases <small>(create)</small> links are [[Template:Documentation/preload-sandbox]] and [[Template:Documentation/preload-testcases]].
 
<!-- For more technical details see the [[Template talk:Documentation|talk page]]. -->


===See also===
===See also===
<!-- {{documentation/see also}} -->
*{{tl|documentation subpagina}} – Gebruikt op de bovenkant van de /doc van een sjabloon.
*{{tl|documentation}} – Placed on templates and other pages to document them.
*{{tl|documentation subpage}} – Used at the top of /doc subpages to explain what they are and to link back to the page they document.
*[[Wikipedia:Template documentation]] – The how-to guide about template documentation.
*[[Wikipedia:Template test cases]] – How to use /sandbox and /testcases subpages and more about template testing.<includeonly>


<!--PLEASE ADD INTERWIKIS BELOW THIS LINE, THANKS.-->
[[de:Vorlage:Documentation]]
[[de:Vorlage:Documentation]]
[[es:Plantilla:Documentation]]
[[es:Plantilla:Documentation]]
Regel 132: Regel 112:
[[zh:模板:Documentation]]
[[zh:模板:Documentation]]
<!--PLEASE ADD CATEGORIES BELOW THIS LINE, THANKS.-->
<!--PLEASE ADD CATEGORIES BELOW THIS LINE, THANKS.-->
[[Category:Template documentation| ]]
[[Category:Sjablonen| ]]
</includeonly>
</includeonly>

Huidige versie van 24 mrt 2012 om 17:40

Dit is een subpagina van het sjabloon genaamd Sjabloon:Documentation.

Dit is de {{documentation}} sjabloon.

Deze sjabloon laat een groene box zien (zoals deze) en haalt autmatisch content van een /doc subpagina. Dit kan ook gehaald worden van andere pagina's.

Deze sjabloon is vooruitsluitend bedoelt voor documentatie van sjablonen.

Gebruik

Gebruikelijk is het om dit zonder enige parameters te gebruiken. Dit moet op deze manier: <noinclude>:

<!--Laatste lijn van de sjabloon code--><noinclude>
{{documentation}}
</noinclude>

Hiermee word alles wat er op de /doc subpagina staat geladen en op de pagina geplaatst.

Het kan ook ergens anders vandaan worden gehaald. Op deze manier:

<!--Laatste lijn van de sjabloon code--><noinclude>
{{documentation|Sjabloon:Andere pagina/doc}}
</noinclude>

Je kan ook direct tekst invoeren. Op deze manier:

<!--Laatste lijn van de sjabloon code--><noinclude>
{{documentation
| content = Tekst hier.
}}
</noinclude>

When the content parameter is used the doc box normally doesn't show the [edit] [purge] links in the top right corner. Note that if the /doc page exists a link to it is still shown in the link box below the doc box.

But parameter 1 and the content parameter can also be combined, like this:

<!--Last line of your template code--><noinclude>
{{documentation
| 1 = Template:Any page/doc
| content = {{Template:Any page/doc|parameters}}
}}
</noinclude>

Then the pagename fed as parameter 1 is used for the [edit] [purge] links and for the /doc link in the link box below the doc box. But the content parameter is used for the content shown in the doc box. The above code means that the content is transcluded as "{{Template:Any page/doc|parameters}}". In this example a parameter is also fed to the /doc page being loaded.

Best practice

The code should be added at the bottom of the template code, with no space before "<noinclude>" (which would cause extra space on pages where the template is used).

Categories and interwiki links that apply to the template itself should be added to the bottom of the /doc subpage, inside <includeonly></includeonly> tags.

If the documentation page contains <includeonly> or <noinclude> tags as part of the visible documentation text, replace the "<" with "&lt;".

The heading

When in Template space this template shows this heading:

Template documentation

In most other namespaces, such as "Wikipedia:", it shows this heading:

Documentation

But when on File (image) pages it shows this heading:

Summary

The heading parameter can be used to set the heading to something else. Like this:

{{documentation|heading =Infobox documentation}}

If the heading parameter is empty but defined, no heading is shown and no [edit] [purge] links are shown. Like this:

{{documentation|heading =}}

The heading-style parameter can be fed optional CSS values. Without quotation marks " " but with the ending semicolons ;. For example:

heading-style = color: red; font-size: 150%;

The link box

Below the big doc box is a small link box that shows some meta-data about the documentation. The link box shows different things depending on what parameters are fed to this template, and in which namespace it is used. In some cases the link box is not shown at all.

To hide the link box, add the parameter "|link box=off".

You can also insert customised text in the link box, by defining the |link box= parameter. For example:

|link box=This documentation is automatically generated by [[Template:Country showdata]]

Automatic functions

If the documentation page doesn't exist, the [create] link includes a preload page so that clicking it will pre-fill the edit form with the basic documentation page format. Preload text is also used for the /sandbox and /testcases (create) links.

Subject space vs talk space

Terminology: Subject space is the opposite of talk space. For instance "Template:" is the subject space of "Template talk:".

This template is usually placed in subject space, within <noinclude> tags. But in some cases this template needs to be on the talkpage:

  • In MediaWiki space, since <noinclude> often doesn't work in system messages and since MediaWiki space needs to be kept clean for performance reasons.

When placed on talkpages this template usually is placed near the top of the page and without <noinclude> tags.

The /doc, /sandbox and /testcases pages should normally be in subject space, except in the namespaces that don't have the MediaWiki subpage feature enabled: Main, File, MediaWiki and Category. (But currently we only show the /sandbox and /testcases links from User, User talk, Template and Template talk space.) There are also a whole bunch of other technical reasons why the /doc page must be stored under the talkpage for those namespaces.

This template automatically points its create links for the /doc, /sandbox and /testcases to the right namespace.

Technical details

Deze sjabloon haalt {{documentation/start box2}} en {{documentation/end box2}} wie beide ook weer {{documentation/start box}} en {{documentation/end box}} halen. /start box (en /end box) gebruiken de meeste codering, terwijl deze sjabloon en /start box2 (en /end box2) de voorbewerking doen.

See also

</includeonly>