[Solved] Getting a vertical pipe in a code block

[chennes]

I'm trying to document a new feature and to do so I need to display a vertical pipe ("|") inside a block of code, like this:

Code: Select all

{{Code|code=
obj=FreeCAD.ActiveDocument.addObject("App::FeaturePython","InternalObjectName")
obj.Label = "User-friendly label"
obj.addProperty('App::PropertyEnumeration', 'ThePropertyName', 'Subsection', 'Description for tooltip')
obj.ThePropertyName = ["Group 1 | Item A", "Group 1 | Item B", "Group 2 | Another item", "Group 2 | Last item"]  // set allowed items
obj.ThePropertyName = "Group 1 | Item A"                  // choose single item
}}

That code doesn't work, the pipe gets interpreted by MediaWiki, and I can't figure out how to stop it. How do I get a | in a code block?

[openBrain]

Does '{{|}}' or '|' work?

[chennes]

Nope -- they both show up literally.

[Roy_043]

There are two options:

A
Enclose the piping character in nowiki tags:
<nowiki>|</nowiki>

B
Use <syntaxhighlight> tags instead of the {{Code}} template. See https://wiki.freecadweb.org/Help:Editing.

You can also use <pre> tags, but that would mean no syntax highlighting.

BTW
Since PEP8 seems to be quite important in the case of PRs, it would be a good idea if any code samples that are added to the Wiki are also PEP8 compliant.

[Roy_043]

Is // a valid way to start a Python comment?

[chennes]

lol, no, I was just going to write about that -- I fixed it in the code I was editing, but this is copy-and-paste-ware, so it's elsewhere on the page, too.

https://wiki.freecadweb.org/FeaturePyth ... Properties