Template:CompactTOC8/doc - Revision history

Logmanoriginal: Add tags for {{documentation subpage}}

2024-08-01T16:21:28Z

Add <noinclude> tags for {{documentation subpage}}

← Older revision		Revision as of 16:21, 1 August 2024
Line 1:		Line 1:
			<noinclude>{{documentation subpage}}</noinclude>
	{{Intricate template}}		{{Intricate template}}
	~~{{documentation subpage}}~~
	__TOC__		__TOC__
	==Purpose==		==Purpose==

Logmanoriginal: Up

2024-07-31T18:00:10Z

← Older revision		Revision as of 18:00, 31 July 2024
Line 1:		Line 1:
	{{Intricate template}}		{{Intricate template}}
			{{documentation subpage}}
	__TOC__		__TOC__
	==Purpose==		==Purpose==
Line 100:		Line 101:
	{{CompactTOC8\|name=no\|side=yes\|right=yes\|symnum=yes\|seealso=yes}}<br style="clear:right;" />		{{CompactTOC8\|name=no\|side=yes\|right=yes\|symnum=yes\|seealso=yes}}<br style="clear:right;" />

	~~<code><nowiki>~~{{~~</nowiki>'''~~CompactTOC8~~'''<nowiki>~~\|short1\|num=yes\|sym=yes\|seealso=yes\|notesfirst=yes\|extlinks=yes}}~~</nowiki></code>~~		{{tlx\|CompactTOC8\|short1\|num=yes\|sym=yes\|seealso=yes\|notesfirst=yes\|extlinks=yes}}
	{{CompactTOC8\|short1\|num=yes\|sym=yes\|seealso=yes\|notesfirst=yes\|extlinks=yes}}		{{CompactTOC8\|short1\|num=yes\|sym=yes\|seealso=yes\|notesfirst=yes\|extlinks=yes}}

	~~<noinclude>[[Category:Template documentation\|{{PAGENAME}}]]</noinclude>~~
	<includeonly>		<includeonly>
	[[Category:TOC templates\|{{PAGENAME}}]]		[[Category:TOC templates\|{{PAGENAME}}]]
	[[Category:Templates using ParserFunctions\|{{PAGENAME}}]]		[[Category:Templates using ParserFunctions\|{{PAGENAME}}]]

	</includeonly>		</includeonly>

Michael_Aivaliotis at 06:28, 1 October 2007

2007-10-01T06:28:57Z

← Older revision		Revision as of 06:28, 1 October 2007
Line 14:		Line 14:
	<code><nowiki>{{</nowiki>'''CompactTOC8'''<nowiki>}}</nowiki></code>		<code><nowiki>{{</nowiki>'''CompactTOC8'''<nowiki>}}</nowiki></code>

	'''For maximum number of features and centered placement''' (leave off a parameter or change it to blank or "no" to disable a feature'''		'''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~~'''~~\|name=Contents\|side=yes\|center=yes\|right=\|align=center\|</code><br />		<code><nowiki>{{CompactTOC8\|name=Contents\|side=yes\|center=yes\|right=\|align=center\|</nowiki></code><br />
	<code>nobreak=yes\|top=yes\|num=yes\|sym=yes\|symnum=\|custom1=\|</code><br />		<code><nowiki>nobreak=yes\|top=yes\|num=yes\|sym=yes\|symnum=\|custom1=\|</nowiki></code><br />
	<code>custom2=\|custom3=\|seealso=yes\|notesfirst=\|refs=yes\|notes=yes\|extlinks=yes~~<nowiki>~~}}</nowiki></code>		<code><nowiki>custom2=\|custom3=\|seealso=yes\|notesfirst=\|refs=yes\|notes=yes\|extlinks=yes}}</nowiki></code>

	''or''		''or''

	<nowiki>{{</nowiki>'''CompactTOC8'''		<nowiki>{{</nowiki>'''CompactTOC8'''
	\|name=		\|name=

Michael_Aivaliotis at 06:20, 1 October 2007

2007-10-01T06:20:17Z

← Older revision		Revision as of 06:20, 1 October 2007
Line 16:		Line 16:
	'''For maximum number of features and centered placement''' (leave off a parameter or change it to blank or "no" to disable a feature'''		'''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'''\|name=Contents\|side=yes\|center=yes\|right=\|align=center\|<br />		<code><nowiki>{{</nowiki>'''CompactTOC8'''\|name=Contents\|side=yes\|center=yes\|right=\|align=center\|</code><br />
	nobreak=yes\|top=yes\|num=yes\|sym=yes\|symnum=\|custom1=\|<br />		<code>nobreak=yes\|top=yes\|num=yes\|sym=yes\|symnum=\|custom1=\|</code><br />
	custom2=\|custom3=\|seealso=yes\|notesfirst=\|refs=yes\|notes=yes\|extlinks=yes<nowiki>}}</nowiki></code>		<code>custom2=\|custom3=\|seealso=yes\|notesfirst=\|refs=yes\|notes=yes\|extlinks=yes<nowiki>}}</nowiki></code>

	''or''		''or''

Michael_Aivaliotis at 06:17, 1 October 2007

2007-10-01T06:17:17Z

← Older revision		Revision as of 06:17, 1 October 2007
Line 43:		Line 43:
	...		...
	\|z=		\|z=
	}}~~</code>~~		}}

	===Parameters===		===Parameters===

Michael_Aivaliotis at 06:07, 1 October 2007

2007-10-01T06:07:29Z

Michael_Aivaliotis: New page: {{Intricate template}} TOC ==Purpose== This Table of Contents replacement for alphabetical lists provides all the features of Template:CompactTOC7, plus ones from [[Template:Compac...

2007-10-01T06:00:30Z

New page: {{Intricate template}} __TOC__ ==Purpose== This Table of Contents replacement for alphabetical lists provides all the features of Template:CompactTOC7, plus ones from [[Template:Compac...

New page

{{Intricate template}}
__TOC__
==Purpose==
This Table of Contents replacement for alphabetical lists provides all the features of [[Template:CompactTOC7]], plus ones from [[Template:CompactTOC2]], etc. that #7 doesn't have (the "Top" "0-9" sections, optionally), ''and'' allows you to select what other sections you want. Even the centering is optional, and you can have the "Contents" heading on the top (default) or the side.

==Usage==

'''Typical''':

<code><nowiki>{{</nowiki>'''CompactTOC8'''|symnum=yes<nowiki>}}</nowiki></code>

'''For alphabetical only''' (no number or symbol entries):

<code><nowiki>{{</nowiki>'''CompactTOC8'''<nowiki>}}</nowiki></code>

'''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'''|name=Contents|side=yes|center=yes|right=|align=center|nobreak=yes|top=yes|num=yes|sym=yes|symnum=|custom1=|custom2=|custom3=|seealso=yes|notesfirst=|refs=yes|notes=yes|extlinks=yes<nowiki>}}</nowiki></code>

''or''
<nowiki>{{</nowiki>'''CompactTOC8'''
|name=
|side=yes
|center=yes
|right=
|align=center
|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 at the bottom (or middle, theoretically) of the page, as a secondary ToC (every rendered page has a hidden <code><nowiki><a name="top" id="top"></a></nowiki></code> above the sitenotice which makes this link work without having to do anything but enable it in the template)
*<code>sym=yes</code> — enable the "!$@" link for symbolic entries section
*<code>num=yes</code> — enable the "0–9" link for numeric entries section (note that it is "–", the en-dash, not "-", the hyphen-minus at upper right of most keyboards)
*<code>symnum=yes</code> — enable the "!–9" link for combined symbolic and numeric entries section (note that it is "–" not "-", and that the preceding two options are mutually exclusive with this one)
*<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 (note that it is plural)
*<code>notes=yes</code> — enable link to the "Notes" section (note that it is plural)
*<code>notesfirst=yes</code> — enable link to the "Notes" section, but placed before "References"; '''''do not''' use with <code>notes</code>'' (note that it is plural)
*<code>extlinks=yes</code> — enable link to the "External links" section

====Letters====
Any letter can be deleted by adding it as a '''lowercase''' blank parameter, or replaced with an unlinked letter by using that letter:
{{tlx|CompactTOC8|side=yes|j=|q=}}
{{CompactTOC8|side=yes|j=|q=}}

{{tlx|CompactTOC8|side=yes|j=J|q=Q}}

{{CompactTOC8|side=yes|j=J|q=Q}}

With a little more work, one can create range links:

{{tlx|CompactTOC8|side=yes|x=<nowiki>[[#X-Z|X-Z]]</nowiki>|y=|z=}} (or <code>x=|y=|z=<nowiki>[[#X-Z|X-Z]]</nowiki></code> etc.)
{{CompactTOC8|side=yes|x=[[#X-Z|X-Z]]|y=|z=}}

====Shorthand====
For quicker referencing common usage, <code>short1</code> can be entered as the first parameter (before <code>name=</code>):
{{tlx|CompactTOC8|short1}}

{{CompactTOC8|short1}}

===Examples===
{{tlx|CompactTOC8|top=yes}}
{{CompactTOC8|top=yes}}

{{tlx|CompactTOC8|name=no|center=yes|top=yes|custom1=New section|custom2=Additional section}}
{{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|sym=yes|num=yes|refs=yes|Sec1=Other}}

{{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|name=no|side=yes|right=yes|symnum=yes|seealso=yes}}
{{CompactTOC8|name=no|side=yes|right=yes|symnum=yes|seealso=yes}}<br style="clear:right;" />

<code><nowiki>{{</nowiki>'''CompactTOC8'''<nowiki>|short1|num=yes|sym=yes|seealso=yes|notesfirst=yes|extlinks=yes}}</nowiki></code>
{{CompactTOC8|short1|num=yes|sym=yes|seealso=yes|notesfirst=yes|extlinks=yes}}

<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
<includeonly>
[[Category:TOC templates|{{PAGENAME}}]]
[[Category:Templates using ParserFunctions|{{PAGENAME}}]]

</includeonly>

← Older revision		Revision as of 06:07, 1 October 2007
Line 9:		Line 9:

	<code><nowiki>{{</nowiki>'''CompactTOC8'''\|symnum=yes<nowiki>}}</nowiki></code>		<code><nowiki>{{</nowiki>'''CompactTOC8'''\|symnum=yes<nowiki>}}</nowiki></code>


	'''For alphabetical only''' (no number or symbol entries):		'''For alphabetical only''' (no number or symbol entries):

	<code><nowiki>{{</nowiki>'''CompactTOC8'''<nowiki>}}</nowiki></code>		<code><nowiki>{{</nowiki>'''CompactTOC8'''<nowiki>}}</nowiki></code>


	'''For maximum number of features and centered placement''' (leave off a parameter or change it to blank or "no" to disable a feature'''		'''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'''\|name=Contents\|side=yes\|center=yes\|right=\|align=center\|nobreak=yes\|top=yes\|num=yes\|sym=yes\|symnum=\|custom1=\|custom2=\|custom3=\|seealso=yes\|notesfirst=\|refs=yes\|notes=yes\|extlinks=yes<nowiki>}}</nowiki></code>		<code><nowiki>{{</nowiki>'''CompactTOC8'''\|name=Contents\|side=yes\|center=yes\|right=\|align=center\|<br />
			nobreak=yes\|top=yes\|num=yes\|sym=yes\|symnum=\|custom1=\|<br />
			custom2=\|custom3=\|seealso=yes\|notesfirst=\|refs=yes\|notes=yes\|extlinks=yes<nowiki>}}</nowiki></code>

	''or''		''or''
Line 82:		Line 82:

	{{CompactTOC8\|short1}}		{{CompactTOC8\|short1}}


	===Examples===		===Examples===
	{{tlx\|CompactTOC8\|top=yes}}		{{tlx\|CompactTOC8\|top=yes}}
	{{CompactTOC8\|top=yes}}		{{CompactTOC8\|top=yes}}



	{{tlx\|CompactTOC8\|name=no\|center=yes\|top=yes\|custom1=New section\|custom2=Additional section}}		{{tlx\|CompactTOC8\|name=no\|center=yes\|top=yes\|custom1=New section\|custom2=Additional section}}
	{{CompactTOC8\|name=no\|center=yes\|top=yes\|seealso=yes\|notes=yes\|custom1=New section\|custom2=Additional section}}		{{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}}		{{tlx\|CompactTOC8\|side=yes\|sym=yes\|num=yes\|refs=yes\|seealso=yes\|sec1=Other}}
	{{CompactTOC8\|side=yes\|sym=yes\|num=yes\|refs=yes\|Sec1=Other}}		{{CompactTOC8\|side=yes\|sym=yes\|num=yes\|refs=yes\|Sec1=Other}}



	{{tlx\|CompactTOC8\|name=Directory\|top=no\|refs=yes\|notes=yes\|extlinks=yes}}		{{tlx\|CompactTOC8\|name=Directory\|top=no\|refs=yes\|notes=yes\|extlinks=yes}}
	{{CompactTOC8\|name=Directory\|top=no\|refs=yes\|notes=yes\|extlinks=yes}}		{{CompactTOC8\|name=Directory\|top=no\|refs=yes\|notes=yes\|extlinks=yes}}



	{{tlx\|CompactTOC8\|name=no\|side=yes\|right=yes\|symnum=yes\|seealso=yes}}		{{tlx\|CompactTOC8\|name=no\|side=yes\|right=yes\|symnum=yes\|seealso=yes}}
	{{CompactTOC8\|name=no\|side=yes\|right=yes\|symnum=yes\|seealso=yes}}<br style="clear:right;" />		{{CompactTOC8\|name=no\|side=yes\|right=yes\|symnum=yes\|seealso=yes}}<br style="clear:right;" />



	<code><nowiki>{{</nowiki>'''CompactTOC8'''<nowiki>\|short1\|num=yes\|sym=yes\|seealso=yes\|notesfirst=yes\|extlinks=yes}}</nowiki></code>		<code><nowiki>{{</nowiki>'''CompactTOC8'''<nowiki>\|short1\|num=yes\|sym=yes\|seealso=yes\|notesfirst=yes\|extlinks=yes}}</nowiki></code>
	{{CompactTOC8\|short1\|num=yes\|sym=yes\|seealso=yes\|notesfirst=yes\|extlinks=yes}}		{{CompactTOC8\|short1\|num=yes\|sym=yes\|seealso=yes\|notesfirst=yes\|extlinks=yes}}


	<noinclude>[[Category:Template documentation\|{{PAGENAME}}]]</noinclude>		<noinclude>[[Category:Template documentation\|{{PAGENAME}}]]</noinclude>