Template:Compact ToC/doc - Revision history

Dmarcadmin: 12 revisions imported

2015-07-17T02:56:59Z

12 revisions imported

John of Reading: /* Parameters */Typo fixing, replaced: folowing → following using AWB

2015-06-10T17:02:43Z

‎Parameters: Typo fixing, replaced: folowing → following using AWB

Steel1943: /* Parameters */ added description for "allowtoc"

2015-05-20T20:46:28Z

‎Parameters: added description for "allowtoc"

Frietjes at 15:24, 5 March 2015

2015-03-05T15:24:14Z

Frietjes at 18:00, 1 January 2015

2015-01-01T18:00:07Z

Sardanaphalus: /* "short1" */ indent

2014-10-06T20:25:38Z

‎"short1": indent

Sardanaphalus: {{\sandbox}}, some formatting

2014-10-06T20:24:45Z

{{\sandbox}}, some formatting

Show changes

Frietjes: per talk

2014-09-27T15:09:08Z

per talk

Frietjes: /* Parameters */

2014-09-13T15:38:15Z

‎Parameters

Frietjes: /* Parameters */

2014-09-13T15:34:19Z

‎Parameters

@@ Line 80: / Line 80: @@
 *<code>further=yes</code>: enable link to the "Further reading" section
 *<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 these parameters. Can also be used to create range links, e.g. "X-Z". ''(See folowing section for more detailed documentation of this feature.)''
+*<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 these parameters. Can also be used to create range links, e.g. "X-Z". ''(See following section for more detailed documentation of this feature.)''
 *<code>allowtoc=yes</code>: disables the hiding of the automatically-generated table of contents that <code><nowiki>__NOTOC__</nowiki></code> usually hides. (Since this template's purpose is usually to ''replace the existing table of contents'', this functionality is usually only necessary on Wikipedia guideline pages that use this template in examples.)

@@ Line 81: / Line 81: @@
 *<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 these parameters. Can also be used to create range links, e.g. "X-Z". ''(See folowing section for more detailed documentation of this feature.)''
 == Letters ==

@@ Line 86: / Line 86: @@
 Any letter can be omitted (i.e. when it has no entries in the list) by specifying it as a ''lowercase'' blank parameter, e.g. {{tlx|Compact ToC&#32;|<nowiki>side=yes |j=|q=</nowiki>}}:
 {| style="margin-left:3.0em"
-| {{Compact ToC{{\sandbox}} |side=yes |j=|q=}}
+| {{Compact ToC |side=yes |j=|q=}}
 |}
 Or it can be replaced with an unlinked letter by using that letter (in ''uppercase''), e.g. {{tlx|Compact ToC&#32;|<nowiki>side=yes |j=J|q=Q</nowiki>}}:
 {| style="margin-left:3.0em"
-| {{Compact ToC{{\sandbox}} |side=yes |j=J|q=Q}}
+| {{Compact ToC |side=yes |j=J|q=Q}}
 |}
 ''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. Using the span-id avoids confusing new users who might not realize the TOC-template has skipped some letters.
@@ Line 96: / Line 96: @@
 The letter-assignment feature can also be used to create range links, e.g. {{tlx|Compact ToC&#32;|<nowiki>side=yes |x=[[#X-Z|X-Z]] |y=|z=</nowiki>}}:
 {| style="margin-left:3.0em"
-| {{Compact ToC{{\sandbox}} |side=yes |x=[[#X-Z|X-Z]] |y=|z=}}
+| {{Compact ToC |side=yes |x=[[#X-Z|X-Z]] |y=|z=}}
 |}
@@ Line 102: / Line 102: @@
 {{tlx|Compact ToC&#32;|<nowiki>side=yes |name=[[</nowiki><var>Articlename</var><nowiki>]] |n=[[</nowiki><var>Articlename</var><nowiki> (N–Z)#N|N]] |o=[[</nowiki><var>Articlename</var><nowiki> (N–Z)#O|O]] |... |z=[[</nowiki><var>Articlename</var><nowiki> (N–Z)#Z|Z]]</nowiki>}}
 {| style="margin-left:3.0em"
-| {{Compact ToC{{\sandbox}} |side=yes |name=[[Articlename]] |n=[[Article (N–Z)#N|N]] |o=[[Articlename (N–Z)#O|O]] |p=[[Articlename (N–Z)#P|P]] |q=[[Articlename (N–Z)#Q|Q]] |r=[[Articlename (N–Z)#R|R]] |s=[[Articlename (N–Z)#S|S]] |t=[[Articlename (N–Z)#T|T]] |u=[[Articlename (N–Z)#U|U]] |v=[[Articlename (N–Z)#V|V]] |w=[[Articlename (N–Z)#W|W]] |x=[[Articlename (N–Z)#X|X]] |y=[[Articlename (N–Z)#Y|Y]] |z=[[Articlename (N–Z)#Z|Z]]}}
+| {{Compact ToC |side=yes |name=[[Articlename]] |n=[[Article (N–Z)#N|N]] |o=[[Articlename (N–Z)#O|O]] |p=[[Articlename (N–Z)#P|P]] |q=[[Articlename (N–Z)#Q|Q]] |r=[[Articlename (N–Z)#R|R]] |s=[[Articlename (N–Z)#S|S]] |t=[[Articlename (N–Z)#T|T]] |u=[[Articlename (N–Z)#U|U]] |v=[[Articlename (N–Z)#V|V]] |w=[[Articlename (N–Z)#W|W]] |x=[[Articlename (N–Z)#X|X]] |y=[[Articlename (N–Z)#Y|Y]] |z=[[Articlename (N–Z)#Z|Z]]}}
 |}
 {{tlx|Compact ToC&#32;|<nowiki>side=yes |n=[[</nowiki><var>Articlename</var><nowiki> (N–Z)|&nbsp;N–Z {{small|(next page)}}]] |o=|p=|...|z=</nowiki>}}
 {| style="margin-left:3.0em"
-| {{Compact ToC{{\sandbox}} |side=yes |n=[[Articlename (N–Z)|&nbsp;N–Z {{small|(next page)}}]] |o=|p=|q=|r=|s=|t=|u=|v=|w=|x=|y=|z=}}
+| {{Compact ToC |side=yes |n=[[Articlename (N–Z)|&nbsp;N–Z {{small|(next page)}}]] |o=|p=|q=|r=|s=|t=|u=|v=|w=|x=|y=|z=}}
 |}
@@ Line 114: / Line 114: @@
 {{tlx|Compact ToC&#32;|<nowiki>name=no |center=yes |top=yes |custom1=New section |custom2=Additional section |seealso=yes|notes=yes</nowiki>}}
-{{Compact ToC{{\sandbox}}
+{{Compact ToC
   |name=no |center=yes |top=yes
   |custom1=New section |custom2=Additional section
@@ Line 121: / Line 121: @@
 {{tlx|Compact ToC&#32;|<nowiki>name=no |center=yes |top=yes |custom1=New section|custom1name=Custom section name |custom2=Outside page|custom2link=Main Page |seealso=yes|notes=yes</nowiki>}}
-{{Compact ToC{{\sandbox}}
+{{Compact ToC
   |name=no |center=yes |top=yes
   |custom1=New section |custom1name=Custom section name
@@ Line 130: / Line 130: @@
 Headers can be listed before & after "ABCDEF" using ''pre1'' and ''custom1''&nbsp;:<br/>
 {{tlx|Compact ToC&#32;|<nowiki>center=yes |top=yes |pre1=Scope of list |pre2=Abbreviations used |prebreak=yes |custom1=Popular entries |custom2=Excluded entries |notes=yes|seealso=yes</nowiki>}}
-{{Compact ToC{{\sandbox}}
+{{Compact ToC
   |center=yes |top=yes
   |pre1=Scope of list |pre2=Abbreviations used |prebreak=yes
@@ Line 138: / Line 138: @@
 ==="short1"===
-{{plaincode|<nowiki>{{Compact ToC |side=yes |center=yes |nobreak=yes |refs=yes}}</nowiki>}} is a common configuration whose parameters may be replaced by the shortcut
+<code><nowiki>{{Compact ToC |side=yes |center=yes |nobreak=yes |refs=yes}}</nowiki></code> is a common configuration whose parameters may be replaced by the shortcut
 : {{tlx|Compact ToC&#32;|short1}}
-i.e. by making {{plaincode|{{!}}short1}} the very first parameter.
+i.e. by making <code>{{!}}short1</code> the very first parameter.
 == Examples ==
@@ Line 146: / Line 146: @@
 {{tlx|Compact ToC&#32;|<nowiki>top=yes</nowiki>}}
 {| style="margin-left:2.0em"
-| {{Compact ToC{{\sandbox}} |top=yes}}
+| {{Compact ToC |top=yes}}
 |}
 {{tlx|Compact ToC&#32;|<nowiki>side=yes |sym=yes|num=yes |custom1=Other |refs=yes|seealso=yes</nowiki>}}
 {| style="margin-left:2.0em"
-| {{Compact ToC{{\sandbox}} |side=yes |sym=yes|num=yes |custom1=Other |refs=yes|seealso=yes}}
+| {{Compact ToC |side=yes |sym=yes|num=yes |custom1=Other |refs=yes|seealso=yes}}
 |}
 {{tlx|Compact ToC&#32;|<nowiki>name=Directory |top=no |refs=yes|notes=yes|extlinks=yes</nowiki>}}
 {| style="margin-left:2.0em"
-|{{Compact ToC{{\sandbox}} |name=Directory |top=no |refs=yes|notes=yes|extlinks=yes}}
+|{{Compact ToC |name=Directory |top=no |refs=yes|notes=yes|extlinks=yes}}
 |}
 {{tlx|Compact ToC&#32;|<nowiki>side=yes|right=yes |name=no |symnum=yes |seealso=yes</nowiki>}}
-{{Compact ToC{{\sandbox}} |side=yes|right=yes |name=no |symnum=yes |seealso=yes}}<br style="clear:right;"/>
+{{Compact ToC |side=yes|right=yes |name=no |symnum=yes |seealso=yes}}<br style="clear:right;"/>
 {{tlx|Compact ToC&#32;|<nowiki>short1 |num=yes|sym=yes |seealso=yes|notesfirst=yes|further=yes|extlinks=yes</nowiki>}}
-{{Compact ToC{{\sandbox}} |short1 |num=yes|sym=yes |seealso=yes|notesfirst=yes|further=yes|extlinks=yes}}
+{{Compact ToC |short1 |num=yes|sym=yes |seealso=yes|notesfirst=yes|further=yes|extlinks=yes}}
 == Limitations ==

@@ Line 37: / Line 37: @@
   <!--(etc, to:)-->
   |pre8=|pre8name=|pre8link=
-  |prebreak=<!--<br/>-->
+  |prebreak=<!--yes-->
   |num= |sym= |symnum=
@@ Line 68: / Line 68: @@
 *<code>pre1name</code> to <code>pre8name</code>: modifies the way the pre-list section headers appear: <nowiki>[[#pre1|pre1name]]</nowiki>
 *<code>pre1link</code> to <code>pre8link</code>: modifies the targets of the pre-list headers: <nowiki>[[pre1link|pre1]]</nowiki>.
-*<code>prebreak=&lt;br></code>: set break-line after all pre-list headers; can include text to introduce "ABCDEF".
+*<code>prebreak=yes</code>: set break-line after all pre-list headers
 <!-- ------------------------------- Parameters custom1..8 -->
 *<code>custom1</code> to <code>custom8</code>: add up to 8 extra "custom" sections after the "ABCDEF" list. These appear as <nowiki>[[#custom1|custom1]]</nowiki>.
@@ Line 129: / Line 129: @@
 Headers can be listed before & after "ABCDEF" using ''pre1'' and ''custom1''&nbsp;:<br/>
-{{tlx|Compact ToC&#32;|<nowiki>center=yes |top=yes |pre1=Scope of list |pre2=Abbreviations used |prebreak=<br/> |custom1=Popular entries |custom2=Excluded entries |notes=yes|seealso=yes</nowiki>}}
+{{tlx|Compact ToC&#32;|<nowiki>center=yes |top=yes |pre1=Scope of list |pre2=Abbreviations used |prebreak=yes |custom1=Popular entries |custom2=Excluded entries |notes=yes|seealso=yes</nowiki>}}
 {{Compact ToC{{\sandbox}}
   |center=yes |top=yes
-  |pre1=Scope of list |pre2=Abbreviations used |prebreak=<br/>
+  |pre1=Scope of list |pre2=Abbreviations used |prebreak=yes
   |custom1=Popular entries |custom2=Excluded entries
   |notes=yes |seealso=yes

@@ Line 138: / Line 138: @@
 ==="short1"===
-{{plaincode|<nowiki>{{Compact ToC |side=yes |center=yes |nobreak=yes |refs=yes}}</nowiki>}} is a common configuration whose parameters may be replaced by the shortcut<br/>
+{{plaincode|<nowiki>{{Compact ToC |side=yes |center=yes |nobreak=yes |refs=yes}}</nowiki>}} is a common configuration whose parameters may be replaced by the shortcut
-{{tlx|Compact ToC&#32;|short1}}
+: {{tlx|Compact ToC&#32;|short1}}
 i.e. by making {{plaincode|{{!}}short1}} the very first parameter.

← Older revision	Revision as of 02:56, 17 July 2015
(No difference)

@@ Line 51: / Line 51: @@
   |center=
   |right=
   |nobreak=
   |top=
@@ Line 88: / Line 87: @@
 *<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>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 a secondary ToC not at the top of the page, e.g. in the middle of a long glossary. (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.)
@@ Line 159: / Line 157: @@
 Headers can be listed before & after "ABCDEF" using pre1 & custom1:
-: {{tlx|Compact ToC|center&#61;yes|align&#61;center|top&#61;yes|seealso&#61;yes<br>|pre1&#61;Scope of list|pre2&#61;Abbreviations used|prebreak&#61;&lt;br><br>|custom1&#61;Popular entries|custom2&#61;Excluded entries|notes&#61;yes}}
+: {{tlx|Compact ToC|center&#61;yes|top&#61;yes|seealso&#61;yes<br>|pre1&#61;Scope of list|pre2&#61;Abbreviations used|prebreak&#61;&lt;br><br>|custom1&#61;Popular entries|custom2&#61;Excluded entries|notes&#61;yes}}
-{{Compact ToC|center=yes|align=center|top=yes|seealso=yes|pre1=Scope of list|pre2=Abbreviations used|prebreak=<br>|custom1=Popular entries|custom2=Excluded entries|notes=yes}}
+{{Compact ToC|center=yes|top=yes|seealso=yes|pre1=Scope of list|pre2=Abbreviations used|prebreak=<br>|custom1=Popular entries|custom2=Excluded entries|notes=yes}}
 ===Shorthand===
@@ Line 192: / Line 190: @@
 {{tlx|Compact ToC|short1|num&#61;yes|sym&#61;yes|seealso&#61;yes|notesfirst&#61;yes|further&#61;yes|extlinks&#61;yes}}
 {{Compact ToC|short1|num=yes|sym=yes|seealso=yes|notesfirst=yes|further=yes|extlinks=yes}}
 == See also ==

@@ Line 94: / Line 94: @@
 *<code>sym=yes</code>: enable the "!$@" link for symbolic entries section
 *<code>symnum=yes</code>: enable the "!–9" link for combined symbolic and numeric entries section (create a heading of <code><nowiki>==!&amp;ndash;9==</nowiki></code> for the link to work)
-*<code>letters=no</code: suppresses the "A", "B", ..., "Z" entries.
+*<code>letters=no</code>: suppresses the "A", "B", ..., "Z" entries.
 <!-- ------------------------------- Parameters pre1..pre8 -->
 *<code>pre1</code> to <code>pre8</code>: list up to 8 extra section headers ''before'' (pre-list) the "ABCDEF" list. These appear as <nowiki>[[#pre1|pre1]]</nowiki>.