(Quick Reference)

2 Configuration - Reference Documentation

Authors: Masatoshi Hayashi

Version: 1.0-RC2

2.1Supporeted Syntaxes

2.2Macros

2 Configuration

XWiki Plugin's Configuration

2.1 Supporeted Syntaxes

XWiki has multiple Wiki Syntaxes Support.

Supported Syntaxes

If some syntaxes other than "XWiki 2.1" are needed, add a configuration as below in BuildConfig.groovy file.

// BuildConfig.groovy
grails.xwiki.rendering.syntaxes = "mediawiki, jspwiki" // XWiki Syntax Configurationgrails.project.dependency.resolution = {
    // …
}

Syntax	Configuration
Confluence	confluence
Creole	creole
DocBook	docbook
Doxia	doxia
JSPWiki	jspwiki
Markdown	markdown
Plain Text	plain
tex	tex
TWiki	twiki

2.2 Macros

XWiki macros is enabled in the plugin by default. To change this set the grails.xwiki.rendering.macros.enabled to true or false.

// Config.groovy
grails.xwiki.rendering.macros.enabled = false // default true
// ...

Available Macros

XWiki provides some macros officially.

If these macros are needed, add a configuration as below in BuildConfig.groovy file.

// BuildConfig.groovy
grails.xwiki.rendering.macros = "comment, box, toc, footnotes, html, id, message"grails.project.dependency.resolution = {
    // …
}

Macro	Configuration
Box	box
Comment	comment
Footnote	footnotes
HTML	html
Id	id
Info Message, Warning Message, Error Message	message
TOC	toc

<< 1Introduction

3XWiki Macro >>

2 Configuration - Reference Documentation

Table of Contents

2 Configuration

2.1 Supporeted Syntaxes

2.2 Macros

Available Macros

Services

Tags