Difference between revisions of "Template:Note/help"

From Sugar Labs
Jump to navigation Jump to search
 
Line 1: Line 1:
#REDIRECT [[Template:Admon/faq]]
+
{{message|bgcolor=#f9f6b7|{{#if:{{{1|}}}|'''{{{1}}}'''<BR>}}<noinclude>'''Bold headword'''<br></noinclude>{{#if:{{{2|}}}|{{{2}}}}}<noinclude>extended help request or helpful tip</noinclude>|image=question.png}}<noinclude>
 +
 
 +
==Usage==
 +
<nowiki>{{Admon/help|Bold headword (optional)|extended help request or message text}}</nowiki>
 +
 
 +
real example:
 +
{{Admon/help|Please help!|We need someone who understands filesystems to explain this more clearly.}}
 +
 
 +
or:
 +
{{Admon/help|Help tip for pasting code blocks in the wiki:|Put a space in the first column before<code><nowiki> <nowiki></nowiki></code>followed by a block of code with indentations and newlines to preserve the code block formatting. See below:}}
 +
<nowiki>function () {
 +
    """This is the __doc__ str"""
 +
   
 +
    _local_variable = 'set here'
 +
    if _local_variable is not None:
 +
        this_code_will_execute(self, _local_variable)
 +
</nowiki>
 +
 
 +
[[Category:Admonition template|help]]
 +
</noinclude>

Revision as of 15:00, 29 January 2011

Question.png
Bold headword
extended help request or helpful tip

Usage

{{Admon/help|Bold headword (optional)|extended help request or message text}}

real example: Template:Admon/help

or: Template:Admon/help

function () {
    """This is the __doc__ str"""
    
    _local_variable = 'set here'
    if _local_variable is not None:
        this_code_will_execute(self, _local_variable)