Template:Code: Difference between revisions

From FreeCAD Documentation
No edit summary
Line 45: Line 45:
The template was modified because the colour gives one inappropriate tab <nowiki>{{#tag:syntaxhighlight|{{{code|{{{1}}}}}}|enclose="div"}} </nowiki>
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]]
[[Category:Administration]]



Revision as of 19:31, 7 December 2018

{{{1}}} 

Use this template when you want to display code, for example :

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

results in

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


Note:

  1. Since a content that includes an equals sign (=) is interpreted as a variable, you must specify the code= parameter explicitly to avoid issues (as in the above example)
  2. If the macro code contains the characters: "|" (vertical bar) or "{ }" (closing brace or opening brace) do not use this template, as the macro won't be parsed correctly; for 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))

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> tag to show syntax-highlighted text. Unlike <syntaxhighlight>, text that does not fit on the screen will be wrapped. See <syntaxhighlight> for a complete list of supported languages.

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