Difference between revisions of "Template:Reflist/doc"

From Super-wiki
Jump to: navigation, search
(Replaced content with '== Usage == Work in progress, several failed attempts to get this formatting working. '''Please do not use this template at this time.''' To place a footnote-style list of…')
Line 1: Line 1:
 +
Use this template to create a footnote-style reference list in an article.  The advantage to doing this using the Ref tag is that the wiki will take care of numbering and managing the references list, editors will not need to renumber an entire references list just to add one footnote mid-article.
 +
 
== Usage ==
 
== Usage ==
  
Work in progress, several failed attempts to get this formatting working.  '''Please do not use this template at this time.'''
+
If used with no parameters, it will simply produce a reference list in a small font.
 +
 
 +
=== Multiple columns ===
 +
 
 +
Using <tt><nowiki>{{reflist|2}}</nowiki></tt> will create a two-column reference list, and <tt><nowiki>{{reflist|3}}</nowiki></tt> will create a three-column list.
 +
 
 +
Using <tt><nowiki>{{reflist|colwidth=30em}}</nowiki></tt> will allow the browser to automatically choose the number of columns based on the width of the web browserChoose a column width that's appropriate for the average width of the references on the page.
 +
 
 +
Note: multiple columns may not render properly in all browsers, as there are compatibility issues.
 +
 
 +
=== Four options for usage ===
 +
 
 +
==== Option 1 (only specific/unique references) ====
 +
 
 +
<pre>
 +
== Content ==
 +
 
 +
Lorem ipsum.<ref>season, episode, etc.</ref>
 +
 
 +
Lorem ipsum dolor sit amet.<ref>season, episode, etc.</ref>
 +
 
 +
== References ==
 +
 
 +
{{reflist}}
 +
</pre>
 +
 
 +
==== Option 2 (repeat references) ====
 +
 
 +
<pre>
 +
== Content ==
 +
 
 +
Lorum ipsum.<ref>season, episode, etc.</ref>
 +
 
 +
Lorum ipsum dolor sit amet.<ref name="five01">season, episode, etc.</ref>
 +
 
 +
Lorum ipsum.<ref name"five01" />
 +
 
 +
== References ==
 +
 
 +
{{reflist}}
 +
</pre>
 +
Note that reference ''name'' cannot be just an integer, ie. 501.
 +
 
 +
==== Option 3 (only general references) ====
 +
 
 +
<pre>
 +
== Content ==
 +
 
 +
Lorem ipsum.
 +
 
 +
Lorem ipsum dolor sit amet.
 +
 
 +
== References ==
 +
 
 +
{{refbegin}}
 +
* general reference 1
 +
* general reference 2
 +
{{refend}}
 +
</pre>
 +
 
 +
==== Option 4 (both specific and general references) ====
 +
 
 +
<pre>
 +
== Content ==
 +
 
 +
Lorem ipsum.<ref>season, episode, etc.</ref>
 +
 
 +
Lorem ipsum dolor sit amet.<ref>season, episode, etc.</ref>
 +
 
 +
Lorem ipsum.
 +
 
 +
Lorem ipsum dolor sit amet.
 +
 
 +
== References ==
 +
 
 +
{{reflist}}
 +
 
 +
{{refbegin}}
 +
* general reference 1
 +
* general reference 2
 +
{{refend}}
 +
</pre>
  
To place a footnote-style list of references in an article, use the following format:
+
<includeonly>
 +
[[Category:Templates]]
 +
</includeonly>

Revision as of 04:39, 20 January 2011

Use this template to create a footnote-style reference list in an article. The advantage to doing this using the Ref tag is that the wiki will take care of numbering and managing the references list, editors will not need to renumber an entire references list just to add one footnote mid-article.

Usage

If used with no parameters, it will simply produce a reference list in a small font.

Multiple columns

Using {{reflist|2}} will create a two-column reference list, and {{reflist|3}} will create a three-column list.

Using {{reflist|colwidth=30em}} will allow the browser to automatically choose the number of columns based on the width of the web browser. Choose a column width that's appropriate for the average width of the references on the page.

Note: multiple columns may not render properly in all browsers, as there are compatibility issues.

Four options for usage

Option 1 (only specific/unique references)

== Content ==

Lorem ipsum.<ref>season, episode, etc.</ref>

Lorem ipsum dolor sit amet.<ref>season, episode, etc.</ref>

== References ==

{{reflist}}

Option 2 (repeat references)

== Content ==

Lorum ipsum.<ref>season, episode, etc.</ref>

Lorum ipsum dolor sit amet.<ref name="five01">season, episode, etc.</ref>

Lorum ipsum.<ref name"five01" />

== References ==

{{reflist}}

Note that reference name cannot be just an integer, ie. 501.

Option 3 (only general references)

== Content ==

Lorem ipsum.

Lorem ipsum dolor sit amet.

== References ==

{{refbegin}}
* general reference 1
* general reference 2
{{refend}}

Option 4 (both specific and general references)

== Content ==

Lorem ipsum.<ref>season, episode, etc.</ref>

Lorem ipsum dolor sit amet.<ref>season, episode, etc.</ref>

Lorem ipsum.

Lorem ipsum dolor sit amet.

== References ==

{{reflist}}

{{refbegin}}
* general reference 1
* general reference 2
{{refend}}