Difference between revisions of "Template:Note/faq"

From Sugar Labs
Jump to navigation Jump to search
Line 1: Line 1:
{{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>
+
{{message|bgcolor=#f9f6b7|{{#if:{{{1|}}}|'''{{{1}}}'''<BR>}}<noinclude>'''Bold headword'''<br></noinclude>{{#if:{{{2|}}}|{{{2}}}}}<noinclude>extended helpful tip</noinclude>|image=question-answer.png}}<noinclude>
  
 
==Usage==
 
==Usage==
  <nowiki>{{Admon/help|Bold headword (optional)|extended help request or message text}}</nowiki>
+
  <nowiki>{{Admon/help|Bold headword (optional)|extended helpful tip text}}</nowiki>
  
 
real example:
 
real example:
{{Admon/help|Please help!|We need someone who understands filesystems to explain this more clearly.}}
+
{{Admon/faq|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:}}
 
 
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 () {
 
  <nowiki>function () {
 
     """This is the __doc__ str"""
 
     """This is the __doc__ str"""
Line 17: Line 14:
 
</nowiki>
 
</nowiki>
  
[[Category:Admonition template|help]]
+
[[Category:Admonition template|faq]]
 
</noinclude>
 
</noinclude>

Revision as of 13:58, 29 January 2011

Question-answer.png
Bold headword
extended helpful tip

Usage

{{Admon/help|Bold headword (optional)|extended helpful tip text}}

real example: Template:Admon/faq

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