Template:Abb/doc

	This page contains usage information for [[{{#sub:Template:Abb/doc|0|{{#rpos:Template:Abb/doc|/doc}}}}]].

Small template which retrieves the name of an Everwind book for a given user entry.

Auxiliary template for {{Infobox}}.

Usage

{{abb|abbreviation}}

Parameters

{{#replace:{{#replace:{{#replace:{{#replace:<unnamed 1> // abb|| }}| >> | up to }}| // | or }}| ++ |, }}

Book abbrevation; see #Abbreviations below for list of valid inputs.

(default: "text")

{{#replace:{{#replace:{{#replace:{{#replace:mode|| }}| >> | up to }}| // | or }}| ++ |, }}

Determines the template output.

Available options:

• icon: Returns the name of the book's icon (without "File:" prefix).
• link: Returns the name of the book's overview article.
• short: Returns a shortened version of the book's name for display in narrow spaces.
• text: Returns the book's name.

Abbreviations

<section begin="abbrevations" />

Abbreviation	text	short	link	icon
F42	Federation 42	FED 42	Federation 42 (book)	File:Booktitle-F42.png
OR	Outrider	OUTRIDER	Outrider (book)	File:Booktitle-OR.png
none	mentioned-only	mentioned-only

<section end="abbrevations" />

Adding new abbrevations

Simply add the following to the template and fill it out:

-->|ABBREVIATION=<!--
 -->{{#switch:{{lc:{{{mode|}}}}}<!--
  -->|icon          =<!--
  -->|link          =<!--
  -->|short         =<!--
  -->|text|#default =<!--
 -->}}<!--

Please note:

• The abbreviation needs to be in all-uppercase.
• Icon file names should be specified without "File:" prefix.

In addition, please try to maintain alphabetical order of abbreviations within the template.

Examples

Input	Result
{{abb|F42}}	Federation 42
{{abb|mode=short|F42}}	FED 42
{{abb|mode=link|F42}}	Federation 42 (book)
{{abb|mode=icon|F42}}	Booktitle-F42.png