PsychonautWiki Archive

Template:Documentation subpage/doc: Difference between revisions

← Older edit
iw>Funandtrvl
fx
>Obongo
Fix/remove redlink(s)
 
(12 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{documentation subpage}}
{{TemplateBox
__NOTOC__
|1=1
== Usage ==
|1d=
{{tl|documentation subpage}}
{{LangSwitch
'''OR'''
|bar=Is da Parametar aufm Weat „override“ gsetzt, wead de Vurlog ozoagt. Dea Weat wead heagnomma, wenn de Dokumentazionsuntaseitn ned „/doc“ is.
{{tlx|documentation subpage|<nowiki>[[</nowiki><var>main page to link to</var><nowiki>]]</nowiki>}}
|de=Ist der Parameter auf den Wert „override“ gesetzt, wird diese Vorlage angezeigt. Dieser Wert wird benutzt, wenn die Dokumentationsunterseite nicht „/doc“ ist.
|ca=Si es posa com a “override“, permet forçar la visualització d'aquesta plantilla. S'ha d'emprar només si la pàgina de documentació no finalitza en « /doc ».
|en=If set to “override”, allows to force the display of this template. Use only if the documentation page does not end in „/doc“.
|fr=Si passé comme « override », permet de forcer l’affichage de ce modèle. N’utiliser que si la page de documentation page ne se termine pas en « /doc ».
}}
|1def=
|1stat=optional
|2=page
|2d=
{{LangSwitch
|bar=Ganza Seitnnama vo da Vurlog, zu dea de Beschraibung kheardt. Dea Parametar wead nua heagnomma, wenn de Dokumentazionsseitn koa Untaseitn vo da Vurlog is, zu dea de Beschraibung kheardt.
|ca= Nom complet de la pàgina on es descriu la plantilla. Utilitzar només si la pàgina de documentació no és una subpágina de la plantilla descrita.
|de=Ganzer Seitenname der beschriebenen Vorlage. Diser Parameter wird nur verwendet, wenn die Dokumentationsseite keine Unterseite der beschriebenen Vorlage ist.
|en=Full page name of the described template. Use only if the documentation page is not a subpage of the described template.
|fr=Nom de page complet du modèle décrit. N’utiliser que si la page de documentation n’est pas une sous-page du modèle décrit.
}}
|2def=
|2stat=optional
|name=Documentation subpage
|desc=
{{LangSwitch
|bar=De Vurlog <code><nowiki>{{documentation subpage}}</nowiki></code> wead an ålle Vurlogn-Dokumentazionsseitn oben hiigschriibn. De Vurlog muas ned in &lt;noinclude&gt; definiirt weadn, då de Vurlog nua auf de Untaeitn „/doc“-Seiten ozoagt werdn.
* Wenn de Untaseitn an andern Nama hådt ois „doc“, muas <code><nowiki>{{documentation subpage|override}}</nowiki></code> heagnomma werdn.
* Wenn se de Vurlognseitn vom Basisnama dea Seitn untaschaidet, muas <code><nowiki>{{documentation subpage|page=</nowiki>''Template:Example''<nowiki>}}</nowiki></code> heagnomma werdn.
|de=Die Vorlage <code><nowiki>{{documentation subpage}}</nowiki></code> wird an allen Vorlagen-Dokumentationsseiten oben angebracht. Die Vorlage muss nicht in &lt;noinclude&gt; definiert werden, da die Vorlage nur auf den Unterseiten „/doc“-Seiten angezeigt werden.
* Wenn die Unterseite anders benannt ist als „doc“, muss <code><nowiki>{{documentation subpage|override}}</nowiki></code> benutzt werden.
* Unterscheidet sich die Vorlageseite vom Basisnamen der Seite, muss <code><nowiki>{{documentation subpage|page=</nowiki>''Template:Example''<nowiki>}}</nowiki></code> verwendet werden.
|en=Place <code><nowiki>{{documentation subpage}}</nowiki></code> at the top of all template documentation subpages. It does not need to be in &lt;noinclude&gt; tags because it will only show up on “/doc” subpages.
* If the subpage is named something other than “/doc”, use <code><nowiki>{{documentation subpage|override}}</nowiki></code>.
* If the template page is different from the base page name, use <code><nowiki>{{documentation subpage|page=</nowiki>''Template:Example''<nowiki>}}</nowiki></code>.
|fr=Placez <code><nowiki>{{documentation subpage}}</nowiki></code> en haut des sous-pages de documentation de modèle. Il n’est pas nécessaire de le placer dans des balises &lt;noinclude&gt; car il n’apparaître que sur les sous-pages nommées « /doc ».
* Si le nom de la sous-page se termine en autre chose que « /doc », utilisez <code><nowiki>{{documentation subpage|override}}</nowiki></code>.
* Si la page du modèle décrit est différente du nom de la page de base, utilisez <code><nowiki>{{documentation subpage|page=</nowiki>''Template:Exemple''<nowiki>}}</nowiki></code>.
}}
|namespace=Template
|usergroup=all
|placement=top
|usage-notes=
|type=documentation
|example=
|i18n-method=autotranslate
|i18n-desc=
|i18n-mediawiki-msg=
|seealso=[[wikipedia:Template:Documentation]] <!--
-->{{LangSwitch|
|bar=(zua Dårstellung wia de Vurlog heagnomma wird)
|de=(zur Darstellung wie die Vorlage benutzt wird)
|en=(for how this template is used)
|fr=(pour le guide d'utilisation de ce modèle)
}}
|setscats=
|lines=multi
|shorthand=
|relieson=
}}<includeonly>


=== Userboxes ===
[[Category:Autotranslated templates|{{PAGENAME}}]]
When used to document usage of a [[Wikipedia:Userboxes|userbox]], it may be preferred to have this template state "userbox"/"userbox page" instead of "{{lc:{{ns:Template}}}}"/"{{lc:{{ns:Template}}}} page" or "{{lc:{{ns:User}}}} template"/"{{lc:{{ns:User}}}} template page". If this is preferred, use:
[[Category:Template namespace templates|{{PAGENAME}}]]
{{tl|userbox documentation subpage}}
'''OR'''
{{tlx|userbox documentation subpage|<nowiki>[[</nowiki><var>main userbox page to link to</var><nowiki>]]</nowiki>}}
 
=== Customization of text ===
To manually change the text of the template, the "<code>text1=<var>your text here</var></code>" and/or "<code>text2=<var>your other text here</var></code>" parameters can be specified. "<code>text1=</code>" changes the automatic text on the first line to your own word(s). "<code>text2=</code>" changes the automatic text on the second line to your own word(s). If "<code>text1=</code>" parameter is specified without the "<code>text2=</code>" parameter, both the first and second line of text will be custom based on the text given in the "<code>text1=</code>" parameter.
 
Example usage:
{{tlx|documentation subpage|text1<nowiki>=</nowiki><var>custom first and second line text</var>}}
 
{{tlx|documentation subpage|text2<nowiki>=</nowiki><var>custom second line text only</var>}}
 
{{tlx|documentation subpage|text1<nowiki>=</nowiki><var>custom first line text</var>|text2<nowiki>=</nowiki><var>custom second line text</var>}}
 
== How it is displayed ==
This template should 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 (ie, pages transcluding the "/doc" page), the template will not show. The template page itself (which contains <code>{{tl|Documentation}}</code>) will automatically note that the documentation is [[Wikipedia:Transclusion|transcluded]] from a subpage.
 
== Functions ==
In addition to the output message, the template categorizes 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 (ie, "Foo" on "Template:Foo", so it would be sorted in categories under 'F').
 
== See also ==
{{Documentation/see also}}
 
<includeonly>
<!-- categories and interwiki links -->
[[Category:Template documentation| ]]
[[Category:Template namespace templates]]
 
[[tn:Template:Documentation subpage]]
</includeonly>
</includeonly>
Retrieved from "http://psy.st/wiki/Template:Documentation_subpage/doc"