Template:SeriesHeader

From ISFDB
Jump to navigation Jump to search
This is an ISFDB Bibliographic Comments page for the SeriesHeader series. This page may be used for a list of the titles in the series, bibliographic comments or extended notes about the series, or discussion on how to organize and/or record the works in the series. The link above leads to the ISFDB series record for SeriesHeader. To discuss what should go on this page, use the talk page.

For more on this and other header templates, see Header templates.


Purpose

This template provides a standard header for bibliography & comment pages about a series. It optionally provides a link to the series bibliography in the ISFDB database, using {{Series}}. Normally you use the SeriesHeader template on pages in the Series namespace as these are linked to from each series' bibliographic page.

Usage

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

It may be called as:

{{SeriesHeader}}

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

or as

{{SeriesHeader|name=<series name>}}

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

or as

{{SeriesHeader|id=<series record number>}}

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


or as

{{SeriesHeader|name=<series name>|id=<series record number>}}

(which will use the name specified in the name parameter, and will link to the series bibliographic 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 bibliographic 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.

Documentation source

This is documentation for the template SeriesHeader, transcluded from SeriesHeader/Doc.