Code Macro
 | Highlights code |
| Type | JAR |
| Category | |
| Developed by | |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Bundled With | XWiki Standard |
Table of contents
Description
See https://pygments.org/languages/ for the list of all supported languages. If you have a hard time finding the right id for the language, you can look at https://pygments.org/docs/lexers/ (Short names).
Usage
The macro can work both in inline mode or standalone mode.
Standalone mode:
... code here...
{{/code}}
Inline mode:
Example
Example result:
Parameters definition
This macro also supports all Box Macro parameters.
| Name | Optional | Allowed values | Default value | Description |
|---|---|---|---|---|
| language | yes | a string | the macro tries to determine the syntax | the language identifier of the provided code snippet. If no language identifier is specified then the macro will try to determine the syntax. To avoid highlight, you can use "none" language identifier. |
| layout | yes |
| plain | XWiki 11.5+ The layout to apply to the code. |
| source | yes | source reference | XWiki 14.10.2+ The reference of a content to highlight instead of the macro content. |
Source
XWiki 14.10.2+
The format of the reference of the source is <source type>:<reference>.
The code macro currently supports the following types of sources:
- string: the reference is the content to highlight ({{code source="string:content to highlight"/}}), it's also the default type when none is provided ({{code source="content to highlight"/}})
- script: the reference is the name of a script binding in the current script context, using it requires SCRIPT right.
{{velocity}} #set($myvar = "some content to highlight") {{/velocity}} {{code source="script:myvar"/}} - entity: the reference is the typed entity reference if the content to highlight, the supported entities are
- document: highlight the content of the document, uses document reference format as in {{code source="document:Space.Document"/}}
- attachment: highlight the content of the attachment, uses document attachment reference format as in {{code source="attachment:Space.Document@file.txt"/}}. By default, it's not allowed to use an attachment bigger than 1MB as source.
- object_property: highlight the content of the object property, uses document object property reference format as in {{code source="object_property:Space.Document^ClassSpace.ClassName.property"/}}
- page: highlight the content of the page, uses page reference format as in {{code source="page:Page/SubPage"/}}
- page_attachment: highlight the content of the attachment, uses page attachment reference format as in {{code source="page_attachment:Page/SubPage/file.txt"/}}. By default, it's not allowed to use an attachment bigger than 1MB as source.
Add support for a new source type
To add support for a new type of source, you need to provide a component implementing role org.xwiki.rendering.macro.code.source.CodeMacroSourceFactory and having as role hint the prefix to use in the source reference.
@Singleton
@Named("mytype")
public class MyCodeMacroSourceFactory implements CodeMacroSourceFactory
{
@Override
public CodeMacroSource getContent(CodeMacroSourceReference reference, MacroTransformationContext context)
throws MacroExecutionException
{
return new CodeMacroSource(reference, getContent(reference.getReference()), getLanguage(reference.getReference()));
}
}
{{code source="mytype:myreference"/}}
Configuration
It's possible to set some configuration for this macro in the xwiki.properties file:
| Name | Optional | Allowed values | Default value | Description |
|---|---|---|---|---|
| rendering.macro.code.pygments.style | yes | a string | default | XWiki 2.4+ the name of the Pygments style to use. See http://pygments.org/docs/styles/ for more about styles. XWiki 16.10.0+ The default style in the context of the code macro has been updated for better contrast. |
| rendering.macro.code.source.attachmentMaximumSize | yes | a size in bytes | 1000000 | XWiki 14.10.2+ Indicate the maximum allowed size for an attachment used as code macro source |
Adding new languages
Anyone can add a new language support by:
- adding a XWiki java component: implementing HighlightParser interface component. See Component Module for more details on how to write component for the new XWiki 2.0 architecture
- the default org.xwiki.rendering.parser.HighlightParser is based on Pygments so the best for both projects is probably to provide a new syntax parser to Pygments project. See http://pygments.org/contribute/.
Example
<html>
<head>Cool!</head>
</html>
{{/code}}
Result
<head>Cool!</head>
</html>
Listing all supported languages
The list is on the Pygments language list. However if you want to dynamically check the list of supported language for the XWiki version used of Pygments, you could put the following in a wiki page, using a user with Programming Rights (and assuming that the Python Macro is installed):
import pygments
from pygments.lexers import get_all_lexers
print "|=Language |=Name |=File Extension |=Mime Types"
for lexer in sorted(get_all_lexers()):
print "| ", lexer[0], " | ", ", ".join(lexer[1]), " | ", ", ".join(lexer[2]), " | ", ", ".join(lexer[3])
{{/python}}
Prerequisites & Installation Instructions
We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager).
You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.
Dependencies
Dependencies for this extension (org.xwiki.platform:xwiki-platform-rendering-macro-code 16.10.1):
- commons-io:commons-io 2.17.0
- org.xwiki.rendering:xwiki-rendering-macro-box 16.10.1
- org.python:jython-slim 2.7.4
- org.pygments:pygments 2.4.2
- org.xwiki.platform:xwiki-platform-security-authorization-api 16.10.1
- org.xwiki.rendering:xwiki-rendering-api 16.10.1
- org.xwiki.rendering:xwiki-rendering-transformation-macro 16.10.1
