Template:Code: Difference between revisions

From OLPC
Jump to navigation Jump to search
(Created page with '<code>{{{1}}}</code><noinclude> ==Usage== {{Code|<nowiki>{{Code|code line}}</nowiki>}} {{Code|This is a long line of code that may have many words that continue for a long lon…')
 
No edit summary
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<span style="background-color: #FFFFFF;
<code>{{{1}}}</code><noinclude>
border: 1px dotted #d0d0d0;
font-family: monospace, 'Courier New';
font-size: 105%;">{{{1}}}</span><noinclude>


==Usage==
==Usage==
'''Good for short code segments:'''
:{{Code|<nowiki>{{Code|code line}}</nowiki>}}


'''Not so good for longer segments:'''
{{Code|<nowiki>{{Code|code line}}</nowiki>}}
:{{Code|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.}}

{{Code|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.
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.
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.}}
* Instead, see the technique below:


==For code blocks==
==For code blocks==

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