Template:PubSeriesHeader/Doc

-

Purpose
This template provides a standard header for bibliography & comment pages about a publication series. It optionally provides a link to the series bibliography in the ISFDB database, using PubSeries.

Usage
Please place this template at the top (first line) of a page about a publication series.

It may be called as:

(which will take the series name from the page name, and will not link to the database).

or as

(which will use the name specified in the name parameter, but will omit any link to the DB

or as

(which will take the series name from the page name, and will link to the series bibliography display for the series with the specified record number)

or as

(which will use the name specified in the name parameter, and will link to the series bibliography display for the series with the specified record number)

Parameters
There are two optional parameters:


 * name This is the text used for the name of the series, which is also the link display if a link is provided. It defaults to the page name.
 * id This is the record number of a series in the ISFDB database. If, and only if, a id is specified, the first occurrence of the series name in the header text will be a link to the database bibliography display for the series

Please note that this template does not support unnamed parameters -- the name and id parameters must be explicitly specified with "name=" and "id=". This is so that the conditional code can test for the presence or absence of the id parameter.

Category
This template places any page that it is used on into Category:Publication Series.

Aliases
The following alternate names redirect to this template, and may be used in place of this template, with the exact same parameters.


 * PublicationSeriesHeader
 * Publication Series Header

Documentation source
This is documentation for the template PubSeriesHeader, transcluded from PubSeriesHeader/Doc.