Template:Introrel

From Audacity Wiki
Jump to: navigation, search
The Introrel Template is an alternative to the Intro Template which can be used to add a bulleted list of related articles underneath the blue header box of the introduction. The list may contain links to either Wiki articles or to external web pages. Items in the list should either be an expanded treatment of material in the current page (such a link should be repeated in the main text), or might be related in terms of covering a different aspect of the same broad subject. An example of the latter might be a related article covering recording techniques for instrumentalists on a page concerned with vocal recording techniques.


Usage of Introrel Template

The template will produce your required introduction inside a blue header box as described at Template:Intro, followed by an indented section of text underneath, complete with the header "Related article(s):". The author must then provide a bulleted list of articles as described below, using the asterisk (*) character to provide the list bullet. The asterisk for the first bullet is produced by the template.


General usage:

{{Introrel| Introductory text to be displayed unemphasised | Introductory text to be displayed italicised and centred (if any) | 1st item in list of references then HIT ENTER to move to new line

* 2nd item in list of references }}


Alternative:

If all your introductory is to be displayed without emphasis, you must still supply the second pipe symbol "|" to demarcate the second section, so that after your unemphasised text, you have two pipe symbols followed by your list of references:

{{Introrel| Introductory text to be displayed unemphasised | | 1st item in list of references then HIT ENTER to move to new line

* 2nd item in list of references }}


Note that if the pipe symbol is missing, only a dummy parameter will be displayed instead of your intended text.


Example 1: Unemphasised text in introduction, single item in list

Typing this:

{{Introrel| This page has information on the WAV format. | | [[AIFF]] }}


will produce this:

This page has information on the WAV format.
 
Related article(s):


Example 2: Unemphasised and emphasised text in introduction, two items in list

Typing this:

{{Introrel| This page has information on the WAV format. |Please do not confuse with the WavPack format! | [[AIFF]]

* [[FLAC]] }}


will produce this:

This page has information on the WAV format.
Please do not confuse with the WavPack format!
 
Related article(s):


Special cases:

If text in any of the three sections:

  1. The opening, unemphasised text
  2. The emphasised text
  3. The list of references

contains any equals signs ("=") or employs other templates, notably the {{external|...}} template, that string of text must be preceded by "1=", "2=" or "3=" according to the section it occurs in. Here are two examples:


Example 3: Unemphasised text in introduction, external link in list

Typing this:

{{Introrel| This page has information on the WAV format. | | 3= {{external|1=[http://wavmasters.com/results?query=wav History of WAV format ]}}}}


will produce this:

This page has information on the WAV format.
 
Related article(s):


Example 4: Unemphasised and emphasised text in introduction, external links in emphasised text and list

Typing this:

{{Introrel|This page has information on the WAV format.|2=Please do not confuse with the {{external|[http://www.wavpack.com/ WavPack format]}}!|3={{external|1=[http://wavmasters.com/results?query=wav History of WAV format]}}}}


will produce this:

This page has information on the WAV format.
Please do not confuse with the WavPack format !
 
Related article(s):


Note in both these examples that each instance of the other template being used must itself employ the "1=" prefix, where its parameter (the URL) contains an equals sign. "1=" is used (not 2= or 3= according to the section of {{Introrel|...}} it occurs in), as it occurs in the first section of {{external|...}}. However it's fine to include the "1=" even in a link that does not contain an equals sign, as the text will still display correctly.


Ignore the following, it's only a representation of formatting and a parameter dummy.


{{{1}}}
{{{2}}}
 
Related article(s):
  • {{{3}}}
Personal tools

Donate securely by PayPal, using your credit card or PayPal account!