Template:Code

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

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

This template should not be used to contain verbatim macro code in the Macros recipes pages. Macro code must be plain, free of any syntax highlight. For this, use Template:MacroCode.

This template essentially creates a block of text surrounded by wiki <sintaxhighlight> ... </sintaxhighlight> tags, which are converted into appropriate <span> ... </span> tags with the right color. See the full documentation in Extension:SyntaxHighlight.


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

The parameter lang= controls the coloration, depending on the programming language. The default option is lang=python.

  • lang=cpp
  • lang=xml
  • lang=java
  • lang=bash

Many more options are be supported.


Example 1:

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

Result:

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

Example 2:

{{Code|lang=cpp|code=
DEF_STD_CMD_A(StdCmdMyCommand);

StdCmdMyCommand::StdCmdMyCommand()
  : Command("Std_My_Command")
{
    sMenuText     = QT_TR_NOOP("My Command");
    sToolTipText  = QT_TR_NOOP("Runs my command in the active document");
    sWhatsThis    = "Std_MyCommand";
    sPixmap       = "MyCommand.svg";
}
}}

Result:

DEF_STD_CMD_A(StdCmdMyCommand);

StdCmdMyCommand::StdCmdMyCommand()
  : Command("Std_My_Command")
{
    sMenuText     = QT_TR_NOOP("My Command");
    sToolTipText  = QT_TR_NOOP("Runs my command in the active document");
    sWhatsThis    = "Std_MyCommand";
    sPixmap       = "MyCommand.svg";
}

Inside the code, neither the double nor the triple braces {{ }}, nor the vertical bar | are allowed because these are interpreted in special ways by the wiki software.

{{Code|code=
a = {{"A"}, "B"}
if a:
    Q = Qt.Ok | Qt.Cancel
}}

The <nowiki> ... </nowiki> tags can be added explicitly to allow displaying these special symbols.

{{Code|code=
<nowiki>
a = {{"A"}, "B"}
if a:
    Q = Qt.Ok | Qt.Cancel
</nowiki>
}}

Result:

a = {{"A"}, "B"}
if a:
    Q = Qt.Ok | Qt.Cancel

We can also display all symbols by using explicit <pre> ... </pre> tags. In this case, no syntax highlighting will exist, but the code will be displayed with all symbols intact.

<pre>
a = {{"A"}, "B"}
if a:
    Q = Qt.Ok | Qt.Cancel
</pre>

Result:

a = {{"A"}, "B"}
if a:
    Q = Qt.Ok | Qt.Cancel

Older information

(2020) Note: After the migration to the DigitalOcean servers, the wiki software once again handles syntax highlighting, so this template once more uses it.

(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.


Simplest template:

{{#tag:pre|{{{code|{{{1}}}|style="color:black"}}}}}

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"}}