Template:Inlineref: Difference between revisions

Template page
m (span instead of div)
m (Protected "Template:Inlineref": Sensitive Page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<includeonly><span id="{{{1}}}">'''{{{1}}}'''</span></includeonly><noinclude>To be used for terms defined in such lists as [[List of terms (TOS)]], [[List of terms (RDM)]], et al. Basically acts as an anchor, so that redirects can bring the user to the right term, instead of the section that term is in -- if applicable.
<includeonly><span id="{{{1}}}">{{#switch:{{{bold}}} | N={{{2|{{{1}}}}}} | Y='''{{{2|{{{1}}}}}}''' | #default='''{{{2|{{{1}}}}}}'''}}</span></includeonly><noinclude>
= Documentation =
To be used for terms defined in such lists as [[List of terms (TOS)]], [[List of terms (RDM)]], et al. Basically acts as an anchor, so that redirects can bring the user to the right term, instead of the section that term is in -- if applicable.


*'''Usage:''' {{tlp|inlineref|''ID''|''Term''}}
== Usage ==
[[Category:Citation templates|{{PAGENAME}}]]</noinclude>
 
<pre>
{{inlineref
|ID
|Term
|bold=
}}
</pre>
 
=== Required parameters ===
 
* '''1:''' (ID) The short, unique id for the term so that it can be passed off as a link, which should '''not''' have spaces. If you need a space between two words, use the underscore character (_). For example, ''[[Encyclopedia Galactica]]'' has a term for "Cygnus", with the ''id'' of "Cygnus", which can be linked to in other article like so:
*: <code><nowiki>[[Encyclopedia Galactica#Cygnus|Cygnus]]</nowiki></code>
* '''2:''' (Term) The term you are defining. This can have spaces.
 
=== Optional parameters ===
 
* '''bold:''' Turns on or off the option for the term to be '''bold''' faced. By default, the term is '''boldfaced'''.
** To turn off the boldface, simply add <code>N</code> (uppercase "n") to the template
 
{{DEFAULTSORT:Inlineref}}
 
[[Category:Citation templates]]
[[Category:Templates using ParserFunctions]]
[[de:Vorlage:Inlineref]]</noinclude>

Latest revision as of 20:22, 13 September 2020

Documentation

To be used for terms defined in such lists as List of terms (TOS), List of terms (RDM), et al. Basically acts as an anchor, so that redirects can bring the user to the right term, instead of the section that term is in -- if applicable.

Usage

{{inlineref
|ID
|Term
|bold=
}}

Required parameters

  • 1: (ID) The short, unique id for the term so that it can be passed off as a link, which should not have spaces. If you need a space between two words, use the underscore character (_). For example, Encyclopedia Galactica has a term for "Cygnus", with the id of "Cygnus", which can be linked to in other article like so:
    [[Encyclopedia Galactica#Cygnus|Cygnus]]
  • 2: (Term) The term you are defining. This can have spaces.

Optional parameters

  • bold: Turns on or off the option for the term to be bold faced. By default, the term is boldfaced.
    • To turn off the boldface, simply add N (uppercase "n") to the template