Template:PubSeries/doc

Purpose
This linking template is used to link to an ISFDB Publication Series Bibliography display page.

Alias
PS will serve as an alias for PubSeries, and can be called in the identical way and with identical parameters. -DES Talk 01:13, 20 August 2010 (UTC)

Usage
The most common usage is



which will display and clicking on that link will link to Publication Series Bibliography record 5 which is for the Classic Reprint series.

If the second parameter is omitted as in  then  will be displayed.

While these are convenient to use it's a good practice to always use this template with the id and name parameters.

will display as and  respectively.

The "shorthand" or "alias" PS can be used. For example:



which will display PS 5 (Classic Reprint).

will display as PS 5.

Note - As series names can change it is strongly recommended that you always link to an ISFDB series record by its record ID number. However, you can link to a series by name.

will display and link to. If you are on a series bibliography page and want to know its record ID number then look in the browser's address bar and the number will be at the end of the URL.

If the series name contains special characters such as quotes or parentheses then linking by name can fail. Using  displays  but clicking on the link will go to a page that displays "Error: Series not found." There is a workaround for this using the altname parameter along with the name parameter. For example,  displays. Note that when you enter an altname that you must replace any spaces with underscores.

Parameters
There are three optional parameters:


 * id is the record number of a publication series in the ISFDB database.


 * name is the display text used for the link to the series bibliography page. This does not need to be the same as the series name allowing you to write something such as "take a look at series." In that example   was used.


 * altname is used when linking by series name and that the name contains special characters. As linking by series name is discouraged the use of altname should be rare. The value for an altname must not contain any spaces. If a series name contains spaces then replace them with underscores (_).

If the Series template is used with unnamed parameters then the first will be interpreted as the id and the second, if present, will be interpreted as the name. It is possible, though unlikely, that future versions of the Series template will change the interpretation of any unnamed parameters. It is recommended that Series always be used with the id, and if desired, the name parameters.

Documentation source
This is documentation for the template PubSeries, transcluded from PubSeries/doc.