Difference between revisions of "Template:Instruction"

From Audacity Wiki
Jump to: navigation, search
m (Just working; Ignore)
(Beta status; for Gale)
Line 8: Line 8:
 
'''Usage of ''Instruction'' Template'''
 
'''Usage of ''Instruction'' Template'''
  
The text should be reasonably concise (preferably one or two sentences) 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. If a second paragraph is needed in the hint, you can use ENTER on the keyboard to create one, just as in normal editing.   
+
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.
 +
 
 +
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 editing.   
  
  
Line 20: Line 22:
 
''Typing this:''
 
''Typing this:''
  
{{code|<nowiki>{{Instruction|'''HINT:''' If you don't see any input, make sure you have plugged in the microphone correctly.}}</nowiki>}}   
+
{{code|<nowiki>{{Instruction|</nowiki>Please make sure you do:
 +
# this 
 +
# this and
 +
# this<nowiki>}}</nowiki>}}   
  
  
 
''will produce this:''
 
''will produce this:''
{{Instruction|'''HINT:''' If you don't see any input, make sure you have plugged in the microphone correctly.}}  
+
{{Instruction|Please make sure you do:
 +
# this 
 +
# this and
 +
# this}}  
  
  
 
'''Special cases:'''
 
'''Special cases:'''
  
If the text must contain the equals sign "=", use '''&quot;1=&quot;''' after the pipe symbol "|" thus:
+
If the text must contain the equals sign "'''='''", use &quot;'''1='''&quot; after the pipe symbol "'''|'''" thus:
  
 
{{code|<nowiki>{{Instruction|1=The above also explains why 2 + 2 = 4.}}</nowiki>}}
 
{{code|<nowiki>{{Instruction|1=The above also explains why 2 + 2 = 4.}}</nowiki>}}
Line 39: Line 47:
  
  
However, '''<nowiki> <nowiki> </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:
+
However, '''<nowiki> <nowiki> </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:
  
{{code|<nowiki>{{Instruction|1='''HINT:''' {{external|1=[http://youtube.com/results?search_query=audacity Search Youtube for Audacity]}}.}}</nowiki>}}
+
{{code|<nowiki>{{Instruction|1=Go to {{external|1=[http://youtube.com/results?search_query=audacity Search Youtube for Audacity]}}.}}</nowiki>}}
  
  
 
which produces:
 
which produces:
{{Instruction|1='''HINT:''' {{external|1=[http://youtube.com/results?search_query=audacity Search Youtube for Audacity]}}.}}
+
{{Instruction|1=Go to {{external|1=[http://youtube.com/results?search_query=audacity 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.
+
Note also that in this example the second template must itself contain the "'''1='''" prefix, as its URL contains an equals sign.
  
  

Revision as of 19:08, 21 November 2007

Example.png

This page is a User "Work in Progress"

Please let the claimant work with it at least two weeks after this sticker was put up (or until this sticker has been removed, if earlier).

Suggestions may be made to the claimant by clicking on the page's "discussion" tab.

The Instruction Template formats text inside a standard pale yellow box. It should be used sparingly for ...


NOTE: This template should be used only for instructions such as instruction sets or other essential information that needs to be emphasised. For the current list of 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.

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 editing.


General usage:

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


Example:

Typing this:

{{Instruction|Please make sure you do:
  1. this
  2. this and
  3. this}}


will produce this:

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


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.

{{{1}}}