Difference between revisions of "Template:Documentation"

From "PTTLink Wiki"
Jump to navigation Jump to search
en>Shirayuki
m
Line 1: Line 1:
−
{{tl|TOC right}} forces the auto-generated Table of Contents for an article to appear floated to the right side of the page, in order to improve article layout.
+
<noinclude>
 +
<languages/>
 +
</noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
 +
{{documentation|content=
  
−
== Usage ==
+
{{Lua|Module:Documentation}}
−
Insert <code>&#123;&#123;{{tl|TOC right}}&#125;&#125;</code> at the point in the article where you want the top of the Table of Contents box to appear. This should usually be after the text of the lead section, and just before the first section heading.  Use with {{tl|-}} or {{tl|clear}} to prevent collision with text; use the '''clear''' parameter (see below) to prevent collision with images.
+
<translate><!--T:12--> This template automatically displays a documentation box like the one you are seeing now, of which the content is sometimes transcluded from another page.</translate>
 +
<translate><!--T:13--> It is intended for pages which are [[<tvar name=1>Special:MyLanguage/Help:Transclusion</tvar>|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.</translate>
  
−
* Avoid placing the TOC in a visually poor location. Crossing a section division is probably a poor idea.
+
<translate>
 +
==Usage== <!--T:2-->
  
−
;width: Set the CSS width.
+
===Customizing display=== <!--T:3-->
  
−
;limit: Limits the depth of subheadings shown. For instance using <code>limit=4</code> will hide the fourth level and deeper subheadings in the hierarchy. And <code>limit=2</code> will hide all subheadings leaving only the main headings. This works by hiding the lower levels with CSS. See [[Template:TOC limit/styles.css]].
+
<!--T:4-->
 +
Overrides exist to customize the output in special cases:
 +
</translate>
 +
* <nowiki>{{</nowiki>documentation{{!}}'''heading'''=<nowiki>}}</nowiki> - <translate><!--T:5--> change the text of the "documentation" heading.</translate> <translate><!--T:10--> If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.</translate>
  
−
Do not place this template so that the TOC aligns with a large image or infobox; this breaks the layout on narrow screens (even users with screens as wide as 1024px wide can have problems). Also, a TOC that crosses a section division is probably a poor idea, if that can be avoided.
+
<translate>
 +
==Rationale== <!--T:6-->
 +
</translate>
 +
<translate><!--T:7--> This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links.</translate>
 +
<translate><!--T:8--> It also reduces server resources by circumventing a [[w:Wikipedia:Template limits|technical limitation of templates]] (see a [[<tvar name=1>:en:Special:Diff/69888944</tvar>|developer's explanation]]).</translate>
  
−
Unless the section in which the {{tl|TOC right}} is placed is long enough, the result may well be undesirable.
+
<translate>
 +
==See also== <!--T:9-->
 +
</translate>
 +
* <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate>
 +
* {{tim|Documentation}}
 +
* <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate>
  
−
It should only be used in cases where the TOC gets in the way of other content or is detrimental to the layout of the page; it should ''not'' simply be used for aesthetics since it tampers with the standard appearance of articles. See [[Help:Section#Floating the TOC]] for further guidelines.
+
}}
−
 
+
[[Category:Formatting templates{{#translation:}}|Template documentation]]
−
== See also ==
+
[[Category:Template documentation{{#translation:}}| ]]
−
* {{Lts|TOC left}}
+
</noinclude><includeonly>{{#if:{{{content|}}}|
−
 
+
[[Category:Template documentation pages{{#translation:}}]]
−
<includeonly>{{Sandbox other||
+
}}</includeonly>
−
 
 
−
<!--------ADD CATEGORIES BELOW THIS LINE-------->
 
−
{{DEFAULTSORT:Toc Right}}
 
−
[[Category:Wikipedia table of contents templates]]
 
−
}}</includeonly>  
 
−
<templatedata>
 
−
{
 
−
"params": {
 
−
"limit": {
 
−
"label": "Limit",
 
−
"description": "Limits the depth of subheadings shown. For instance using limit=4 will hide the fourth level and deeper subheadings in the hierarchy. And limit=2 will hide all subheadings leaving only the main headings. This works by hiding the lower levels with CSS",
 
−
"type": "number"
 
−
},
 
−
"clear": {
 
−
"label": "Clear",
 
−
"description": "Sets the CSS clear property, which forces this float underneath the side specified with this attribute. So, clear=right (which is the default) will place the element after all the right floating elements before it. Options are left, right, both, or none.",
 
−
"type": "string"
 
−
},
 
−
"width": {
 
−
"aliases": [
 
−
"1"
 
−
],
 
−
"label": "Width",
 
−
"description": "Overrides the CSS width"
 
−
}
 
−
},
 
−
"description": "{{TOC right}} forces the auto-generated \"Table of Contents\" for an article to appear floated to the right side of the page (as seen right), in order to improve article layout.",
 
−
"paramOrder": [
 
−
"clear",
 
−
"limit",
 
−
"width"
 
−
],
 
−
"format": "inline"
 
−
}
 
−
</templatedata>
 

Revision as of 03:20, 24 May 2021

<languages/>

[[Category:Template documentation pages{{#translation:}}]]

[[Category:Formatting templates{{#translation:}}|Template documentation]] [[Category:Template documentation{{#translation:}}| ]]

Retrieved from "http://wiki.pttlink.org/index.php?title=Template:Documentation&oldid=4136"