Template:Instruction

From Audacity Wiki
Jump to: navigation, search
The Instruction Template formats text inside a standard pale yellow box with a bold, center-aligned INSTRUCTIONS header. It should be used only for instruction sets and only sparingly (it would be exceptional to use it more than once on the same page).
Template:Advice is also available for emphasizing more generalized essential information. It has the same background color, but lets the user choose what header text to use, or none at all. For all available templates, see Templates.


Usage of Instruction Template

The text should be reasonably concise (preferably no more than ten lines) so as not to dominate the main contents of the article. Should a longer instruction be needed, consider making it a separate section, or if necessary a separate article (page) linked to from the current article. That link itself should be inside an Instruction Template so as to give the best chance that users will pay attention to it and click through to the actual instructions.

When a new paragraph or list item is needed in the instruction, you can use ENTER on the keyboard to create one, just as in normal Wiki editing.


General usage:

{{Instruction| Text to be displayed as instructions }}


Example:

Typing this:

{{Instruction|Please make sure you do:

# this
# that and
# the other}}


will produce this:

INSTRUCTIONS
Please make sure you do:
  1. this
  2. that and
  3. the other


Special cases:

If the text must contain the equals sign "=", use "1=" after the pipe symbol "|" thus:

{{Instruction|1=The above also explains why 2 + 2 = 4.}}


If other essential symbols in the text still cause it to display incorrectly, try enclosing the text after the pipe inside <nowiki> </nowiki> tags. This solution would also work with the above example:

{{Instruction|<nowiki>The above also explains why 2 + 2 = 4.</nowiki>}}


However, <nowiki> </nowiki> tags will not work if you need to use another template inside the Instruction template, as they will prevent the other templates being parsed. In this case, the only solution is to precede the entire text string after the first pipe by "1=", like this:

{{Instruction|1=Go to {{external|1=[http://youtube.com/results?search_query=audacity Search Youtube for Audacity]}}.}}


which produces:

INSTRUCTIONS
Go to Search Youtube for Audacity .


Note also that in this example the second template must itself contain the "1=" prefix, as its URL contains an equals sign.


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

INSTRUCTIONS
{{{1}}}