|Provides help within your wiki|
|License||GNU Lesser General Public License 2.1|
Since 5.1M1 (before that, it was bundled in the XWiki Enterprise XAR)
Table of contents
The Help Application provides help about using XWiki from within your instance.
At the moment it provides two features:
- Help on the Wiki Syntaxes
- a Tips Panel with various tips about using XWiki
You can access this help when editing a page as shown on the following image:
When you click on the link you are presented with the XWiki Syntax help page:
By default all help topics are shown on the page. If you want to see help on a single topic, you can choose that topic in the navigation on the left:
Selecting a chapter (e.g. "Editing") shows all topics of that chapter together.
You can also select the syntax variant from the drop down on the upper right. Note that for each syntax only topics are shown on which help is available for that syntax.
The Tips panel is visible by default (if not, you can navigate to the Panels Application or the Admin UI to view it and/or make it active). This Panel display random tips about how to use XWiki.
Here are some examples of tips proposed:
New tips can be added by addingof the .
Prerequisites & Installation Instructions
We recommend using theto 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).
You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:
- Log in the wiki with a user having Administration rights
- Go to the Administration page and select the Import category
- Follow the on-screen instructions to upload the downloaded XAR
- Click on the uploaded XAR and follow the instructions
- org.xwiki.rendering:xwiki-rendering-macro-message 9.1