Code Blocks - <<code>>

Syntax

<<code [lang=name] [inline={true|false}] [indent=L] [wrap={true|false}]>>
Code goes here
<</code>>

• replace name with the language your example uses, supported languages are listed below
• For indent, replace L with the indent level you want (corresponds to list indent levels)
• For wrap, you can force the lines to wrap or not. The default is for code blocks to scroll.

About

The <<code>> macro allows you to put source code into articles.

A simple example:

<<code>>
from reversion.models import Revision
from .helpers import ProcessedContent
class Node(models.Model):
    language = models.CharField(max_length=10, default='en-us')
<</code>>

...will display as:

from reversion.models import Revision
from .helpers import ProcessedContent
class Node(models.Model):
    language = models.CharField(max_length=10, default='en-us')

Wrapping vs. scrolling

<<code wrap=false>>
if self.is_image:
    return reverse('nodes:image', kwargs={'slug': self.node.slug, 'image_slug': self.slug, 'language': self.node.language})
else:
    return reverse('nodes:attachment', kwargs={'slug': self.node.slug, 'attachment_slug': self.slug, 'language': self.node.language})
<</code>>

...will display as:

if self.is_image:
    return reverse('nodes:image', kwargs={'slug': self.node.slug, 'image_slug': self.slug, 'language': self.node.language})
else:
    return reverse('nodes:attachment', kwargs={'slug': self.node.slug, 'attachment_slug': self.slug, 'language': self.node.language})

<<code wrap=true>>
if self.is_image:
    return reverse('nodes:image', kwargs={'slug': self.node.slug, 'image_slug': self.slug, 'language': self.node.language})
else:
    return reverse('nodes:attachment', kwargs={'slug': self.node.slug, 'attachment_slug': self.slug, 'language': self.node.language})
<</code>>

...will display as:

if self.is_image:
    return reverse('nodes:image', kwargs={'slug': self.node.slug, 'image_slug': self.slug, 'language': self.node.language})
else:
    return reverse('nodes:attachment', kwargs={'slug': self.node.slug, 'attachment_slug': self.slug, 'language': self.node.language})

<<code>> and links

The <<code>> macro does not play nice with links. If you want to have inline code link to something else, use ##...##.

For example, use:

##[[insert|INSERT]]##

instead of

[[insert|<<code>>INSERT<</code>>]]

or

<<code>>[[insert|INSERT]]<</code>>

<<code>> and lists

If you want to build a list and put a block of code inside your list element, especially if you want to resume numbering after your code, you have to put the first line of code on the same line as your list text. (You may need to include "inline=false", but some new/future version of the parser/renderer may be able to deal with this for you. Try it both ways if you're not sure.) For example:

# One
# Two<<code inline=false>>int main(void) {
    return;
}
<</code>>
# Three

1. One
2. Two

   int main(void) {
       return;
   }
   

3. Three

Syntax highlighting

The <<code>> macro also allows you to syntax highlight code. Add syntax highlighting to the above Python example like so:

<<code lang=python>>
from reversion.models import Revision
from .helpers import ProcessedContent
class Node(models.Model):
    language = models.CharField(max_length=10, default='en-us')
<</code>>

from reversion.models import Revision
from .helpers import ProcessedContent
class Node(models.Model):
    language = models.CharField(max_length=10, default='en-us')

Inline or block text

When using the <<code>> macro with the lang= attribute, you can also specify whether you want the code inline with the text that surrounds it, or to have it display in a block. (The Creole parser will attempt to guess what you want if you don't specify this attribute.)

Valid values are true and false.

Here is some <<code lang=c inline=true>>true inline code<</code>>.

Here is some true inline code .

Here is some <<code lang=c inline=false>>false inline code<</code>>.

Here is some

false inline code

.

Here is some <<code lang=c inline=none>>none inline code<</code>>.

Here is some

none inline code

.

Supported languages for syntax highlighting

Formatting

In order to permit creole formatting within a code block, use the <<creole>><</creole>> tags, for example:

<<code>>
some code <<creole>>//italicise me//<</creole>>
more code <<creole>>**bold me**<</creole>>
yet more code
<</code>>

displays as:

some code italicise me
more code bold me
yet more code

The tags need to appear on the same line.