« Modèle:Documentation subpage/doc » : différence entre les versions

De Adadov.net wiki
Page créée avec « {{Documentation subpage}} __NOTOC__ == Usage == : {{tlx|Documentation subpage}} : or : {{tlx|Documentation subpage |[[{{var|Page where the documentation Wikipedi... »
 
Aucun résumé des modifications
Ligne 4 : Ligne 4 :
: or
: or
: {{tlx|Documentation subpage |[[{{var|Page where the documentation [[Wikipedia:Transclusion|transcluded]]}}]]}}
: {{tlx|Documentation subpage |[[{{var|Page where the documentation [[Wikipedia:Transclusion|transcluded]]}}]]}}
===Userbox documentation===
To set this template to use "userbox" and "userbox page" rather than "{{lc:{{ns:Template}}}}" and "{{lc:{{ns:Template}}}} page" or "{{lc:{{ns:User}}}} template" and "{{lc:{{ns:User}}}} template page", use:
: {{tlx|Userbox documentation subpage}}
: or
: {{tlx|Userbox documentation subpage |[[{{var|userbox page}}]]}}
===Text customization===
The parameters {{para|text1}} and/or {{para|text2}} can be used to set the text of, respectively, the template's first and second lines. If ''text1'' is set but not ''text2'', both lines' text will derive from ''text1'':
{{Hidden begin |showhide=left |title=With ''text1'' and ''text2''}}
<code><nowiki>{{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}</nowiki></code>
{{Documentation subpage |[''page''] |text1='''''text1 appears here''''' |text2='''''text2 appears here''''' |override={{lc:{{SUBPAGENAME}}<!-- Hack to allow example to appear, even when viewed from [[Template:Documentation subpage]] -->}}}}
{{Hidden end}}
{{Hidden begin |showhide=left |title=With ''text2'' only}}
<code><nowiki>{{Documentation subpage |text2='''''text2 appears here'''''}}</nowiki></code>
{{Documentation subpage |[''page''] |text2='''''text2 appears here''''' |override={{lc:{{SUBPAGENAME}}<!-- Hack to allow example to appear, even when viewed from [[Template:Documentation subpage]] -->}}}}
{{Hidden end}}
{{Hidden begin |showhide=left |title=With ''text1'' only}}
<code><nowiki>{{Documentation subpage |text1='''''text1 appears here'''''}}</nowiki></code>
{{Documentation subpage |[''page''] |text1='''''text1 appears here''''' |override={{lc:{{SUBPAGENAME}}<!-- Hack to allow example to appear, even when viewed from [[Template:Documentation subpage]] -->}}}}
{{Hidden end}}


== Display ==
== Display ==
Ligne 33 : Ligne 12 :
== Functions ==
== Functions ==
In addition to its message, the template adds pages to [[:Category:Template documentation pages]], [[:Category:User documentation pages]], or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the [[m:Help:Categories#Sort order|sort key]] to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".
In addition to its message, the template adds pages to [[:Category:Template documentation pages]], [[:Category:User documentation pages]], or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the [[m:Help:Categories#Sort order|sort key]] to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".
== See also ==
{{Documentation/see also}}


<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
| <!--Categories below here, please; interwikis to Wikidata.-->
| <!--Categories below here, please; interwikis to Wikidata.-->
[[Category:Template documentation| ]]
[[Category:Documentation des modèles| ]]
[[Category:Template namespace templates]]
 
[[tn:Template:Documentation subpage]]
[[tn:Template:Documentation subpage]]
}}</includeonly>
}}</includeonly>

Version du 6 février 2015 à 04:48

Usage

{{Documentation subpage}}
or
{{Documentation subpage |[[Page where the documentation transcluded]]}}

Display

This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed:

  • On a /doc page, it displays a box explaining template documentation and links to the template page.
  • On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself (which contains {{Documentation}}) will automatically note that the documentation is transcluded from a subpage.

Functions

In addition to its message, the template adds pages to Category:Template documentation pages, Category:User documentation pages, or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".