Template:Tochide/Documentation: Difference between revisions

Revision as of 03:27, 26 January 2014

This template uses collapsible <div> elements to hide large lists on guide tables of contents. This template is useful for making a more compact, easy to read table of contents that doesn't take up a large amount of space when using the "show/hide" function on Header and Footer Navs. The <div> elements are collapsed by default on every page but the Table of Contents to ensure that users without JavaScript will be able to access a full ToC (by clicking the Table of Contents link in the Header Nav).

Usage

The template takes one parameter:

The title shown in the blue bar at the top.

Please use plain text or links in the title, instead of heading templates (don't use {{h2}} or {{h3}}). In the contents, use normal markup as you would elsewhere on the page, such as the {{col}} template, heading templates or lists.

Examples

{{tochide|Title}}Contents{{tochide}}

Title

Contents

@@ Line 2: / Line 2: @@
 ==Usage==
-The template takes two parameters:
+The template takes one parameter:
 # The title shown in the blue bar at the top.
-# The hidden contents below.
-Please use plain text or links in the title, instead of heading templates (don't use {{t|h2}} or {{t|h3}}). In the contents, use normal markup as you would elsewhere on the page, such as the {{t|col}} template, heading templates or lists. Note that the parameters will have to be explicitly defined if using element attributes or other uses of the equal sign (=). You may encounter this when splitting an ordered list between columns where you need to use the <tt>start</tt> parameter. In this case you would put <tt>2=</tt>''contents'' instead of just the contents without a parameter name.
+Please use plain text or links in the title, instead of heading templates (don't use {{t|h2}} or {{t|h3}}). In the contents, use normal markup as you would elsewhere on the page, such as the {{t|col}} template, heading templates or lists.
 ==Examples==
-<pre>{{tochide|Title|Contents}}</pre>
+<pre>{{tochide|Title}}Contents{{tochide}}</pre>
-{{tochide|Title|Contents}}
+{{tochide|Title}}Contents{{tochide}}
-<pre>{{tochide|Title|2=Contents with an = sign}}</pre>
-{{tochide|Title|2=Contents with an = sign}}
 <noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>