Template:Code: Difference between revisions

From OLPC
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 7: Line 7:
'''Good for short code segments:'''
'''Good for short code segments:'''
:{{Code|<nowiki>{{Code|code line}}</nowiki>}}
:{{Code|<nowiki>{{Code|code line}}</nowiki>}}



'''Not so good for longer segments:'''
'''Not so good for longer segments:'''
Line 15: Line 14:


The template form is shorter and easier to enter while editing.
The template form is shorter and easier to enter while editing.
----
Where the argument may contain an equals sign, escape that with nowiki.

For example:
:{{Code|yum install --enablerepo=something}} (did not work properly)
:{{Code|<nowiki>yum install --enablerepo=something</nowiki>}} (worked)
----
----
{{Highlight|bgcolor=yellow|'''Note''': This template is not suitable for blocks of code.}}
{{Highlight|bgcolor=yellow|'''Note''': This template is not suitable for blocks of code.}}

Latest revision as of 22:32, 21 August 2013

{{{1}}}

Usage

Good for short code segments:

{{Code|code line}}

Not so good for longer segments:

This is a long line of code that may have many words that continue for a long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long length.

Used to highlight code samples in an enlarged (through the site's main.css), monospace typeface that is easier to read than the default.

The template form is shorter and easier to enter while editing.


Where the argument may contain an equals sign, escape that with nowiki.

For example:

{{{1}}} (did not work properly)
yum install --enablerepo=something (worked)

Note: This template is not suitable for blocks of code.

  • Instead, see the technique below:

For code blocks

 <nowiki>
Start with a space in the first column,
(before the <nowiki>).

Then your block format will be
    maintained.
 
This is good for copying in code blocks:

def function():
    """documentation string"""

    if True:
        print True
    else:
        print False</nowiki>

Working Example (click edit to see wikicode)

def function():
    """documentation string"""

    if True:
        print True
    else:
        print False