Template:BookShortcut

From Guild of Recappers & Podcasters
Jump to navigation Jump to search

This template allows our book shortcut templates to link to this wiki, the L-Space wiki or Wikipedia (and may include other options later). It's intended for use inside individual book shortcut templates like {{COM}}, which by default links to The Colour of Magic.

A similar template, Template:ShortStoryShortcut, exists for Short Stories.

Usage

The template expects one to three unnamed parameters, in order: {{BookShortcut|Title|Destination|Link name}}

  • The Title is the title of the book, and is always required. If this is the only parameter, it will produce a local link - e.g. {{BookShortcut|Diggers}} produces: Diggers
  • The Destination parameter is required if linking to one of the defined alternate locations; the list below documents these. e.g. {{BookShortcut|Diggers|ls}} produces: Diggers
  • The Link name parameter is only used when one of the defined external sites uses a different page or article name for this book. If it's omitted, the link will be to the title defined in the first parameter.
    e.g. {{BookShortcut|Diggers|w|The Nome Trilogy#Diggers (1990)}} produces: Diggers

Destinations supported

These are the abbreviations for destinations you can use as the second parameter when calling this template.

  • apf - the Annotated Pratchett File. This links to the original, hosted at www.lspace.org. Note that it only contains entries with annotations up to A Hat Full of Sky, but there are empty pages for all the Discworld books and many of the others.
  • cs - Colin Smythe's official website, at colinsmythe.co.uk.
  • ls - the L-Space wiki. This uses the "lsb:" inter-wiki prefix, which adds the "Book:" namespace to the link.
  • w - Wikipedia. This uses the standard inter-wiki link prefix of "wikipedia:".
  • For podcasts that use book titles as episode names, you can use the shortcut to link to the article for that podcast's episode on this wiki for the book (most of which do not yet exist):

The cs and apf options use additional template parser functions to convert the book title into lower case and replace spaces with dashes so it can be parsed. Note that some books use abbreviated titles on colinsmythe.co.uk, and even on the APF where full titles are used in the URL, punctuation in titles is removed to make it easier to parse as HTML. In both instances, the altered text used in the URL will need to be specified as the link name. For example: {{BookShortcut|The Colour of Magic|cs|colour-magic}} for The Colour of Magic, or {{BookShortcut|Guards! Guards!|apf|guards-guards}} for Guards! Guards!