cogA rendering transformation to automatically generate page links for WikiWords
TypeJAR
Developed by

XWiki Development Team

Active Installs5
Rating
Rate!
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Enterprise

Compatibility

XWiki 2.6RC1+

Installable with the Extension Manager

Description

A WikiWord consists of two or more words with initial capitals and put together.

When this transformation is active, it automatically generates links for WikiWords. The links are pointing to wiki pages. If those pages don't exist you'll see a question mark symbol on the link, allowing you to create the new page by clicking on it.

For example the following text:

The quick BrownFox jumps over the LazyDog.

Becomes, when rendered:

wikiword1.png

And if the pages exist you'll see instead:

wikiword2.png

Performance considerations

Note that in order to discover WikiWords, this transformation needs to check all words in the page being rendered and is thus relatively costly in term of performance. Although that's probably unnoticeable for small pages it may slow down the page display for large pages.

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). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

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.


This transformation is not active by default. 

To activate it, edit WEB-INF/xwiki.properties, look for a property named rendering.transformations and make sure it's uncommented and contains the value wikiword

For example:

rendering.transformations = macro, icon, wikiword
Make sure you restart your XWiki instance for the change to take effect.

Dependencies

Dependencies for this extension (org.xwiki.rendering:xwiki-rendering-transformation-wikiword 10.7):

Created by Vincent Massol on 2011/12/09 12:45
    

Get Connected