Template:Code/doc: Difference between revisions From Online Manual

Jump to: navigation, search
(how to use the code template)
 
(tried to simplify and clarify the warnings.)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
This template is used to style code, in circumstances where the <nowiki><code></nowiki> does not do the job.
This template is used to style blocks of code. It adds a horizontal line above and below the code block.  
It adds a horizontal line above and below the code block.
It makes sure that the code block does not jump in and out of <nowiki><pre></nowiki> mode as you increase and decrease indentation.
 
To avoid the most common problems with this template, explicitly name the parameter, and do not start the parameter contents with "wiki-removable whitespace". Any occurance of <nowiki>|</nowiki> in the code must be replaced by &#124; or {{tl|!}}
<pre>{{code
<pre>{{code
|1=&amp;nbsp;  &lt;td align="right" class="catbg"&gt;
|1=&amp;nbsp;  &lt;td align="right" class="catbg"&gt;
Line 13: Line 9:
     &lt;/td&gt;}}
     &lt;/td&gt;}}


For more information on the use of "=" and <nowiki>|</nowiki> within parameter values, please see [http://meta.wikimedia.org/wiki/Help:Template Meta:Help:Template]
The <nowiki><code></nowiki> tag should be used, instead, for inline code fragments, but will not do a good job with multi-line fragments in which some lines are indented and some are not.
 
Here are three simple rules to follow that will help you show your code the way you want it.
# If your code fragment begins with whitespace (space or tabs), stop the wiki-parser from "eating" those spaces in one of these ways
#*Enclose your code in &lt;nowiki&gt; tags
#*Start your code with a non-whitespace character (add a blank comment line, for example)
#*Start your code with a &amp;nbsp; character
# '''<nowiki>|</nowiki>''' in your code will confuse the wiki parser terribly. Use {{tl|!}} or &amp;#124; instead. See [http://meta.wikimedia.org/wiki/Help:Template Meta:Help:Template] for more on how the {{|}} is used within wiki templates.
# '''=''' in your code will confuse the wiki parser UNLESS you use <code>'''{{|}}1='''</code> before it.  Otherwise, the parser thinks everything before the fires '''=''' is the name of some wiki template parameter, and you'll see no code displayed at all.  [http://meta.wikimedia.org/wiki/Help:Template Meta:Help:Template] for more on this.

Latest revision as of 15:12, 12 October 2012

This template is used to style blocks of code. It adds a horizontal line above and below the code block.

{{code
|1=&nbsp;   <td align="right" class="catbg">
        <img src="', $settings['images_url'], '/smflogo.gif" style="margin: 2px;" alt="" />
    </td>}}
    <td align="right" class="catbg">
        <img src="', $settings['images_url'], '/smflogo.gif" style="margin: 2px;" alt="" />
    </td>

The <code> tag should be used, instead, for inline code fragments, but will not do a good job with multi-line fragments in which some lines are indented and some are not.

Here are three simple rules to follow that will help you show your code the way you want it.

  1. If your code fragment begins with whitespace (space or tabs), stop the wiki-parser from "eating" those spaces in one of these ways
    • Enclose your code in <nowiki> tags
    • Start your code with a non-whitespace character (add a blank comment line, for example)
    • Start your code with a &nbsp; character
  2. | in your code will confuse the wiki parser terribly. Use {{!}} or &#124; instead. See Meta:Help:Template for more on how the {{|}} is used within wiki templates.
  3. = in your code will confuse the wiki parser UNLESS you use {{|}}1= before it. Otherwise, the parser thinks everything before the fires = is the name of some wiki template parameter, and you'll see no code displayed at all. Meta:Help:Template for more on this.


Advertisement: