Template:Code

From FreeCAD Documentation
Jump to: navigation, search
{{{1}}}

Use this template when you want to display a block of code.

Since a content that includes an equals sign (=) is interpreted as a variable, you must specify the code= parameter explicitly to avoid issues.

Example:

{{Code|code=
import FreeCAD, Draft
Line = Draft.makeLine(FreeCAD.Vector(0,0,0), FreeCAD.Vector(2,0,0))
}}

Result:

import FreeCAD, Draft
Line = Draft.makeLine(FreeCAD.Vector(0,0,0), FreeCAD.Vector(2,0,0))

If the block of code contains the characters: | (vertical bar) or { } (closing brace or opening brace) do not use this template, as the template won't be parsed correctly. In this cases, you must use the HTML tags <pre> ... </pre>.

<pre>
import FreeCAD, Draft
Draft.makeLine(FreeCAD.Vector(0,0,0), FreeCAD.Vector(2,0,0))
</pre>
import FreeCAD, Draft
Draft.makeLine(FreeCAD.Vector(0,0,0), FreeCAD.Vector(2,0,0))

(2018) Note: This template was modified in the past because the wiki software couldn't handle syntax highlighting correctly. The following information refers to that older template. If the wiki software supports it once more, the template may be redefined to support syntax highlighting again.


This template gives a different coloration depending on the option passed to the template. The default option is python.

  • lang=python
  • lang=cpp
  • lang=java
  • lang=pascal

Other options are be supported.

The template is a simple wrapper around the <syntaxhighlight> ... </syntaxhighlight> tags to show highlighted text. Unlike <syntaxhighlight>, text that does not fit on the screen will be wrapped. See Extension:SyntaxHighlight for a complete list of supported languages.

Warning: The Extension:SyntaxHighlight was disabled because it didn't work anymore on our host.

Original template:

{{#tag:syntaxhighlight|{{{code|{{{1}}}}}}|lang="{{{lang|{{{2|python}}}}}}"|enclose="div"}}

26/09/2016 Mario52 The template was modified because the colour gives one inappropriate tab

{{#tag:syntaxhighlight|{{{code|{{{1}}}}}}|enclose="div"}}