Template:BookShortcut: Difference between revisions

Latest revision as of 16:59, 12 March 2023

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

Similar templates exist for Short Stories (Template:ShortStoryShortcut) and nonfiction (Template:NonfictionShortcut).

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 the destination 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:”.

There is also one special “destination” which doesn’t include a link:

ep - a quick way to insert the name of the book in inverted commas without italicisation or a link, intended for episode titles of podcasts which just use the book title.

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 forms part of the URL of the destination site. 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!.

@@ Line 1: / Line 1: @@
-{{#switch: {{{2|}}}
+<includeonly>{{#switch: {{{2|}}}
     | ls = ''[[lsb:{{{3|{{{1}}}}}}|{{{1}}}]]''
     | w = ''[[wikipedia:{{{3|{{{1}}}}}}|{{{1}}}]]''
-    | ''[[{{{1}}}]]''
+   | cs = ''[https://colinsmythe.co.uk/terry-pratchett/discworld/discworld-novels/{{{3|{{lc:{{#replace: {{{1}}}|<nowiki> </nowiki>|-}}}}}}} {{{1}}}]''
-}}<noinclude>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 <nowiki>{{COM}}</nowiki>, which by default links to {{COM}}.
+   | apf = ''[https://www.lspace.org/books/apf/{{{3|{{lc:{{#replace: {{{1}}}|<nowiki> </nowiki>|-}}}}}}}.html {{{1}}}]''
+   | ep = “{{{1}}}”
+    | ''[[{{{3|{{{1}}}}}}|{{{1}}}]]''
+}}</includeonly><noinclude>
+This template allows our book shortcut templates to link to this wiki, the L-Space wiki, Wikipedia and other commonly linked sites. It's intended for use inside individual book shortcut templates like <nowiki>{{COM}}</nowiki>, which by default links to {{COM}}.
+Similar templates exist for Short Stories ([[Template:ShortStoryShortcut]]) and nonfiction ([[Template:NonfictionShortcut]]).
 == Usage ==
-This template expects one to three unnamed parameters, in order: <nowiki>{{BookShortcut|Title|destination|link name}}</nowiki>
+The template expects one to three unnamed parameters, in order: <nowiki>{{BookShortcut|Title|Destination|Link name}}</nowiki>
-* 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. <nowiki>{{BookShortcut|Diggers}}</nowiki> produces: {{BookShortcut|Diggers}}
-* The destination parameter is required if linking externally to one of the defined alternate locations; the list below documents these. e.g. <nowiki>{{BookShortcut|Diggers|ls}}</nowiki> produces: {{BookShortcut|Diggers|ls}}
-* 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. <nowiki>{{BookShortcut|Diggers|w|The Nome Trilogy#Diggers (1990)}}</nowiki> produces: {{BookShortcut|Diggers|w|The Nome Trilogy#Diggers (1990)}}
-The intent is to keep the shortcut templates simple, so all an editor needs to do is specify the destination; the alternate names for L-Space and Wikipedia etc should be specified within the template. This does make creating some of those shortcuts a bit more tedious, but will hopefully be worth it in the long run. Further documentation is coming for how to do this.
+* 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. <nowiki>{{BookShortcut|Diggers}}</nowiki> produces: {{BookShortcut|Diggers}}
+* The '''Destination''' parameter is required if linking to one of the defined alternate locations; the list below documents these. e.g. <nowiki>{{BookShortcut|Diggers|ls}}</nowiki> produces: {{BookShortcut|Diggers|ls}}
+* The '''Link name''' parameter is only used when the destination 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.<br/> e.g. <nowiki>{{BookShortcut|Diggers|w|The Nome Trilogy#Diggers (1990)}}</nowiki> produces: {{BookShortcut|Diggers|w|The Nome Trilogy#Diggers (1990)}}
 == 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 {{HFOS}}, 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:".
+* '''w''' - Wikipedia. This uses the standard inter-wiki link prefix of "wikipedia:”.
+There is also one special “destination” which doesn’t include a link:
+* '''ep''' - a quick way to insert the name of the book in inverted commas without italicisation or a link, intended for episode titles of podcasts which just use the book title.
+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 forms part of the URL of the destination site. 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: <nowiki>{{BookShortcut|The Colour of Magic|cs|colour-magic}}</nowiki> for {{BookShortcut|The Colour of Magic|cs|colour-magic}}, or <nowiki>{{BookShortcut|Guards! Guards!|apf|guards-guards}}</nowiki> for {{BookShortcut|Guards! Guards!|apf|guards-guards}}.
-{{DEFAULTSORT:*}}
 [[Category:Shortcut Templates]]
-[[Category:Book Shortcut Templates]]</noinclude>
+[[Category:Book Shortcut Templates|*]]</noinclude>

Template:BookShortcut: Difference between revisions

Latest revision as of 16:59, 12 March 2023

Usage

Destinations supported

Navigation menu