Difference between revisions of "Template:Ref"

From The Coppermind
Jump to navigation Jump to search
m (try)
m (tweak)
 
(43 intermediate revisions by 5 users not shown)
Line 2: Line 2:
   
 
TEXT
 
TEXT
-->|{{#if:{{{empty|{{{E|}}}|}}}||<!--
+
-->|{{{text|}}}<!--
 
-->{{{pre|}}}<!--
 
-->{{#switch:{{lc:{{{1}}}|}}<!--
 
-->|a=[[{{{2}}}|{{{3|{{{2}}}|}}}]]<!--
 
-->|annotation={{annotation|book={{{2|}}}|chapter={{{chapter|}}}|1{{{chapter|}}}={{{3|}}}|{{#if:{{{text|}}}|text={{{text}}}|5=5}}|6=6}}<!--
 
-->|b={{bref|{{{2}}}|{{{3}}}|{{{4}}}|{{#if:{{{text|}}}|text={{{text}}}|}}|}}<!--
 
-->|?=[[wotdb:{{{2}}}#{{{3}}}|{{{4}}}]]<!--
 
-->|wp=[[wikipedia:{{{2}}}|{{{3|Wikipedia}}}]]<!--
 
-->|bws=[[bws:{{{2}}}|{{{3}}}]]<!--
 
-->|17s={{17s|{{{2}}}|{{{3|}}}={{{4}}}|text={{{5| }}}}}<!--
 
-->|map=[[:file:{{#switch:{{lc:{{{2}}}|}}<!--
 
-->|alethkar=Alethkar.jpg<!--
 
-->|elendel=Elendel.jpg<!--
 
-->|elendel basin=Elendel Basin.png<!--
 
-->|fadrex|fadrex city=Fadrex City.jpg<!--
 
-->|final empire=Final Empire.png<!--
 
-->|kharbranth=Kharbranth.jpg<!--
 
-->|luthadel=Luthadel.png<!--
 
-->|roshar=Roshar.jpg<!--
 
-->|shadesmar=Shadesmar (twok).jpg<!--
 
-->|shattered plains=Shattered Plains.jpg<!--
 
-->|silver kingdoms=Silver Kingdoms.jpg<!--
 
-->|urteau=Urteau.jpg<!--
 
-->}}|{{{text|Map of {{{2}}}|}}}]]<!--
 
-->|img=[[:file:{{{2}}}|{{{text|{{{2}}}|}}}]]<!--
 
 
NOT IN USE
 
-- >|17s|twg|sb={{{{lc:{{{1}}}|}}|{{{2}}}|{{{3|}}}={{{4}}}|text={{{text|}}}|}}<!-- UNTESTED
 
 
-- >|twg={{twg|{{{type|1}}}={{{2}}}|{{#if:{{{3|}}}|2|none}}={{{3}}}|=}}<!-- OLD
 
-- >|sb|stormblessed={{sb|{{{type|1}}}={{{2}}}|{{#if:{{{3|}}}|2|none}}={{{3}}}|=}}<!-- OLD
 
-- >|sawiki|sa|w={{SAwiki|{{{2}}}|{{#if:{{{3|}}}|2|none}}={{{3}}}|=}}<!-- OLD
 
 
DEFAULT
 
-->|{{{1}}}<!--
 
-->}}<!--
 
-->{{{post|}}}<!--
 
 
-->}}<!-- end $empty OR $E
 
   
 
NAME
 
NAME
-->|name={{uc:{{{name|{{{N|<!--
+
-->|name={{{name|{{{text|}}}|}}}<!--
 
-->{{#switch:{{lc:{{{1}}}|}}<!--
 
-->|annotation=annotation:{{{2}}}/{{{chapter|{{{3|}}}|}}}<!--
 
-->|b={{{2}}}_{{{3}}}{{{4}}}<!--
 
-->|?=?{{{2}}}#{{{3}}}<!--
 
-->|17s=17S:{{{2}}}/{{{3}}}/{{{4}}}<!--
 
-->|twg=twg:{{{2}}}/{{{3}}}/{{{4}}}<!--
 
-->|bws=bws:{{{2}}}<!--
 
-->|wp=wp:{{{2}}}<!--
 
-->|img|map=file:{{{2}}}<!--
 
-->|}}<!--
 
 
-->|}}}|}}}|}}<!--
 
   
 
GROUP
 
GROUP
-->|group={{{group|{{{G|}}}|}}}<!--
+
-->|group={{{group|}}}<!--
   
 
-->}}<!--
 
-->}}<!--
   
  +
-->{{#if:{{{name|}}}{{{text|}}}||[[category: empty references]]|}}<!--
REMOVE THESE
 
-->{{#ifeq:{{lc:{{{1|}}}{{{3|}}}|}}|ba|[[Category:Articles with incorrect book links]]|}}<!---
 
 
--></includeonly><noinclude><!-- Documentation comes bellow this line --------- -->
 
 
This template is meant to standardize and simplify, the referencing process for most common sources to [[Brandon Sanderson]] information. References added with template will show at the bottom of the article in the footnotes section, as usual.
 
The template encapsulate the functionality of several [[Category:Link macros|link macro]] in order to simplify reference reuse, by automatically giving names to references with particular characteristics.
 
 
==Detailed Usage==
 
Generally the format to use the template is: <code>{{tlx|ref|First parameter|Additional arguments...}}</code>
 
 
The ''First parameter'' determines which arguments should be passed after. See list of available parameters:
 
{| class=infobox width=100%
 
|-
 
! class=title | First parameter
 
! class=title | Meaning
 
! class=title | Notes
 
|-
 
| a || Reference another wiki article || argument 3 acts as an alternative link title
 
|-
 
| b || Reference a book or chapter || 3 arguments passed to {{T|b}}, reusable
 
|-
 
| ? || Reference a question in Theoryland's Q&A database || 2 arguments become interwiki to the [http://www.theoryland.com/listintv.php Theoryland interview database], the third becomes the text, reusable by first 2
 
|-
 
| 17s || Reference a 17th Shard forum topic/post || Second argument is name of third, fourth is text to display, reusable by 1 and 4
 
<!-- disabled for the moment
 
|-
 
| twg || Reference a Timewasters Guide forum topic/post ||
 
|-
 
| sb || Reference a Stormblessed forum topic/post ||
 
|-
 
| sa || Reference a Stormlight Archive wikia article ||
 
-->
 
|-
 
| wp || Reference a Wikipedia article || 2 arguments, interwiki to [[wikipedia:|Wikipedia]]
 
|-
 
| bws || Reference a page on [[Brandon]]s site || 2 arguments, interwiki to [[bws:|Brandon's site]]
 
<!-- disabled for the moment
 
|-
 
| t || Reference one of [[Brandon]]s Tweets || arguments are tweet ID and text to display
 
-->
 
|-
 
| img || Reference an image on the wiki || arguments are file name and text to display
 
|-
 
| map || Reference one of the map images || argument is place name and text to display
 
|}
 
   
  +
--></includeonly><noinclude>[[category: reference templates| ]]
* For detailed instructions see the individual template pages.
 
* If the first argument does not match one of the arguments in the table, the contents of the first argument are directly wrapped in ref tags.
 
   
  +
This template is mainly used to in definitions of the individual [[:Category: Reference templates|reference templates]], though there are a few cases where it is used directly.
== Common Usage ==
 
  +
* Sometimes it is also useful to just annotate something with a reference, which this template can also be used for with the {{{text}}} parameter.
Commonly you'll be referencing books, thus the format will look similar to this: <code>{{tlx|ref|b|book shorthand|c|chapter shorthand}}</code> where:
 
  +
* It is also used when another [[:Category: Reference templates|reference templates]] has been used with <code>name=X</code>, in which case that reference can be cited again with <code><nowiki>{{ref|name=X}}</nowiki></code>.
* 'b' stands for book. See list of available shorthand [[Template:B|here]].
 
* 'c' stands for chapter, See list of variants [[Template:C|here]].
 
   
  +
For most situations, however, the other reference templates should be used as they offer more structure. See [[Help:Cite]] for more details on using references.
Practical Examples for referencing [[The Way of Kings]]:
 
<pre>
 
{{Ref|b|twok|c|9}} - will create a reference to "The Way of Kings, Chapter 9",
 
{{Ref|b|twok|i|9}} - will create a reference to "The Way of Kings, Interlude 9"
 
</pre>
 
   
  +
== Articles using Template ==
{{cat|templates}}
 
  +
{{for|Special:WhatLinksHere/{{FULLPAGENAME}}|a full listing|here|pre=This list is limited to 100 pages}}
  +
{{Special:WhatLinksHere/{{FULLPAGENAME}}|namespace=0|limit=100}}

Latest revision as of 20:42, 19 April 2020


This template is mainly used to in definitions of the individual reference templates, though there are a few cases where it is used directly.

  • Sometimes it is also useful to just annotate something with a reference, which this template can also be used for with the {{{text}}} parameter.
  • It is also used when another reference templates has been used with name=X, in which case that reference can be cited again with {{ref|name=X}}.

For most situations, however, the other reference templates should be used as they offer more structure. See Help:Cite for more details on using references.

Articles using Template[edit]