Template:Code - Revision history

LabRPS at 20:18, 21 June 2024

2024-06-21T20:18:03Z

← Older revision		Revision as of 13:18, 21 June 2024
Line 106:		Line 106:

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

LabRPS at 20:01, 21 June 2024

2024-06-21T20:01:21Z

← Older revision		Revision as of 13:01, 21 June 2024
Line 87:		Line 87:
	----		----

	Using the Equals sign '=' within this template will result in a broken output. ~~Use the https://wiki.freecadweb.org/Template:= to circumvent this~~		Using the Equals sign '=' within this template will result in a broken output.

LabRPS at 19:59, 21 June 2024

2024-06-21T19:59:06Z

← Older revision		Revision as of 12:59, 21 June 2024
Line 7:		Line 7:

	Use this template when you want to display a block of code.		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].		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].
Line 24:		Line 26:
	----		----

	Example:		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>		<nowiki>
	{{Code\|lang=cpp\|code=		{{Code\|lang=cpp\|code=
	DEF_STD_CMD_A(~~WindSimulationMethod~~);		DEF_STD_CMD_A(StdCmdMyCommand);

	~~WindSimulationMethod~~::~~WindSimulationMethod~~()		StdCmdMyCommand::StdCmdMyCommand()
	: ~~methodName~~("~~Deodatis et al~~")		: Command("Std_My_Command")
	{		{
	~~computationTime~~ = 0;		sMenuText = QT_TR_NOOP("My Command");
			sToolTipText = QT_TR_NOOP("Runs my command in the active document");
			sWhatsThis = "Std_MyCommand";
			sPixmap = "MyCommand.svg";
	}		}
	}}</nowiki>		}}</nowiki>
Line 40:		Line 62:

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

	~~WindSimulationMethod~~::~~WindSimulationMethod~~()		StdCmdMyCommand::StdCmdMyCommand()
	: ~~methodName~~("~~Deodatis et al~~")		: Command("Std_My_Command")
	{		{
	~~computationTime~~ = 0;		sMenuText = QT_TR_NOOP("My Command");
			sToolTipText = QT_TR_NOOP("Runs my command in the active document");
			sWhatsThis = "Std_MyCommand";
			sPixmap = "MyCommand.svg";
	}		}
	}}		}}
Line 93:		Line 118:

	<nowiki><pre>		<nowiki><pre>
	a = "A";		a = {{"A"}, "B"}
	if ~~(b)~~		if a:
	{Q = Qt.Ok \| Qt.Cancel;}		Q = Qt.Ok \| Qt.Cancel
	</pre></nowiki>		</pre></nowiki>

Line 101:		Line 126:

	<pre>		<pre>
	a = "A";		a = {{"A"}, "B"}
	if ~~(b)~~		if a:
	{Q = Qt.Ok \| Qt.Cancel;}		Q = Qt.Ok \| Qt.Cancel
	</pre>		</pre>

	~~[[Category:Template:Text Format]]~~
	~~[[Category:Administration]]~~

	~~</noinclude>~~

LabRPS at 16:43, 12 August 2022

2022-08-12T16:43:09Z

← Older revision		Revision as of 09:43, 12 August 2022
Line 7:		Line 7:

	Use this template when you want to display a block of code.		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].		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].
Line 95:		Line 93:

	<nowiki><pre>		<nowiki><pre>
	a = {{"A"~~}, "B"}~~		a = "A";
	if a:		if (b)
	Q = Qt.Ok \| Qt.Cancel		{Q = Qt.Ok \| Qt.Cancel;}
	</pre></nowiki>		</pre></nowiki>

Line 103:		Line 101:

	<pre>		<pre>
	a = {{"A"~~}, "B"}~~		a = "A";
	if a:		if (b)
	Q = Qt.Ok \| Qt.Cancel		{Q = Qt.Ok \| Qt.Cancel;}
	</pre>		</pre>


	~~== 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:~~

	~~<nowiki>~~
	~~{{#tag:pre\|{{{code\|{{{1}}}\|style="color:black"}}}}}</nowiki>~~

	~~----~~

	~~Original template:~~

	~~<nowiki>~~
	~~{{#tag:syntaxhighlight\|{{{code\|{{{1}}}}}}\|lang="{{{lang\|{{{2\|python}}}}}}"\|enclose="div"}}</nowiki>~~

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

	~~<nowiki>~~
	~~{{#tag:syntaxhighlight\|{{{code\|{{{1}}}}}}\|enclose="div"}}</nowiki>~~

	[[Category:Template:Text Format]]		[[Category:Template:Text Format]]

LabRPS at 18:48, 7 August 2022

2022-08-07T18:48:29Z

← Older revision		Revision as of 11:48, 7 August 2022
Line 26:		Line 26:
	----		----

	Example 1:		Example:

	~~<nowiki>~~
	~~{{Code\|code=~~
	~~import FreeCAD~~
	~~import Draft~~
	~~Line = Draft.makeLine(FreeCAD.Vector(0,0,0), FreeCAD.Vector(2,0,0))~~
	~~}}</nowiki>~~

	~~Result:~~

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

	~~Example 2~~:

	<nowiki>		<nowiki>
	{{Code\|lang=cpp\|code=		{{Code\|lang=cpp\|code=
	DEF_STD_CMD_A(~~StdCmdMyCommand~~);		DEF_STD_CMD_A(WindSimulationMethod);

	~~StdCmdMyCommand~~::~~StdCmdMyCommand~~()		WindSimulationMethod::WindSimulationMethod()
	: ~~Command~~("~~Std_My_Command~~")		: methodName("Deodatis et al")
	{		{
	~~sMenuText~~ = ~~QT_TR_NOOP("My Command");~~		computationTime = 0;
	~~sToolTipText = QT_TR_NOOP("Runs my command in the active document");~~
	~~sWhatsThis = "Std_MyCommand";~~
	~~sPixmap = "MyCommand.svg"~~;
	}		}
	}}</nowiki>		}}</nowiki>
Line 62:		Line 42:

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

	~~StdCmdMyCommand~~::~~StdCmdMyCommand~~()		WindSimulationMethod::WindSimulationMethod()
	: ~~Command~~("~~Std_My_Command~~")		: methodName("Deodatis et al")
	{		{
	~~sMenuText~~ = ~~QT_TR_NOOP("My Command");~~		computationTime = 0;
	~~sToolTipText = QT_TR_NOOP("Runs my command in the active document");~~
	~~sWhatsThis = "Std_MyCommand";~~
	~~sPixmap = "MyCommand.svg"~~;
	}		}
	}}		}}

Admin: 1 revision imported

2022-08-06T15:00:45Z

1 revision imported

← Older revision	Revision as of 08:00, 6 August 2022
(No difference)

en>Roy 043: Removed |enclose="div"

2021-05-05T06:58:55Z

Removed |enclose="div"

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 FreeCAD
import Draft
Line = Draft.makeLine(FreeCAD.Vector(0,0,0), FreeCAD.Vector(2,0,0))
}}</nowiki>

Result:

{{Code|code=
import FreeCAD
import Draft
Line = Draft.makeLine(FreeCAD.Vector(0,0,0), FreeCAD.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. Use the https://wiki.freecadweb.org/Template:= to circumvent this

----

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

----

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>

== 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:

<nowiki>
{{#tag:pre|{{{code|{{{1}}}|style="color:black"}}}}}</nowiki>

----

Original template:

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

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

<nowiki>
{{#tag:syntaxhighlight|{{{code|{{{1}}}}}}|enclose="div"}}</nowiki>

[[Category:Template:Text Format]]
[[Category:Administration]]

</noinclude>