Anonymous user
Template:Compact TOC/doc: Difference between revisions
no edit summary
(|{{PAGENAME}}) |
No edit summary |
||
| (20 intermediate revisions by 7 users not shown) | |||
Line 1:
{{Documentation subpage}}
<!--
PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE
-->
{{Intricate template}}
__TOC__
Line 16 ⟶ 20:
'''For maximum number of features and centered placement''' (leave off a parameter or change it to blank or "no" to disable a feature
<code><nowiki>{{</nowiki>'''CompactTOC8'''|side=yes|center=yes|right=|nobreak=yes|top=yes|num=yes|sym=yes|symnum=|seealso=yes|refs=yes|notes=yes|extlinks=yes<nowiki>}}</nowiki></code>▼
|name=
|side=yes
|center=yes
|right=
|align=center
▲<br /><nowiki>}}</nowiki></code>
|nobreak=yes
|top=yes
|num=yes
|sym=yes
|symnum=
|custom1=
|custom2=
|custom3=
|seealso=yes
|notesfirst=
|refs=yes
|notes=yes
|extlinks=yes
|a=
...
|z=
}}</code>
===Parameters===
*<code>name=</code> — change the heading to an alternative name instead of "Contents", or hide it completely by entering <code>name=no</code>
*<code>side=yes</code> — put the "Contents" heading on the left side with a colon, instead of the top without one
*<code>center=yes</code> — center to ToC in the horizontal middle of the page, instead of floated left
*<code>right=yes</code> — align the ToC horizontally to the right of the page (may require <code><nowiki><br style="clear:right;" /></nowiki></code> after it, depending on page layout), instead of floated left (this parameter is mutually exclusive with the "center" option above, and should be used sparingly and with good reason)
*<code>align=</code> — sets the alignment of the ''links'' inside the table; default is left; use <code>center</code>, <code>right</code> or <code>left</code>
*<code>nobreak=yes</code> — no linebreak between the A-B-C-etc. stuff and the See also/References/etc. stuff (note: does not affect the heading; use <code>side=</code> for that)
*<code>top=yes</code> — enable the "Top" link; this is only useful if this copy of the ToC is
*<code>sym=yes</code> — enable the "!$@" link for symbolic entries section
*<code>num=yes</code> — enable the "0–9" link for numeric entries section (
*<code>symnum=yes</code> — enable the "!–9" link for combined symbolic and numeric entries section (
*<code>custom1</code>, <code>custom2</code> and <code>custom3</code> — add up to 3 extra "custom" sections at the end of the list (alternatively <code>Sec1, Sec2, Sec3</code>)
*<code>seealso=yes</code> — enable link to the "See also" section
*<code>refs=yes</code> — enable link to the "References" section (
*<code>notes=yes</code> — enable link to the "Notes" section (
*<code>notesfirst=yes</code> — enable link to the "Notes" section, but placed before "References"; ''do not use with <code>notes</code>'' (and do observe that it is plural)
*<code>extlinks=yes</code> — enable link to the "External links" section
*<code>a=</code> through <code>z=</code> — individually disable particular letters that have no entries. ''Use with caution'' and check regularly to make sure that new entries do not require the removal of this parameters. Can also be used to create range links, e.g. "X-Z". ''(See [[#Letters]] below for more detailed documentation of this feature.)''
====Letters====
Any letter can be deleted (i.e. because it has no entries in the list) by adding it as a '''lower case''' blank parameter
Or it can be replaced with an unlinked letter by using that letter ('''upper case'''):
''Note:'' It is often better to create an empty placeholder span (e.g. <code><nowiki><span id="Q" /></nowiki></code> where the letter's heading would be in the page if it existed, since in most cases it is quite possible that it will come to exist in the future.
This feature can also be used to create range links:
{{tlx|CompactTOC8|
{{CompactTOC8|side=yes|x=[[#X-Z|X-Z]]|y=|z=}}
====Shorthand====
* <code>short1</code> can be used as the very first parameter (before <code>name=</code>) for shortening a common usage:
{{tlx|CompactTOC8|short1}}
{{CompactTOC8|short1}}
It replaces <NOWIKI>{{CompactTOC8|side=yes|center=yes|nobreak=yes|refs=yes}}</NOWIKI>
===Examples===
Line 45 ⟶ 99:
{{tlx|CompactTOC8|name=no|center=yes|top=yes|
{{CompactTOC8|name=no|center=yes|top=yes|seealso=yes|notes=yes|custom1=New section|custom2=Additional section}}
{{tlx|CompactTOC8|side=yes|sym=yes|num=yes|refs=yes|seealso=yes|sec1=Other}}
{{CompactTOC8|side=yes|
▲{{tlx|CompactTOC8|side=yes|sym=yes|num=yes|refs=yes}}
▲{{CompactTOC8|side=yes|sym=yes|num=yes|refs=yes}}
{{tlx|CompactTOC8|name=Directory|top=no|refs=yes|notes=yes|extlinks=yes}}
{{CompactTOC8|name=Directory|top=no|refs=yes|notes=yes|extlinks=yes}}
▲{{tlx|CompactTOC8|top=no|refs=yes|notes=yes|extlinks=yes}}
▲{{CompactTOC8|top=no|refs=yes|notes=yes|extlinks=yes}}
{{tlx|CompactTOC8|name=no|side
{{CompactTOC8|name=no|side=yes|right=yes|symnum=yes|seealso=yes}}<br style="clear:right;" />
▲{{tlx|CompactTOC8|side=yes|right=yes|symnum=yes|seealso=yes}}
▲{{CompactTOC8|side=yes|right=yes|symnum=yes|seealso=yes}}<br style="clear:right;" />
▲<code><nowiki>{{</nowiki>'''CompactTOC8'''<nowiki>|
{{CompactTOC8|short1|num=yes|sym=yes|seealso=yes|notesfirst=yes|extlinks=yes}}
<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
▲{{CompactTOC8|side=yes|center=yes|nobreak=yes|top=yes|num=yes|sym=yes|seealso=yes|refs=yes|notes=yes|extlinks=yes}}
▲[[Category:Templates using ParserFunctions|{{PAGENAME}}]]
[[nl:Sjabloon:CompactTOC8]]
[[sl:Predloga:CompactTOC3]]
[[es:Plantilla:TOC]]
</includeonly>
| |||