Template:CompactTOC8Edit This Page

From FamilySearch Wiki

(Difference between revisions)
(Update)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{| class="toc" id="toc" summary="Contents"
+
{|<!--=======================================================
|-
+
    --  Template CompactTOC8 -  (see NOTES at bottom)
|  
+
    --=======================================================
{{{a|[[#A|A]]}}} {{{b|[[#B|B]]}}} {{{c|[[#C|C]]}}} {{{d|[[#D|D]]}}} {{{e|[[#E|E]]}}} {{{f|[[#F|F]]}}} {{{g|[[#G|G]]}}} {{{h|[[#H|H]]}}} {{{i|[[#I|I]]}}} {{{j|[[#J|J]]}}} {{{k|[[#K|K]]}}} {{{l|[[#L|L]]}}} {{{m|[[#M|M]]}}} {{{n|[[#N|N]]}}} {{{o|[[#O|O]]}}} {{{p|[[#P|P]]}}} {{{q|[[#Q|Q]]}}} {{{r|[[#R|R]]}}} {{{s|[[#S|S]]}}} {{{t|[[#T|T]]}}} {{{u|[[#U|U]]}}} {{{v|[[#V|V]]}}} {{{w|[[#W|W]]}}} {{{x|[[#X|X]]}}} {{{y|[[#Y|Y]]}}} {{{z|[[#Z|Z]]}}}&nbsp;
+
--
<div></div>
+
--> id="toc" class="toc" summary="Contents" {{
|}
+
<!-- ----------------------------------- Check center/right-->
 +
#ifeq:{{{center|{{#ifeq:{{{1|}}}|short1|yes|}}}}}|yes|align="center"|}}{{#ifeq:{{{right|}}}|yes|align="right"|}}
 +
{{      <!--see NOTE I3 below-->
 +
<!-- ----------------------------------- Check name/side-->
 +
#ifeq:{{{name|}}}|no||! {{{name|{{MediaWiki:Toc}}}}}{{#ifeq:{{{side|{{#ifeq:{{{1|}}}|short1|yes|}}}}}|yes|&#58;|}}
 +
{{#ifeq:{{{side|{{#ifeq:{{{1|}}}|short1|yes|}}}}}|yes|{{!}}|{{!}}-}}}}
 +
|{{#ifeq:{{{nobreak|{{#ifeq:{{{1|}}}|short1|yes|}}}}}|yes||<div style="text-align:{{{align|left}}};">}}{{
 +
<!-- --------------------------------------- Check top -->
 +
#ifeq:{{{top|}}}|yes|[[#top{{!}}Top]]&nbsp;{{{sep|&nbsp;}}}|}} {{
 +
<!-- --------------------------------------- Prefix headers--
 +
          (see NOTE P2 below) -->
 +
#if:{{{pre1|{{{preSec1|}}}}}}|[[{{{pre1link|{{{preSec1link|#{{{pre1|{{{preSec1|}}}}}}}}}}}}{{!}}{{{pre1name|{{{preSec1name|{{{pre1|{{{preSec1|}}}}}}}}}}}}]]&nbsp;{{{sep|&nbsp;}}}|}} {{
 +
#if:{{{pre2|{{{preSec2|}}}}}}|[[{{{pre2link|{{{preSec2link|#{{{pre2|{{{preSec2|}}}}}}}}}}}}{{!}}{{{pre2name|{{{preSec2name|{{{pre2|{{{preSec2|}}}}}}}}}}}}]]&nbsp;{{{sep|&nbsp;}}}|}} {{
 +
#if:{{{pre3|{{{preSec3|}}}}}}|[[{{{pre3link|{{{preSec3link|#{{{pre3|{{{preSec3|}}}}}}}}}}}}{{!}}{{{pre3name|{{{preSec3name|{{{pre3|{{{preSec3|}}}}}}}}}}}}]]&nbsp;{{{sep|&nbsp;}}}|}} {{
 +
#if:{{{pre4|{{{preSec4|}}}}}}|[[{{{pre4link|{{{preSec4link|#{{{pre4|{{{preSec4|}}}}}}}}}}}}{{!}}{{{pre4name|{{{preSec4name|{{{pre4|{{{preSec4|}}}}}}}}}}}}]]&nbsp;{{{sep|&nbsp;}}}|}} {{
 +
#if:{{{pre5|{{{preSec5|}}}}}}|[[{{{pre5link|{{{preSec5link|#{{{pre5|{{{preSec5|}}}}}}}}}}}}{{!}}{{{pre5name|{{{preSec5name|{{{pre5|{{{preSec5|}}}}}}}}}}}}]]&nbsp;{{{sep|&nbsp;}}}|}} {{
 +
#if:{{{pre6|{{{preSec6|}}}}}}|[[{{{pre6link|{{{preSec6link|#{{{pre6|{{{preSec6|}}}}}}}}}}}}{{!}}{{{pre6name|{{{preSec6name|{{{pre6|{{{preSec6|}}}}}}}}}}}}]]&nbsp;{{{sep|&nbsp;}}}|}} {{
 +
#if:{{{pre7|{{{preSec7|}}}}}}|[[{{{pre7link|{{{preSec7link|#{{{pre7|{{{preSec7|}}}}}}}}}}}}{{!}}{{{pre7name|{{{preSec7name|{{{pre7|{{{preSec7|}}}}}}}}}}}}]]&nbsp;{{{sep|&nbsp;}}}|}} {{
 +
#if:{{{pre8|{{{preSec8|}}}}}}|[[{{{pre8link|{{{preSec8link|#{{{pre8|{{{preSec8|}}}}}}}}}}}}{{!}}{{{pre8name|{{{preSec8name|{{{pre8|{{{preSec8|}}}}}}}}}}}}]]&nbsp;{{{sep|&nbsp;}}}|}} {{
 +
<!-- --------------------------------------- Check prebreak-->
 +
#if:{{{prebreak|}}}|{{{prebreak}}}}} {{
 +
<!-- --------------------------------------- Check symbols -->
 +
#ifeq:{{{sym|}}}|yes|[[#!$@|!$@]]|}} {{
 +
<!-- --------------------------------------- Check numbers -->
 +
#ifeq:{{{num|}}}|yes|[[#0–9|0–9]]|}} {{#ifeq:{{{symnum|}}}|yes|[[#!–9|!–9]]|
 +
<!-- --------------------------------------- List letters -->
 +
}} {{{a|[[#A|A]]}}} {{{b|[[#B|B]]}}} {{{c|[[#C|C]]}}} {{{d|[[#D|D]]}}} {{{e|[[#E|E]]}}} {{{f|[[#F|F]]}}} {{{g|[[#G|G]]}}} {{{h|[[#H|H]]}}} {{{i|[[#I|I]]}}} {{{j|[[#J|J]]}}} {{{k|[[#K|K]]}}} {{{l|[[#L|L]]}}} {{{m|[[#M|M]]}}} {{{n|[[#N|N]]}}} {{{o|[[#O|O]]}}} {{{p|[[#P|P]]}}} {{{q|[[#Q|Q]]}}} {{{r|[[#R|R]]}}} {{{s|[[#S|S]]}}} {{{t|[[#T|T]]}}} {{{u|[[#U|U]]}}} {{{v|[[#V|V]]}}} {{{w|[[#W|W]]}}} {{{x|[[#X|X]]}}} {{{y|[[#Y|Y]]}}} {{{z|[[#Z|Z]]}}} {{#ifeq:{{{nobreak|{{#ifeq:{{{1}}}|short1|yes|}}}}}|yes|&nbsp;|<br />}}{{
 +
<!-- ------------------------------ Check after-header1 -
 +
          (see NOTE C2 below) -->
 +
#if:{{{custom1|{{{Sec1|}}}}}}|[[{{{custom1link|{{{Sec1link|#{{{custom1|{{{Sec1|}}}}}}}}}}}}{{!}}{{{custom1name|{{{Sec1name|{{{custom1|{{{Sec1|}}}}}}}}}}}}]]&nbsp;|}}{{
 +
<!-- ------------------------------ Check after-header2...-->
 +
#if:{{{custom2|{{{Sec2|}}}}}}|{{{sep|&nbsp;}}} [[{{{custom2link|{{{Sec2link|#{{{custom2|{{{Sec2|}}}}}}}}}}}}{{!}}{{{custom2name|{{{Sec2name|{{{custom2|{{{Sec2|}}}}}}}}}}}}]]&nbsp;|}}{{
 +
#if:{{{custom3|{{{Sec3|}}}}}}|{{{sep|&nbsp;}}} [[{{{custom3link|{{{Sec3link|#{{{custom3|{{{Sec3|}}}}}}}}}}}}{{!}}{{{custom3name|{{{Sec3name|{{{custom3|{{{Sec3|}}}}}}}}}}}}]]&nbsp;|}}{{
 +
#if:{{{custom4|{{{Sec4|}}}}}}|{{{sep|&nbsp;}}} [[{{{custom4link|{{{Sec4link|#{{{custom4|{{{Sec4|}}}}}}}}}}}}{{!}}{{{custom4name|{{{Sec4name|{{{custom4|{{{Sec4|}}}}}}}}}}}}]]&nbsp;|}}{{
 +
#if:{{{custom5|{{{Sec5|}}}}}}|{{{sep|&nbsp;}}} [[{{{custom5link|{{{Sec5link|#{{{custom5|{{{Sec5|}}}}}}}}}}}}{{!}}{{{custom5name|{{{Sec5name|{{{custom5|{{{Sec5|}}}}}}}}}}}}]]&nbsp;|}}{{
 +
#if:{{{custom6|{{{Sec6|}}}}}}|{{{sep|&nbsp;}}} [[{{{custom6link|{{{Sec6link|#{{{custom6|{{{Sec6|}}}}}}}}}}}}{{!}}{{{custom6name|{{{Sec6name|{{{custom6|{{{Sec6|}}}}}}}}}}}}]]&nbsp;|}}{{
 +
#if:{{{custom7|{{{Sec7|}}}}}}|{{{sep|&nbsp;}}} [[{{{custom7link|{{{Sec7link|#{{{custom7|{{{Sec7|}}}}}}}}}}}}{{!}}{{{custom7name|{{{Sec7name|{{{custom7|{{{Sec7|}}}}}}}}}}}}]]&nbsp;|}}{{
 +
#if:{{{custom8|{{{Sec8|}}}}}}|{{{sep|&nbsp;}}} [[{{{custom8link|{{{Sec8link|#{{{custom8|{{{Sec8|}}}}}}}}}}}}{{!}}{{{custom8name|{{{Sec8name|{{{custom8|{{{Sec8|}}}}}}}}}}}}]]&nbsp;|}}{{
 +
<!-- ---------------------------------- Check seealso-->
 +
#ifeq:{{{seealso|}}}|yes|{{{sep|&nbsp;}}} [[#See also{{!}}See also]]&nbsp;|}}{{
 +
<!-- ---------------------------------- Check notesfirst-->
 +
#ifeq:{{{notesfirst|}}}|yes|{{{sep|&nbsp;}}} [[#Notes{{!}}Notes]]&nbsp;|}}{{
 +
<!-- ---------------------------------- Check refs-->
 +
#ifeq:{{{refs|{{#ifeq:{{{1|}}}|short1|yes|}}}}}|yes|{{{sep|&nbsp;}}} [[#References{{!}}References]]&nbsp;|}}{{
 +
<!-- ---------------------------------- Check notes-->
 +
#ifeq:{{{notes|}}}|yes|{{{sep|&nbsp;}}} [[#Notes{{!}}Notes]]&nbsp;|}}{{
 +
<!-- ---------------------------------- Check extlinks-->
 +
#ifeq:{{{extlinks|}}}|yes|{{{sep|&nbsp;}}} [[#External links{{!}}External links]]|}}{{
 +
<!-- ================================== Check invalid words-->
 +
#ifeq:{{{break|x}}}|x||<br>
 +
  TOC8 - Invalid parameter "break" - try "nobreak=yes".
 +
}}{{#ifeq:{{{centre|x}}}|x||<br>
 +
  TOC8 - Invalid parameter "centre" - try "center=yes".
 +
}}{{#ifeq:{{{Top|x}}}|x||<br>
 +
  TOC8 - Invalid parameter "Top" - try lowercase "top=yes".
 +
}}{{#ifeq:{{{ref|x}}}|x||<br>
 +
  TOC8 - Invalid parameter "ref" - try "refs=yes".
 +
}}{{#ifeq:{{{Ref|x}}}|x||<br>
 +
  TOC8 - Invalid parameter "Ref" - try lowercase "refs=yes".
 +
}}{{#ifeq:{{{note|x}}}|x||<br>
 +
  TOC8 - Invalid parameter "note" - try "note'''s'''=yes".
 +
}}{{#ifeq:{{{ext|x}}}|x||<br>
 +
  TOC8 - Invalid parameter "ext" - try "extlinks=yes".
 +
}}{{#ifeq:{{{extlink|x}}}|x||<br>
 +
  TOC8 - Invalid parameter "extlink" - try "extlinks=yes".
 +
}}</div>
 +
|}__NOTOC__<noinclude>
  
__NOTOC__<noinclude>{{Documentation}} &amp;lt;!-- PLEASE ADD CATEGORIES AND INTERWIKIS TO THE /doc SUBPAGE, THANKS --&amp;gt;</noinclude> <!--{12051724075930} -->
+
{{documentation}}
<!--{12051724075931} -->
+
<!--PLEASE ADD CATEGORIES & INTERWIKIS TO /doc PAGE, THANKS-->
 +
<!--
 +
--      -------------------------------------------------
 +
--NOTES:
 +
--
 +
-- NOTE C2: Parameter "custom1=zzz" or "Sec1=zzz" shows first
 +
--          subheader "zzz" after the "0-9 A B C D...".
 +
--
 +
-- NOTE I3: If-statements can be indented by leaving "{{" at
 +
--         end of previous line and put "#if:" on next line;
 +
--          otherwise indented lines become quote-boxes.
 +
--
 +
-- NOTE P2: Parameter "pre1=xxx" shows first subheader "xxx"
 +
--          before the condensed "0-9 A B C..." appears.
 +
--
 +
-- NOTE S2: Parameter "sep=&middot;" defines the separator
 +
--          string displayed between subheaders (not letters).
 +
--          It defaults to a single space, "sep=&nbsp;".
 +
--
 +
-- NOTE V9: Coded for MediaWiki language 1.11.1 (Jan.2008);
 +
--          wiki-format now omits HTML comments on web xfer.
 +
--HISTORY:
 +
-- 10Jan09 Added parameters: sep=&middot; and prebreak=<br>.
 +
-- 10Jan09 Added parameters: 3 more custom6, custom7, custom8.
 +
-- 10Jan09 Added parameters: 3 more custom6link...custom8link.
 +
-- 10Jan09 Added parameters: 3 more custom6name...custom8name.
 +
-- 10Jan09 Added parameters: pre1, pre2, pre3... pre7, pre8.
 +
-- 10Jan09 Added parameters: pre1link, pre2link ... pre8link.
 +
-- 10Jan09 Added parameters: pre1name, pre2name ... pre8name.
 +
-- 10Jan09 Added parameters: preSec1, preSec2, ... preSec8.
 +
-- 10Jan09 Spot invalid keywords: Top/ref/Ref/note/ext etc.
 +
-- 10Jan09 Added NOTES comments to explain template coding.
 +
-- 10Jan09 Added HISTORY comments to log major changes.
 +
--
 +
-- [These comment lines are omitted before Internet transfer.]
 +
--
 +
--End Template:CompactTOC8-->
 +
</noinclude>

Latest revision as of 20:26, 12 March 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
[view] [edit] [history] [purge] Documentation icon Template documentation

Template:Intricate template

Contents

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 Template:CompactTOC7, plus some from Template:CompactTOC2, such as optional "Top" "0-9" sections, and allows selecting other sections.

Usage

Typical:

{{CompactTOC8|symnum=yes}}


For alphabetical only (no number or symbol entries):

{{CompactTOC8}}


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

{{CompactTOC8
|name=
|side=yes
|center=yes
|right=
|align=center
|nobreak=yes
|top=yes
|num=yes
|sym=yes
|symnum=
|pre1=
|pre1name=
|pre1link=
...
|pre8=
|pre8name=
|pre8link=
|prebreak=
|custom1= |custom1name= |custom1link= ... |custom8= |custom8name= |custom8link= |seealso=yes |notesfirst= |refs=yes |notes=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)
  • 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:  {{CompactTOC8|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

Or it can be replaced with an unlinked letter by using that letter (upper-case): {{CompactTOC8|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

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:

{{CompactTOC8|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

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):

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

Articlename:
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

Or, as another example:

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

Contents:

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:

{{CompactTOC8|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 


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


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

{{CompactTOC8|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


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

{{CompactTOC8|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

Shorthand

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

{{CompactTOC8|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 

It replaces {{CompactTOC8|side=yes|center=yes|nobreak=yes|refs=yes}}

Examples

{{CompactTOC8|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


{{CompactTOC8|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 

{{CompactTOC8|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


{{CompactTOC8|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 


{{CompactTOC8|short1|num=yes|sym=yes|seealso=yes|notesfirst=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
ca:Template:Índex

de:Vorlage:TOC es:Plantilla:TOC eo:Ŝablono:Indekso id:Templat:CompactTOC8 ja:template:TOC pt:Predefinição:Peqind sl:Predloga:CompactTOC3 sv:Mall:Alfabetisk nl:Sjabloon:CompactTOC8

  • This page was last modified on 12 March 2009, at 20:26.
  • This page has been accessed 758 times.