Template:Documentation subpage/doc: Difference between revisions
Template:Documentation_subpage/doc&action
(Template:Documentation_subpage/doc&action) |
|||
| Line 4: | Line 4: | ||
{{tl|documentation subpage}} | {{tl|documentation subpage}} | ||
'''OR''' | '''OR''' | ||
{{tlx|documentation subpage| | {{tlx|documentation subpage|<nowiki>[[</nowiki><var>main page to link to</var><nowiki>]]</nowiki>}} | ||
=== Userboxes === | === Userboxes === | ||
| Line 10: | Line 10: | ||
{{tl|userbox documentation subpage}} | {{tl|userbox documentation subpage}} | ||
'''OR''' | '''OR''' | ||
{{tlx|userbox documentation subpage| | {{tlx|userbox documentation subpage|<nowiki>[[</nowiki><var>main userbox page to link to</var><nowiki>]]</nowiki>}} | ||
=== Customization of text === | === Customization of text === | ||
To manually change the text of the template, the " | 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: | Example usage: | ||
{{tlx|documentation subpage|text1 | {{tlx|documentation subpage|text1<nowiki>=</nowiki><var>custom first and second line text</var>}} | ||
{{tlx|documentation subpage|text2 | {{tlx|documentation subpage|text2<nowiki>=</nowiki><var>custom second line text only</var>}} | ||
{{tlx|documentation subpage|text1 | {{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 == | == How it is displayed == | ||
This template should be placed at the top of "/doc" pages. It changes output depending on where it is viewed: | 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 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 | * 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 == | == Functions == | ||
| Line 34: | Line 34: | ||
{{ Documentation/see also }} | {{ Documentation/see also }} | ||
<includeonly> | |||
<!-- categories and interwiki links --> | |||
[[Category:Template documentation| {{PAGENAME}}]] | [[Category:Template documentation| {{PAGENAME}}]] | ||
[[Category:Template namespace templates]] | [[Category:Template namespace templates]] | ||
| Line 86: | Line 86: | ||
[[ur:Template:Documentation subpage]] | [[ur:Template:Documentation subpage]] | ||
[[zh:模板:Template doc page viewed directly]] | [[zh:模板:Template doc page viewed directly]] | ||
</includeonly> | |||