Last modified byon 2016/06/14 14:47
If you are interested in participating to the XWiki project development itself or in building it from sources, you should refer to the
You still have a question?
XWiki is athat provides all the basic content management and administration features of common wikis, but with much more. XWiki takes the wiki approach to a whole new level by providing enhanced features and capabilities. With XWiki, you can build simple applications, extend the platform with custom plugins, or even build complex Web applications.
- Tool to build Applications without any technical knowledge
- Understanding how XWiki is architected and how to extend it.
- You should start by understanding XWiki's data model of Classes, Properties, and Objects. They'll be needed to build applications at the presentation (document) level.
- Once you understand XWiki's Data Model you'll be able to program directly in the documents you edit. XWiki integrates both Velocity and Groovy scripting. Together, Classes and Scripting will allow you to create basic to complex web applications at the XWiki document layer without the need for compiling code or deploying software components.
- Guide that explains the main XWiki APIs. Quick access to the .
- List all available Extension Points.
- A description of the tools and frameworks used in XWiki. You'll find information about how you can use external libraries such as YUI and SmartClient and internal XWiki libraries for your the development of your in-wiki applications or for the development of XWiki products themselves. You'll also find the documentation of StyleSheet resources created specifically for the XWiki project.
- Reference documentation for the various Modules of XWiki.
- Description of all the possibilities you have to save Data from within the XWiki Platform
- Explains how XWiki URLs work, the format of the and how to configure them.
Tutorials and Guides
- A presentation that explains how to write applications in XWiki (using Velocity, the XWiki Class system, and the API...).
- Demonstrates how to create a FAQ application much like the one you can find on this Wiki , either using Classes/Objects/Sheets/Templates and Scripting or using the to produce a FAQ application. 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.
- Demonstrates how to put Groovy code in one page and then reuse it by importing it from another page.
- Explains how to write an in order to perform some action when an event happens in the wiki. Examples of events are Document changed, Object modified, and more.
- Another helpful tutorial to using XWiki's classes, velocity scripts, hibernate queries for a dashboard.
Shows well the power of XWiki.
- Quick and efficient tutorial to set-up validation using regular expression and groovy scripts, as well as tooltips
- How to develop XWiki Rendering macros (available in XWiki Syntax 2.0 only)
- 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.
- Learn how to write internationalized applications.
- See how you can easily extend the with new custom property types.
- Learn how to use Custom Mapping when you need to map XWiki Classes to your own database tables or when you need extra performance for complex data.
- After you've learnt how to write applications at the document level you may want to go further and program plugins in Java to extend XWiki's view engine, as well as add hooks into different parts of the core engine.
- Tutorial to show how to write a customized SOLR search screen in XWiki for an . For this example we have used the .
- A tutorial on how to perform long-running and expensive operations in XWiki from a background thread using the .
- A tutorial on how to create a tree view for any tree structure you may have in XWiki, using the .
- Shows how to implement a Master-Details view
- A tutorial on how to perform AJAX calls, retrieve JSON results from a Velocity page and to update your application's UI.
- A set of best practices for developing applications with XWiki.
- The API is available as a JavaDoc. It presents the objects and properties that you can access with scripting.
- For advanced users who like to know everything, check out the database tables created by XWiki.