Difference between revisions of "Template:Reflist/doc"

From eRepublik Official Wiki
Jump to: navigation, search
(Created page with "{{documentation subpage}} <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> <includeonly>{{high-risk|1,900,000+}}</includeonly> {{ombox | type=notice | text = Columns are curr...")
 
m (Fixed category)
Line 228: Line 228:
 
}}<includeonly>
 
}}<includeonly>
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
−
[[Category:Citation templates]]
+
[[Category:Citation Templates]]
  
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->

Revision as of 20:21, 27 June 2013

edit

Edit-copy green.png Documentation subpage

This documentation subpage contains instructions, categories, or other information for technical reasons.
To view the Template page itself, see Template:Reflist.


This template encapsulates the Template:Tag tag to show the list of references defined by Template:Tag tags, with some formatting. It reduces the font size and has options for columns and groups. References can be defined within the body of the article or within the reference list.

The Template:Tag and Template:Tag tags are part of the Cite.php MediaWiki extension.

Usage

Using only footnote-style references
== Content ==
Lorem ipsum.<ref>Source name, access date, etc.</ref>
Lorem ipsum dolor sit amet.<ref>Source name, access date, etc.</ref>

== References ==
{{Reflist}}
Using only bibliographical style references (no direct references from the text)
== Content ==
Lorem ipsum. Lorem ipsum dolor sit amet.

== References ==
{{Refbegin}}
* reference 1
* reference 2
{{Refend}}
Using both footnote-style and bibliography-style references
== References ==
{{Reflist}}

{{Refbegin}}
* reference 1
* reference 2
{{Refend}}

Columns

Using {{Reflist|2}} will create a two-column reference list, and {{Reflist|3}} will create a three-column list, and so on. Choose the number of columns that is appropriate for the average width of the references on the page.

Using {{Reflist|30em}} will create columns with a minimum width of 30 em, allowing the browser to automatically choose the number of columns based on the width of the web browser. Choose a column width that is appropriate for the average width of the references on the page.

Columns are currently supported only by Gecko-based browsers (such as Mozilla Firefox) and WebKit-based browsers (such as Google Chrome and Safari). See below for more information.

The use of columns can result in widows and orphans, where a citation at the bottom of a column may be split to the top of the next column. There are CSS3 selectors that could resolve this, but they are not yet supported by any major browsers.

See also bug combining grouped references and columns

List styles

edit

Edit-copy green.png Documentation subpage

This documentation subpage contains instructions, categories, or other information for technical reasons.
To view the Template page itself, see Template:Reflist.


Template:Main is to be used at the beginning of a section or a topic. It is used to lead to a bigger article with more information about the section or the topic in question.

Usage

There are two main ways how to use the template; either to link it to a single article or multiple articles.

Single article

If you would like to lead the reader to a single article. Let's say you would like to lead her/him to the Raw materials page. 

{{Main|Raw materials}}

Which will create:

Main article: Raw materials

If you would like to give a better description of the page you are leading the person... 

{{Main|1=Raw materials|l1=List of all raw materials}}

Which will create:

Main article: List of all raw materials

Multiple article

If you would like to lead the reader to multiple articles. Let's say you would like to lead her/him to the Raw materials and Productivity pages. 

{{Main|Raw materials|Productivity}}

Which will create:

Main articles: Raw materials and Productivity

If you would like to give a better description of the pages you are leading the person... 

{{Main|1=Raw materials|l1=List of all raw materials|2=Productivity|l2=Productivity formula}}

Which will create:

Main articles: List of all raw materials and Productivity formula

If you would like to lead the reader to even more multiple articles. Let's say you would like to lead her/him to the Buildings, Raw materials and Productivity pages. 

{{Main|Buildings|Raw materials|Productivity}}

Which will create:

Main articles: Buildings, Raw materials, and Productivity

If you would like to give a better description of the pages you are leading the person... 

{{Main|1=Buildings|l1=List of all factories you can produce raw materials|2=Raw materials|l2=List of all raw materials|3=Productivity|l3=Productivity formula}}

Which will create:

Main articles: List of all factories you can produce raw materials, List of all raw materials, and Productivity formula

Important notes

  • With one Main template, it is possible to link up to 10 articles
  • When you want to "label" the link where you guide the reader, please use both codes 1= for the link and l1= for the name of the link you would like it to show
  • It is important if you are using multiple articles with labels you need to use codes for each of the articles you are linking; like in an example beforehand

Translations

To translate the template into your own language, simply show more languages on the top menu of this template, click on the flag of the language you want to translate, copy the following code and replace ONLY THE FOLLOWING WORDS (written in order as they appear in the code):

Main articles - will be shown if multiple articles are linked
Main article - will be shown if a single article is linked
and - will be shown if multiple articles are linked (make sure you change all 9 words "and" without removing the code pieces for empty space)
(too many parameters in {{Main}} template) - will be shown if more than 10 articles are linked

Copy the code from Template:Main/English and replace [[Category:Template Backup]] with {{LangMenu}}[[Category:Translated Templates]] Reference lists are by default numbered lists. By using the |liststyle= parameter, you can control how the list is rendered. For example, using |liststyle=upper-roman will result in items being prefixed with roman numerals instead of decimal numbers. The parameter accepts any valid CSS value defined for list-style-type as shown below.

The citations in the reference list will show the default decimal styling if:

  • The value for |liststyle= does not exactly match one of the predefined values
  • The value for |liststyle= is enclosed by quotes
  • {{Reflist}} is indented with the : markup

Template:CSS list-style-type values

Multiple uses

If {{Reflist}} is used multiple times without a parameter, each instance will include all of the previously defined references. To force the parser to close previous references, each use of {{Reflist}} must be forced as a new instance by the use of any parameter. Even an undefined parameter such as {{Reflist|close=1}} will force the references to close.

List-defined references

Template:See A list of references may be defined within {{Reflist}} using the |refs= parameter, just like including named <ref name=". . ."> elements inside the <references> container. This has been available since September 2009. There are new error messages associated with this feature, documented at Help:Cite errors, including one for references defined in {{Reflist}} but not used within the body.

Example

This is reference 1.<ref name="refname1" />
This is reference 2.<ref name="refname2" />

{{Reflist|refs=
<ref name="refname1">content1</ref>
<ref name="refname2">content2</ref>
}}

Result

This is reference 1.[LDR 1] This is reference 2.[LDR 2]

  1. ↑ content1
  2. ↑ content2

The “LDR” group text is to avoid conflicts with other groups of references in this documentation and would not be present in real use.

Grouped references

As of June 2008, the footnotes system supports the separation of references into groups. This allows groups for explanatory notes, table references and the like. See WP:REFGROUP.

The general format for the reference tag is:

Template:Tag

And using |group= for the reflist:

{{Reflist|group="groupname"}}
Where groupname would be a group identifier such as "note", "nb" or "label".

There are three pre-defined group names that will automatically cause the link labels and this template to display other characters instead of numbers (see List styles above). These are: "lower-alpha" (a, b, c...), "lower-greek" (α, β, γ...) and "lower-roman" (i, ii, iii...) and should be written without quotes.

See also bug combining grouped references and columns

Font size

The font size should reduce to 90% for most browsers, but may appear to show at 100% for Internet Explorer and possibly other browsers.[1] As of December 21, 2010, the standard Template:Tag tag has the same font styling. The smaller font may be disabled through Special:Preferences → Gadgets → Disable smaller font sizes of elements such as Infoboxes, Navboxes and References lists.

Technical details

Browser support for columns

Template:CSS3 multiple column layout Multiple columns are generated by using CSS3, which is still in development; thus only browsers that properly support the multi-column property will show multiple columns with {{Reflist}}.[2][3]

These browsers support CSS3 columns:

These browsers do not support CSS3 columns:

  • Microsoft Trident-based browsers including Internet Explorer through to version 9[4]
  • Opera through to version 11

Supporting CSS

{{Reflist}} uses a CSS rule in MediaWiki:Common.css to set the font size:

  • div.reflist { font-size: 90%; }

One of the following classes is assigned by the template when either column count or column width is set:

  • .references-column-count and .references-column-count-n (where n is the numer of columns)
  • .references-column-width

The following CSS properties are utilized using the {{column-count}} and {{column-width}} templates:

  • column-count CSS3 standard
  • column-width CSS3 standard
  • -moz-column-count Mozilla CSS extension
  • -moz-column-width Mozilla CSS extension
  • -webkit-column-count Webkit CSS extension
  • -webkit-column-width Webkit CSS extension

Customizing the view

Template:See By editing your CSS, the personal appearance of the reference list can be customized. From Preferences, select the Appearance tab, then on the selected skin select Custom CSS. After editing and saving, follow the instructions at the top of the page to purge. See Wikipedia:Skin#Customisation (advanced users) for more help.

Font size

The font size for all reference lists defaults to 90% of the standard size. To change it, add:

<source lang="css"> ol.references, div.reflist, div.refbegin { 

   font-size: 90%;

} </source>

Change 90% to the desired size.

Columns

To disable columns, add:

<source lang="css"> .references-column-count, .references-column-width { 

   column-count: 1 !important;
   column-width: auto !important;
   -moz-column-count: 1 !important;
   -moz-column-width: auto !important;
   -webkit-column-count: 1 !important;
   -webkit-column-width: auto !important;

} </source>

Similarly, to force all reference lists to a number of columns, change the number.

Column dividers

To add dividers (rules) between columns, add:

<source lang="css"> .references-column-count, .references-column-width { 

   column-rule: 1px solid #aaa;
   -moz-column-rule: 1px solid #aaa;
   -webkit-column-rule: 1px solid #aaa;

} </source>

You can alter the appearance of the dividers by changing the values.

Bugs

Note that, whereas {{reflist|15em|group="e"}} works as expected, {{reflist|15em |group="e"}} (with an extra space) currently does not display in columns.

Perennial suggestions

Collapsing and scrolling

There have been a number of requests to add functionality for a collapsible or scrolling reference list. These requests have not been fulfilled to due to issues with readability, accessibility, and printing. The applicable guidelines are at MOS:SCROLL. Links between the inline cite and the reference list do not work when the reference list is enclosed in a collapsed box.

To display the reference list in a scrollbox or collapsed per user, see Help:Reference display customization.

For discussion on previous attempts to do this with a template, see the discussions for Scrollref and Refbox.

Including the section title

There have been suggestions to include section header markup such as ==References==. This is inadvisable because:

  • There is no standard section name; see WP:FNNR
  • When transcluded, the article will have an edit link that will confusingly open the template for editing

See also

References

  1. ↑ See User:Edokter/fonttest for a comparison of font sizes for various browsers; see previous discussions on changing the font size to resolve the IE issue.
  2. ↑ Template:Cite web
  3. ↑ Template:Cite web
  4. ↑ Template:Cite web
Retrieved from "https://wiki.erepublik.com/index.php?title=Template:Reflist/doc&oldid=618980"