Tutorials

Creating a FAQ application

Demonstrates how to combine Classes and Scripting to produce a FAQ application, much like the one you can find on this Wiki FAQ page. This is a very simple application that makes use of XWiki's classes, properties, and objects. It also introduces the concept of Authoring Templates and Page Design Sheets. Completing this tutorial is a recommended prerequisite for anyone who wants to build custom applications on the XWiki engine at the document or presentation layer.

Creating a Groovy Class

Demonstrates how to put Groovy code in one page and then reuse it by importing it from another page, be it using Velocity or Groovy.

Notifications

Explains how to register a listener for performing some action when an event happens in the wiki. Examples of events are Document changed, Object modified, and more.

Creating a TODO application in XWiki

Another helpful tutorial to using XWiki's classes, velocity scripts, hibernate queries for a dashboard. Shows well the power of XWiki.

Creating a form with validation and tooltips

Quick and efficient tutorial to set-up validation using regular expression and groovy scripts, as well as tooltips

Writing an XWiki Rendering Macro

A step by step tutorial for writing a Rendering Macro.

Writing an XWiki Component

Getting started with the new XWiki components architecture: introduction to this new design, a step-by-step guide to writing an XWiki component (the recommended way of creating XWiki plugins) and some guidelines and development good practices in this area.

Using the Cache component

How to create a cache and use it.

Skin eXtensions

Illustrate XWiki's Skin eXtensions mechanism that allows developers to pull extra Javascript and stylesheet files on demand or for all wiki pages without modifying the wiki templates and skin. The tutorial guides through the creation of minimal stylesheet and Javascript extensions, and continues with a complete exemple of a real-world extension to demonstrate the power of XWiki's skin eXtensions!

Contributions from the user community

How to add metadata to your pages & search it with Lucene under approval by the community

• how to add support for metadata attached to wiki pages
• how to automate adding of default metadata (or automatically computed metadata, since you can easily customize the meatadataplugin) for existing documents
• how to integrate your metadata into Lucene
• how to make the metadata "searchable" with Lucene