Template:Table of Contents/Doc

From ISFDB
Jump to navigation Jump to search


Documentation for the template: Table of Contents (transcluded from Template:Table of Contents/Doc).

Purpose

This template is to be placed on the image description page of a Table of Contents of front page image used to document a webzine under fair use.

Usage

Call this template as:

{{Table of Contents
|Pub=<TAG>
}}

or as:

{{Table of Contents
|Id=<TAG>
}}

or as:

{{Table of Contents|<TAG>}}

or as:

{{Table of Contents|<TAG>|<publication title>}}

or as:

{{Table of Contents
|Pub=<TAG>
|Title=<publication title>
}}

Note: In all the above examples, when a parameter is shown in angle brackets, like:

<Parameter>

then the parameter, and the angle brackets, should be replaced by the value of the parameter. For example: Title=<TITLE> should become Title=The Name of the Book (or whatever the name might be).

When using an unnamed (positional) parameter, it should NOT be the last thing on the line. It should be followed by either a pipe symbol (|) if there is another parameter to follow, or by the template call close (}}) if there is not. Otherwise the parameter value will be passed as including the carriage return at the end of the line, which will probably cause the template to function incorrectly.

Parameters

  • Pub must specify a publication record tag or record number, an acceptable argument to Template:P (which see). Id may be used instead. If neither the "Pub=" nor the "Id=" parameter is present, the first unnamed parameter is used. One of these must be present and valid for the template to work correctly.
  • Title is used to specify the title of the publication, for display. If an unnamed parameter is used for Id, a 2nd unnamed parameter may be used for title.

Alias

To reduce typing, the alias {{TOC}} has been created for this template. So this template can also be called as

{{TOC
|Pub=<TAG>
}}

or as:

{{TOC|<TAG>}}

Categories

This template puts all pages that transclude (call) it into the following categories: