Template:Compact ToC: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(re-edited to transclude /doc page, after waiting nearly 6 hours and no auto-reformat: still showed old included template documentation; added internal "NOTE I3" about indenting if-statements)
m (robot Adding: nl:Sjabloon:CompactTOC8, no:Mal:CompactTOC8; cosmetic changes)
Line 8: Line 8:
{{      <!--see NOTE I3 below-->
{{      <!--see NOTE I3 below-->
<!-- ----------------------------------- Check name/side-->
<!-- ----------------------------------- Check name/side-->
#ifeq:{{{name|}}}|no||! {{{name|{{MediaWiki:Toc}}}}}{{#ifeq:{{{side|{{#ifeq:{{{1|}}}|short1|yes|}}}}}|yes|&#58;|}}
#ifeq:{{{name|}}}|no||! {{{name|{{MediaWiki:Toc}}}}}{{#ifeq:{{{side|{{#ifeq:{{{1|}}}|short1|yes|}}}}}|yes|:|}}
{{#ifeq:{{{side|{{#ifeq:{{{1|}}}|short1|yes|}}}}}|yes|{{!}}|{{!}}-}}}}
{{#ifeq:{{{side|{{#ifeq:{{{1|}}}|short1|yes|}}}}}|yes|{{!}}|{{!}}-}}}}
|{{#ifeq:{{{nobreak|{{#ifeq:{{{1|}}}|short1|yes|}}}}}|yes||<div style="text-align:{{{align|left}}};">}}{{
|{{#ifeq:{{{nobreak|{{#ifeq:{{{1|}}}|short1|yes|}}}}}|yes||<div style="text-align:{{{align|left}}};">}}{{
Line 53: Line 53:
#ifeq:{{{extlinks|}}}|yes|{{{sep|&nbsp;}}} [[#External links{{!}}External links]]|}}{{
#ifeq:{{{extlinks|}}}|yes|{{{sep|&nbsp;}}} [[#External links{{!}}External links]]|}}{{
<!-- ================================== Check invalid words-->
<!-- ================================== Check invalid words-->
#ifeq:{{{break|x}}}|x||<br>
#ifeq:{{{break|x}}}|x||<br />
   TOC8 - Invalid parameter "break" - try "nobreak=yes".
   TOC8 - Invalid parameter "break" - try "nobreak=yes".
}}{{#ifeq:{{{centre|x}}}|x||<br>
}}{{#ifeq:{{{centre|x}}}|x||<br />
   TOC8 - Invalid parameter "centre" - try "center=yes".
   TOC8 - Invalid parameter "centre" - try "center=yes".
}}{{#ifeq:{{{Top|x}}}|x||<br>
}}{{#ifeq:{{{Top|x}}}|x||<br />
   TOC8 - Invalid parameter "Top" - try lowercase "top=yes".
   TOC8 - Invalid parameter "Top" - try lowercase "top=yes".
}}{{#ifeq:{{{ref|x}}}|x||<br>
}}{{#ifeq:{{{ref|x}}}|x||<br />
   TOC8 - Invalid parameter "ref" - try "refs=yes".
   TOC8 - Invalid parameter "ref" - try "refs=yes".
}}{{#ifeq:{{{Ref|x}}}|x||<br>
}}{{#ifeq:{{{Ref|x}}}|x||<br />
   TOC8 - Invalid parameter "Ref" - try lowercase "refs=yes".
   TOC8 - Invalid parameter "Ref" - try lowercase "refs=yes".
}}{{#ifeq:{{{note|x}}}|x||<br>
}}{{#ifeq:{{{note|x}}}|x||<br />
   TOC8 - Invalid parameter "note" - try "note'''s'''=yes".
   TOC8 - Invalid parameter "note" - try "note'''s'''=yes".
}}{{#ifeq:{{{ext|x}}}|x||<br>
}}{{#ifeq:{{{ext|x}}}|x||<br />
   TOC8 - Invalid parameter "ext" - try "extlinks=yes".
   TOC8 - Invalid parameter "ext" - try "extlinks=yes".
}}{{#ifeq:{{{extlink|x}}}|x||<br>
}}{{#ifeq:{{{extlink|x}}}|x||<br />
   TOC8 - Invalid parameter "extlink" - try "extlinks=yes".
   TOC8 - Invalid parameter "extlink" - try "extlinks=yes".
}}</div>
}}</div>
Line 88: Line 88:
--          before the condensed "0-9 A B C..." appears.
--          before the condensed "0-9 A B C..." appears.
--
--
-- NOTE S2: Parameter "sep=&middot;" defines the separator
-- NOTE S2: Parameter "sep=·" defines the separator
--          string displayed between subheaders (not letters).
--          string displayed between subheaders (not letters).
--          It defaults to a single space, "sep=&nbsp;".
--          It defaults to a single space, "sep=&nbsp;".
Line 95: Line 95:
--          wiki-format now omits HTML comments on web xfer.
--          wiki-format now omits HTML comments on web xfer.
--HISTORY:
--HISTORY:
-- 10Jan09 Added parameters: sep=&middot; and prebreak=<br>.
-- 10Jan09 Added parameters: sep=· and prebreak=<br>.
-- 10Jan09 Added parameters: 3 more custom6, custom7, custom8.
-- 10Jan09 Added parameters: 3 more custom6, custom7, custom8.
-- 10Jan09 Added parameters: 3 more custom6link...custom8link.
-- 10Jan09 Added parameters: 3 more custom6link...custom8link.
Line 111: Line 111:
--End Template:CompactTOC8-->
--End Template:CompactTOC8-->
</noinclude>
</noinclude>
[[nl:Sjabloon:CompactTOC8]]
[[no:Mal:CompactTOC8]]

Revision as of 02:42, 29 April 2009

Contents
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
[edit] Template documentation

Purpose

This is a Table-of-Contents replacement for alphabetical lists:

  • The compact format goes sideways: A B C D E F G H I J K L ....
  • The centering or numbers are optional: center=yes, num=yes.
  • The "Contents" heading can go on top (default) or the side (side=yes).
  • Letter ranges can be set (see below: #Letters): A B C–F G H–K L...
  • Some letters can be omitted, instead of 26 separate letters.
  • Other headers can be listed in the TOC (see below: Listing custom-headers).
  • Set upper headers before "ABCDEF" by pre1, pre2, ... pre8.
  • Set lower headers after "ABCDEF" by custom1, custom2, ... custom8.
  • Conceal subheader link-text as "pre1name" over "pre1link" and "custom1name" over "custom1link" etc.
  • Other options include: top=yes, seealso=yes, refs=yes, extlinks=yes, etc.

The template has all features of other TOC templates, such as optional "Top" "0–9" sections, and allows selecting other sections.

Usage

Typical

{{Compact ToC|symnum=yes}}


For alphabetical only

{{Compact ToC}}


For common applications

{{Compact ToC|center=yes|seealso=yes|refs=yes|further=yes}}

or vertical:
{{Compact ToC
 |center  = yes
 |seealso = yes
 |refs    = yes
 |further = yes
}}


For maximum number of features and centered placement (leave off a parameter or change it to blank or "no" to disable a feature)

{{Compact ToC
 |name=
 |side=yes
 |center=yes
 |right=
 |align=center
 |nobreak=yes
 |top=yes
 |num=yes
 |sym=yes
 |symnum=
 |pre1=
 |pre1name=
 |pre1link=
 ...
 |pre8=
 |pre8name=
 |pre8link=
 |prebreak=<br>
 |custom1=
 |custom1name=
 |custom1link=
 ...
 |custom8=
 |custom8name=
 |custom8link=
 |seealso=yes
 |notesfirst=
 |refs=yes
 |notes=yes
 |further=yes
 |extlinks=yes
 |a=
 ...
 |z=
}}

Parameters

  • name=: change the heading to an alternative name instead of "Contents", or hide it completely by entering name=no
  • side=yes: put the "Contents" heading on the left side with a colon, instead of the top without one
  • center=yes: center to ToC in the horizontal middle of the page, instead of floated left
  • right=yes: align the ToC horizontally to the right of the page (may require <br style="clear:right;" /> 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)
  • align=: sets the alignment of the links inside the table; default is left; use center, right or left
  • nobreak=yes: no linebreak between the A-B-C-etc. stuff and the See also/References/etc. stuff (note: does not affect the heading; use side= for that)
  • top=yes: 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 <a name="top" id="top"></a> above the sitenotice which makes this link work without having to do anything but enable it in the template.)
  • sym=yes: enable the "!$@" link for symbolic entries section
  • num=yes: enable the "0–9" link for numeric entries section (create a heading of ==0&ndash;9== for the link to work)
  • symnum=yes: enable the "!–9" link for combined symbolic and numeric entries section (create a heading of ==!&ndash;9== for the link to work)
  • sep=&middot;: set the separator-text between word-headers (not between "ABCDEF") to "·"; could also be a vertical-bar or &bull; (•), etc.
  • custom1 to custom8: add up to 8 extra "custom" sections after the "ABCDEF" list. These appear as [[#custom1|custom1]].
  • custom1name to custom8name: modifies the way the custom section headers appear: [[#custom1|custom1name]]
  • custom1link to custom8link: modifies the targets of the custom sections: [[custom1link|custom1]]. Use this only for linking to another page. Use sparingly! About the only legitimate use for this is connecting the sub-pages of multi-page articles, like long lists that have been broken up. Do not repurpose the ToC as a makeshift navbox.
  • pre1 to pre8: list up to 8 extra section headers before (pre-list) the "ABCDEF" list. These appear as [[#pre1|pre1]].
  • pre1name to pre8name: modifies the way the pre-list section headers appear: [[#pre1|pre1name]]
  • pre1link to pre8link: modifies the targets of the pre-list headers: [[pre1link|pre1]].
  • prebreak=<br>: set break-line after all pre-list headers; can include text to introduce "ABCDEF".
  • seealso=yes: enable link to the "See also" section
  • refs=yes: enable link to the "References" section (observe that it is plural)
  • notes=yes: enable link to the "Notes" section (observe that it is plural)
  • notesfirst=yes: enable link to the "Notes" section, but placed before "References"; do not use with notes (and do observe that it is plural)
  • further=yes: enable link to the "Further reading" section
  • extlinks=yes: enable link to the "External links" section
  • a= through z=: 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 #Letters below for more detailed documentation of this feature.)

Letters

Any letter can be omitted (i.e. when it has no entries in the list) by specifying it as a lower-case blank parameter:  {{Compact ToC|side=yes|j=|q=}}

Contents
A B C D E F G H I K L M N O P R S T U V W X Y Z

nl:Sjabloon:CompactTOC8 no:Mal:CompactTOC8

Or it can be replaced with an unlinked letter by using that letter (upper-case): {{Compact ToC|side=yes|j=J|q=Q}}

Contents
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

nl:Sjabloon:CompactTOC8 no:Mal:CompactTOC8

Note: It is often better to create an empty placeholder span (e.g. <span id="Q" /> 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.

The letter-assignment feature can also be used to create range links:

{{Compact ToC|side=yes|x=[[#X-Z|X-Z]]|y=|z=}}

Contents
A B C D E F G H I J K L M N O P Q R S T U V W X-Z

nl:Sjabloon:CompactTOC8 no:Mal:CompactTOC8

The feature can also be used (very tediously) for linking to sub-articles (e.g., for long lists that have been split into multiple pages):

{{Compact ToC|name=[[Articlename]]|side=yes|n=[[Articlename (N–Z)#N|N]]|o=[[Articlename (N–Z)#O|O]]|...|z=[[Articlename (N–Z)#Z|Z]]}}

Contents
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

nl:Sjabloon:CompactTOC8 no:Mal:CompactTOC8


Or, as another example:

{{Compact ToC|side=yes|n=[[Articlename (N–Z)|&nbsp;N–Z (next page)]]|o=|p=|...|z=}}

Contents

nl:Sjabloon:CompactTOC8 no:Mal:CompactTOC8


Listing custom-headers

The optional parameters pre1...pre8 and custom1...custom8 allow listing up to 16 other section-headers in the TOC, before or after, the "ABCDEF" list:

{{Compact ToC|name=no|center=yes|top=yes|seealso=yes|notes=yes|custom1=New section|custom2=Additional section}}

Top   A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
New section   Additional section   See also   Notes 

nl:Sjabloon:CompactTOC8 no:Mal:CompactTOC8

{{Compact ToC|name=no|center=yes|top=yes|seealso=yes|notes=yes|custom1=New section|custom1name=Custom section name|custom2=Outside page|custom2link=Main Page}}

nl:Sjabloon:CompactTOC8 no:Mal:CompactTOC8


Headers can be listed before & after "ABCDEF" using pre1 & custom1:

{{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}}
Contents

nl:Sjabloon:CompactTOC8 no:Mal:CompactTOC8


The separator text can be set to a mid-dot by "sep=&middot;" :

{{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|sep='''&middot;'''}}
Contents

nl:Sjabloon:CompactTOC8 no:Mal:CompactTOC8

Shorthand

  • short1 can be used as the very first parameter (before name=) for shortening a common usage:

{{Compact ToC|short1}}

Contents
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z    References 

nl:Sjabloon:CompactTOC8 no:Mal:CompactTOC8

It replaces {{Compact ToC|side=yes|center=yes|nobreak=yes|refs=yes}}

Examples

{{Compact ToC|top=yes}}

Contents
Top   A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

nl:Sjabloon:CompactTOC8 no:Mal:CompactTOC8

{{Compact ToC|side=yes|sym=yes|num=yes|refs=yes|seealso=yes|custom1=Other}}

Contents
!$@ 0–9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Other   References 

nl:Sjabloon:CompactTOC8 no:Mal:CompactTOC8

{{Compact ToC|name=Directory|top=no|refs=yes|notes=yes|extlinks=yes}}

Directory
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
  References   Notes   External links

nl:Sjabloon:CompactTOC8 no:Mal:CompactTOC8

{{Compact ToC|name=no|side=yes|right=yes|symnum=yes|seealso=yes}}

!–9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
  See also 

nl:Sjabloon:CompactTOC8 no:Mal:CompactTOC8

{{Compact ToC|short1|num=yes|sym=yes|seealso=yes|notesfirst=yes|further=yes|extlinks=yes}}

Contents
!$@ 0–9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z    See also   Notes   References   External links

nl:Sjabloon:CompactTOC8 no:Mal:CompactTOC8

See also


nl:Sjabloon:CompactTOC8 no:Mal:CompactTOC8