Template:Auxiliary Table of Contents

From Wikisource
Jump to navigation Jump to search
Chapters (not listed in original)
Template documentation[view] [edit] [history] [purge]

This template creates a special boxed table of contents within a mainspace page. It is intended for adding tables of contents to works that did not originally feature such a navigation device. For example, where a work has been broken into chapters or other subsections on subpages on Wikisource where the original document simply flowed from one section to the other.

This template uses the same class as {{header}}, which separates the table of contents from the proofread text derived from the Page: and Index: space.

Usage[edit]

Basic[edit]

{{Auxiliary Table of Contents|List of subpages}}

Advanced[edit]

{{Auxiliary Table of Contents|text=List of subpages|title=|comment=|width=}}

Parameters[edit]

  • title: Inserts and new word or phrase in the top left of the table. Default: Chapters.
  • comment: Inserts a new comment to the right of the title. Default: (not individually listed).
  • width: Width of the table; default: 30em. Avoid using widths in px, as this can cause unexpectedly narrow results on export.[1]
  • nosummary: Do not add the contained links to exported file TOCs. This can be useful:
    • If the AuxTOC is not the only TOC on the root page (e.g. an AuxTOC is used to add some sections not listed in the original TOC). By adding nosummary, the export will contain both the links in the AuxTOC and the links in the original TOC. Without it, the export may only contain the contents of the AuxTOC. If some links are repeated on the root page's TOCs, they will be repeated on the exported file's TOC.
    • If the same links are added elsewhere. For example, if the same links are presented on a subpage as well as on the main page, the entries from the subpage will be nested in the output file, so the subpage should be used and the main page table should use nosummary=y. E.g. Pierre and Jean (Bell, 1902).

Examples[edit]

{{Auxiliary Table of Contents|
#[[/Chapter 1/]]
#[[/Chapter 2/]]
#[[/Chapter 3/]]
#[[/Chapter 4/]]
#[[/Chapter 5/]]
}}
Chapters (not listed in original)
  1. Chapter 1
  2. Chapter 2
  3. Chapter 3
  4. Chapter 4
  5. Chapter 5
{{Auxiliary Table of Contents|title=Foo|comment=Bar|width=20em|<poem>[[/Preface /]]
[[/Chapter 1/]]
[[/Chapter 2/]]
[[/Chapter 3/]]</poem>}}

See also[edit]

Navigation templates are used to help a reader navigate through or between texts.

Template You type You get Notes
{{TOC}} {{TOC}}


Table of 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
Used to provide a compact TOC to an alphabetical listing.
{{AuxTOC}} {{AuxTOC|

* [[/Chapter 1/]]}}

Chapters (not listed in original)
Used when the work does not include an original Table of Contents.
{{TOC begin}},
{{TOC end}} and
all {{TOC row....}}'s

{{TOC begin}}
{{TOC row 1-1-1|...}}
{{TOC end}}

Preface i
I. Introduction xii
II. Chapter 1 1
Used to easily format existing TOCs in the original.



  1. See H:PXWIDTH for details. Using a pixel width will add the page to Category:Pages using pixel widths.