Supported brushes/syntaxes.
Engine uses brush parameter value to determine the proper syntax parser. You specify it inside class parameter of codecitation tag:
{codecitation class="brush:BRUSH-NAME-HERE"}
The following brush parameter values/syntaxes are supported:
as3, actionscript3,bash, shell, c-sharp, csharp, cpp, c, css, delphi, pas, pascal, diff, patch, groovy, js, jscript, javascript, java, jfx, javafx ,perl, pl, php, plain, ps, powershell, text, py, python, rails, ror, ruby, scala, sql, vb, vbnet, xml, xhtml, xslt, html, xhtml
Additional parameters.
To customize the appearance/behaviour of the citation, you may specify additional parameters values for the engine right after brush name inside parameters string:
{codecitation class="brush:brush-name-here; PARAMETER-NAME: PARAMETER-VALUE; PARAMETER-NAME: PARAMETER-VALUE;"}
Where PARAMETER-NAME is one of the following:
| Name |
Value example |
Description |
| auto-links |
true |
Allows you to turn detection of links in the highlighted element on and off. If the option is turned off, URLs won't be clickable. |
| collapse |
false |
Allows you to force highlighted elements on the page to be collapsed by default. |
| first-line |
1 |
Allows you to change the first (starting) line number. |
| gutter |
true |
Allows you to turn gutter with line numbers on and off. |
| highlight |
[1, 2, 3] |
Allows you to highlight one or more lines to focus user's attention. When specifying as a parameter, you have to pass an array looking value, like [1, 2, 3] or just an number for a single line. |
| html-script |
false |
Allows you to highlight a mixture of HTML/XML code and a script which is very common in web development. Click here for a demo. |
| light |
false |
Allows you to show column ruler on top of highlighted elements. |
| ruler |
false |
Allows you to show column ruler on top of highlighted elements. |
| smart-tabs |
true |
Allows you to turn smart tabs feature on and off.
|
| toolbar |
true |
Toggles toolbar on/off. |
| wrap-lines |
true |
Allows you to turn line wrapping feature on and off. |
See examples to get the idea.
Additional parameters that engine supports are described on the original engine's documentation page.
|