Template:BookShortcut: Difference between revisions

From Guild of Recappers & Podcasters
Jump to navigation Jump to search
(Fixed missing brackets)
(→‎Destinations supported: Updated documentation)
Line 20: Line 20:
* '''ls''' - the L-Space wiki. This uses the "lsb:" inter-wiki prefix, which adds the "Book:" namespace to the link.
* '''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:".
* '''w''' - Wikipedia. This uses the standard inter-wiki link prefix of "wikipedia:".
* '''cs''' - Colin Smythe's official website, at colinsmythe.co.uk. This option always requires an alternate link name matching the way the book is named in the website structure; e.g. <nowiki>{{BookShortcut|Carpe Jugulum|cs|carpe-jugulum}}</nowiki>, which produces a link like this: {{BookShortcut|Carpe Jugulum|cs|carpe-jugulum}}
* '''cs''' - Colin Smythe's official website, at colinsmythe.co.uk. This uses additional template parser functions to convert the book title into lower case and replace spaces with dashes so it can be parsed. e.g. <nowiki>{{BookShortcut|Carpe Jugulum|cs}}</nowiki> produces a link like this: {{BookShortcut|Carpe Jugulum|cs}}


[[Category:Shortcut Templates]]
[[Category:Shortcut Templates]]
[[Category:Book Shortcut Templates|*]]</noinclude>
[[Category:Book Shortcut Templates|*]]</noinclude>

Revision as of 19:49, 24 April 2022

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 externally 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.

  • 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:".
  • cs - Colin Smythe's official website, at colinsmythe.co.uk. This uses additional template parser functions to convert the book title into lower case and replace spaces with dashes so it can be parsed. e.g. {{BookShortcut|Carpe Jugulum|cs}} produces a link like this: Carpe Jugulum