org.xwiki.rendering.configuration
Interface RenderingConfiguration

@ComponentRole
public interface RenderingConfiguration

Configuration properties for the Rendering module.

You can override the default values for each of the configuration properties below by defining them in XWiki's global configuration file using a prefix of "rendering" followed by the property name. For example: rendering.linkLabelFormat = %s.%p

Since:

1.6M1

Version:

$Id: RenderingConfiguration.java 32245 2010-10-28 15:15:10Z vmassol $

Method Summary

java.util.Properties	getInterWikiDefinitions()
java.lang.String	getLinkLabelFormat() A link label format is the format used to decide how to display links that have no label.
java.util.List<Transformation>	getTransformations()

Method Detail

getLinkLabelFormat

java.lang.String getLinkLabelFormat()

A link label format is the format used to decide how to display links that have no label. By default the page name is displayed. However it's possible to customize it using the following tokens:

• %w: wiki name
• %s: space name
• %p: page name
• %P: page name with spaces between camel case words, i.e. "My Page" if the page name is "MyPage"
• %t: page title

Note that if the page title is empty or not defined then it defaults to %p. This is also the case if the title cannot be retrieved for the document. The default is "%p". Some examples: "%s.%p", "%w:%s.%p".

Returns:

the format to use to display link labels when the user hasn't specified a label

getInterWikiDefinitions

java.util.Properties getInterWikiDefinitions()

Returns:

the list of InterWiki definitions. Each InterWiki definition is made of an alias and a base URL.

See Also:

InterWikiResourceReference

getTransformations

java.util.List<Transformation> getTransformations()

Returns:

the list of transformations to execute when rendering document content, ordered by transformation priority (highest priority first)

Since:

2.6RC1