XWiki Documentation Home Page

XWiki Documentation Home Page

Welcome to the XWiki documentation home. You can use this page to navigate to the product documentation you are interested in. Click here to access the French documentation.

XWiki Cloud

XWiki Cloud introduces a new default Wysiwyg editor - CKEditor - the old editor is still available and it can be enabled by wiki administrators from the "Edit Mode Settings" section of the preferences page.

If you are new to XWiki, the user guide is the perfect place to start learning about XWiki basics, such as nested and terminal pages, editing modes and also about how to edit your user profile and user preferences

XWiki Standard

Online Version User Guide Admin Guide Developer Guide

XWiki Standard 9.8.1 is the latest recommended version for production installs and comes with additional CKEditor and notifications features, improved avatar image quality, wiki and page administration menu changes, syntax highlighting and much more. 

If you are new to XWiki, the user guide is the perfect place to start learning about XWiki basics, such as nested and terminal pages, editing modes, the CKEditor and also about how to edit your user profile and user preferences

The administrator guide is for advanced users having administration rights. This documentation will help you perform more complex tasks on your wiki, such as creating users and groups or panels, handling access rights or customizing the look and feel of the wiki. 

The developer guide brings an overview of the XWiki Data Model, a reference of the XWiki API, a summary of the XWiki Widgets, macros, Platform Plugins and Platform Modules as well as some advanced examples of how to customize your wiki. 

The videos section offers some interesting tutorials on how to use XWiki. 

XWiki Standard 9.8.1 Overview

Syntax Highlighting

The XWiki Syntax Highlighting application provides CodeMirror based syntax highlighting for Velocity, Groovy, JavaScript, CSS, Python, HTML and XWiki Macros (Experimental) and it is automatically activated for the "Wiki" editor. Some of its most important features include: line numbers, matching and auto-closing brackets, parentheses and quotes, search / replace with regex support.

Notifications Application (Experimental)

The new experimental Notifications Application is meant to replace the Watchlist Application in future versions and allows to subscribe to wiki pages or even whole wikis and thus receive in-wiki alerts and email notifications whenever a modification occurs. In order to have a more strict control on when an active event should trigger a notification, you have the option to create filters. 

Menu Application

The Menu Application is now bundled with the XWiki Standard Flavor in order to provide an easy way of creating navigation menus that you can choose to display either horizontally as a top bar below the page header or vertically in a side panel.


Text Formatting

The XWiki integration has been improved by enabling and configuring the Advanced Content Filter for the XWiki 2.1 syntax. This should prevent the editor from generating content that cannot be saved as wiki syntax and disables automatically the editor features that generate such content. Additionally, some old styles that were not supported by the XWiki syntax - like "Subtitle", "Computer Code", "Keyword Phrase" - were removed and replaced with some new ones like Box, Info Box, Warning Box.

Link Labels

The CKEditor Integration was upgraded to the latest version which brings support for creating wiki links with auto-generated label. It is now possible to configure the way labels are generated by the system when the user doesn't provide one.


Starting with version 9.1, inserting a block-level macro in-line will split the paragraph, thus avoiding the "macro cannot be used inline" error. Also, starting with version 9.2 you can speed up macro insertion by placing dedicated insert buttons on the tool bar.

Office Import

The editor now allows to import content from office applications like Open Office Writer or Microsoft Word. 

Page Actions

Page Administration Menu

The "Cog" and "More Actions" menu have been merged to a single menu to address the issues with understanding what is the difference between them. 

Delete Operation

System and Extension pages are now protected against accidental deletion because when you try to delete such pages, XWiki will ask you to confirm the operation, and list all concerned pages. 

Restore a Batch of Deleted Pages

In case you have performed a delete operation that removed multiple pages at the same time (like deleting a nested page and its children), you can now  restore them all together to their original state and location. This is possible by assigning a common batch ID to the deleted pages in the recycle bin.

Page Source

The "Source" screen displays the wiki source code of the current page which has been improved to look nicer and have proper line numbers that support syntax highlighting and linking. Also, you may enable blame view, including for page revisions.

Attachments View

The "Attachments" view lists all files attached to XWiki pages that you can now sort and filter by file name, file type, size or date thanks to the new range picker. Similarly to the Page Index, you can search for attachments in the nested pages hierarchy using the new "Location" column that has replaced the old "Page" and "Space" columns.

Page Attachments

In the "Attachments" tab before the attachment name you can now see:

  • a thumbnail preview for images
  • an icon reflecting the file extension for non-image files

Page Revisions

You can now compare or revert to the standard version of a document i.e. the one coming from the installed extension. Moreover, when comparing 2 versions of the page, the revision number is now clickable so that you can load the page at that specific revision. 

HTML Export

Similarly to the XAR export, it is now possible to export a list of selected children along with the current nested page. The exported pages are located in directories named after the parent pages in which they are located. 

Flamingo Color Themes

Flamingo Color Themes are now using the Attachment Selector for a simplified process of changing the logo.

Flamingo Skin

Content Menu Usability Improvements

Each menu button now has labels and backgrounds so that it is clearer and easier for users to interact with them.

Wiki and Page Administration Improvements

The wiki and page administration menu is now implemented using a collapsible accordion. Most of the sections from the "Applications" group have been moved to existing or new groups, a consistent style was applied across all the administration sections and more hints were added for the configuration options. Moreover, a search input was added so that you can filter the administration categories and sections. However, the live search matches only the category/section name and description.

Page Template Promotion

When a template has a creation restriction matching the current location or the parent of the current location, you will notice that, in the page creation screen, the page type "promotes" a certain template meaning that it is automatically selected.

Extension Manager

Default Conflict Answer

When installing / upgrading/ uninstalling XAR extensions, you might get conflicts that are mostly caused by changes made locally to extension pages. In such cases, Extension Manager will try to choose the safest way to workaround the conflict but, provided you have enabled the extension conflict setup in the user preferences page, you will see a "Default Conflict Answer" screen in the install log allowing you to change the default behavior.

Reset Feature

When loading an extension diff, you may now revert a particular change by clicking a dedicated "Reset" button.


The Blog Application is no longer bundled with XWiki Standard but you can easily install it using the Extension Manager. 

Multi-Blog Feature

XWiki now supports having multiple blogs in the same wiki, each with a dedicated set of blog categories and panels. The existing wiki blogs are displayed in a panel named "All Blogs".

Blog Posts Layout

The blog creation forms allows to choose the way the blog posts are displayed on the blog homepage:

  • display a calendar image containing the article publishing date
  • display a thumbnail of the image attached to the blog article page

Search Through the XWiki Documentation

Older Documentation Packages