Template:MacroCode

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

Use this template to contain verbatim macro code in the Macros recipes pages.

This is similar to Template:Code, but without any syntax highlighting.

This template essentially creates a block of text surrounded by HTML <pre> ... </pre> tags, which the Addon Manager downloads and extracts.

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

Example:

{{MacroCode|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))

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.

{{MacroCode|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.

{{MacroCode|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.

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

Result:

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