Difference between revisions of "Template:Hint"

From Audacity Wiki
Jump to: navigation, search
(Reverting; last test not too succesful)
(Continued testing; Please ignore)
Line 1: Line 1:
 
<noinclude>{{UserWip}}
 
<noinclude>{{UserWip}}
 
__NOTOC__
 
__NOTOC__
{{intro|The '''''Hint'' Template''' formats text inside a standard pale green box.|}}
+
{{intro|The '''''Hint'' Template''' formats text, intended as additional hints, inside a standard pale green box.|}}
  
  
 
'''Purpose'''
 
'''Purpose'''
  
* This template formats text inside a standardised "hint" box with pale green background. The text should be reasonably concise (preferably one or two sentences) not to override the main contents of the article (should a longer hint be needed, you may consider to make it as a separate section or even a separate page). If a second paragraph is needed, you can use ENTER on the keyboard to create one, just as in normal editing.   
+
* This template formats text inside a standardised "hint" box with pale green background. The text should be reasonably concise (preferably one or two sentences) not to dominate the main contents of the article (should a longer hint be needed, you may consider to make it as a separate section or even a separate page). If a second paragraph is needed, you can use ENTER on the keyboard to create one, just as in normal editing.   
  
  
 
'''Usage of ''Hint'' Template'''
 
'''Usage of ''Hint'' Template'''
 +
  
 
'''General usage:'''
 
'''General usage:'''
Line 16: Line 17:
  
  
'''Alternative:'''
+
'''''Example:'''''
 +
 
 +
''Typing this:''
 +
 
 +
{{code|<nowiki>{{Hint|'''HINT:''' Check out [[Templates]] for more information about the intended use of our templates.}}</nowiki>}} 
  
If the text must contain the equals sign "=" , then the text after the pipe must be enclosed inside {{shortcut|<nowiki> <nowiki> </nowiki> </nowiki>}} tags:
 
  
{{code|<nowiki>{{Hint|<nowiki>This page explains why "2 + 2 = 4" is correct.</nowiki></nowiki><nowiki></nowiki><nowiki>|}}</nowiki>}}
+
''will produce this:''
 +
{{Hint|'''HINT:''' Check out [[Templates]] for more information about the intended use of our templates.}}
 +
 
 +
 
 +
'''Special cases:'''
 +
 
 +
If the text must contain the equals sign "=", then the text after the pipe can be enclosed inside {{shortcut|<nowiki> <nowiki> </nowiki> </nowiki>}} tags:
 +
 
 +
{{code|<nowiki>{{Hint|<nowiki>This page explains why "2 + 2 = 4" is correct.</nowiki></nowiki><nowiki></nowiki><nowiki>}}</nowiki>}}
  
  
Line 26: Line 38:
  
  
'''Example:'''
+
If the text must make use of other templates, however, the entire text string must be preceded by {{shortcut|1=1=}}, like this:
  
'''Typing this:'''
+
{{code|<nowiki>{{Hint|1='''HINT:''' {{external|1=[http://youtube.com/results?search_query=audacity Search Youtube for Audacity]}}.}}</nowiki>}}
  
{{code|<nowiki>{{Hint|'''HINT:''' Check out [[Templates]] for more information about the intended use of our templates.}}</nowiki>}} 
 
  
 +
Which produces:
 +
{{Hint|1='''HINT:''' {{external|1=[http://youtube.com/results?search_query=audacity Search Youtube for Audacity]}}.}}
  
'''will produce this:'''
+
In this example:
{{Hint|'''HINT:''' Check out [[Templates]] for more information about the intended use of our templates.}}  
+
* {{shortcut|&lt;nowiki&gt;&lt;/nowiki&gt;}} can not be used, as it will prevent parsing of the inner template call.
 +
* The inner template call must also contain the {{shortcut|1=1=}} prefix, as its parameter contains an equals sign.
  
 
[[Category:Templates]]
 
[[Category:Templates]]
Line 42: Line 56:
 
''Ignore the following, it's only a representation of formatting and a parameter dummy.''
 
''Ignore the following, it's only a representation of formatting and a parameter dummy.''
 
</noinclude>
 
</noinclude>
{| style="background:#ECFCF4; color:#336633; border:1px solid #999999; font-size:88%" width=90% align="center" cellpadding="10px"
+
{| style="background:#ECFCF4; color:#336633; border:1px solid #999999; font-size:88%" width=90% align="center" cellpadding="5px"
 
|-   
 
|-   
 
|{{{1}}}
 
|{{{1}}}
 
|}
 
|}

Revision as of 14:59, 18 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 Hint Template formats text, intended as additional hints, inside a standard pale green box.


Purpose

  • This template formats text inside a standardised "hint" box with pale green background. The text should be reasonably concise (preferably one or two sentences) not to dominate the main contents of the article (should a longer hint be needed, you may consider to make it as a separate section or even a separate page). If a second paragraph is needed, you can use ENTER on the keyboard to create one, just as in normal editing.


Usage of Hint Template


General usage:

{{Hint| Text to be displayed as a hint }}


Example:

Typing this:

{{Hint|'''HINT:''' Check out [[Templates]] for more information about the intended use of our templates.}}


will produce this:

HINT: Check out Templates for more information about the intended use of our templates.


Special cases:

If the text must contain the equals sign "=", then the text after the pipe can be enclosed inside </nowiki> tags:

{{Hint|<nowiki>This page explains why "2 + 2 = 4" is correct.</nowiki>}}


Similarly, if other essential symbols in the text cause the text to display incorrectly, try enclosing the text inside </nowiki> tags.


If the text must make use of other templates, however, the entire text string must be preceded by 1=, like this:

{{Hint|1='''HINT:''' {{external|1=[http://youtube.com/results?search_query=audacity Search Youtube for Audacity]}}.}}


Which produces:

In this example:

  • <nowiki></nowiki> can not be used, as it will prevent parsing of the inner template call.
  • The inner template call must also contain the 1= prefix, as its parameter contains an equals sign.

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

{{{1}}}