Template:Cite

From Open Energy Information

This is the Cite template. It is used by other templates to display the references assigned to a value supplied from the form. This template will generate the appropriate reference link or citation depending on the value of the reference supplied. It is intended for use with templates supported by forms using the ReferenceForValue template.

Parameters
  1. Subject - The name of property, field, value or thing that you are creating a reference for.
  2. References - An external URL or the name of a reference page.
    • Use a semicolon to separate multiple references.
  3. Note - (Optional) A note to dictate further details regarding the citation.
    • An example of this in use is identifying a specific section of a legal article. Using this technique only requires that a reference be added to the reference library once and use of the note parameter will generate a unique on page citation for each instance of that reference with different note values. This minimizes the need to create multiple references using the same article title but different section names. See below for usage.

Note: Parameters can be called in numerical order, or using parameter name.


Dependencies


Usage

To use Cite in it's most basic form, just invoke the template and pass the name of the thing you are citing followed by the reference, like so:

{{Cite|Asimov's Story|I,_Robot}}

In the above example, the Cite template will build the appropriate <ref/> tags and add the reference to the page. Additionally, if I,_Robot is a page on OpenEI or an external URL, the template will create the appropriate link. If I,_Robot is a page on OpenEI created using the Reference form, then the template will extract the appropriate MLA citation from the reference page and display it!

If I,_Robot doesn't exist yet, the template will return a red link specially coded to open in the Reference form so that it can be easily added later!


Additionally, the Cite template can be used within a template supplied by values from a form, immediate following the referenced value. For example, when displaying Capacity using normal property assignment syntax within a template [[Capacity::{{{Capacity|}}}]], you would add the following immediately after the property declaration:

 {{Cite|Capacity|{{{ReferenceForCapacity|}}}}}

This example assumes the form providing data to the template uses the ReferenceForValue template listed under dependencies above and is typically reserved for advanced wiki editors. In this example, {{Cite|Capacity|{{{ReferenceForCapacity|}}}}} would generate the classic reference carrot ([1]) immediately following the value of Capacity and assign the appropriate semantic relationship between the reference and the value. In this example, {{{ReferenceForCapacity|}}} is the form variable passed to the template automatically from a form using the ReferenceForValue template.


Note

The Note option allows a single reference to be cited multiple times with more detail or depth. A common usage of this option is with legal articles and statutes. Many OpenEI legal references link to a page that contains multiple "sections". Let's use A.R.S. § 40-360.02 as an example. The reference is the Arizona State Legislature page for Article 40-360.02, but the linked page (reference) contains multiple sections, A-G. Often, when citing an article like this, the user may want to identify that a specific section is being cited. The Note option allows a user to do this without having to create unique references for each article section. So, rather than creating a reference for A.R.S. § 40-360.02 Section A and for A.R.S. § 40-360.02 Section F, a user would just create the reference once (A.R.S. § 40-360.02) and then use Note to identify Section A and Section F in the content they are citing.

{{Cite|Subject|A.R.S. § 40-360.02|Section A}}

{{Cite|Subject|A.R.S. § 40-360.02|Section F}}

Using this technique will then generate a unique citation for each article section in the reference part of the page.

With Note, the citations will appear as:
  1. A.R.S. § 40-360.02 (2007). Section A
  2. A.R.S. § 40-360.02 (2007). Section F
Without Note, the citation would appear as:
  1. 1.0 1.1 A.R.S. § 40-360.02 (2007).

Note may only be used when placing the template within text, it does not work with Form Reference Fields


Example

For an example of this in use, please see the sample template and the Sample page that uses it.

Edit the page to see the template text.