Admin: 1 revision imported

2026-05-09T17:50:01Z

1 revision imported

← Older revision	Revision as of 10:50, 9 May 2026
(No difference)

enwiki>LabRPS at 20:18, 21 June 2024

2024-06-21T20:18:03Z

New page

{{#tag:syntaxhighlight
|{{{code|{{{1}}}}}}
|lang="{{{lang|{{{2|python}}}}}}"
}}<noinclude>

----

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|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 <code><sintaxhighlight> ... </sintaxhighlight></code> tags, which are converted into appropriate <code><span> ... </span></code> tags with the right color. See the full documentation in [https://www.mediawiki.org/wiki/Extension:SyntaxHighlight Extension:SyntaxHighlight].

----

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

The parameter <code>lang=</code> controls the coloration, depending on the programming language. The default option is <code>lang=python</code>.
* <code>lang=cpp</code>
* <code>lang=xml</code>
* <code>lang=java</code>
* <code>lang=bash</code>

Many more options are be supported.

----

Example 1:

<nowiki>
{{Code|code=
import LabRPS
import Part
Line = Part.makeLine(LabRPS.Vector(0,0,0), LabRPS.Vector(2,0,0))
}}</nowiki>

Result:

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

Example 2:

<nowiki>
{{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";
}
}}</nowiki>

Result:

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

----

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

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

----

Using the Equals sign '=' within this template will result in a broken output.

----

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

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

Result:

{{Code|code=

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

}}

----

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

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

Result:

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

Template:Code - Revision history

Admin: 1 revision imported

enwiki>LabRPS at 20:18, 21 June 2024