Provides help within your wiki and showcases the main XWiki features through demo content

Description

The Help Application provides help within your wiki and showcases the main XWiki features through demo content.

It provides the following features:

• XWiki 13.3+ Demo Content
• Help on the Wiki Syntaxes
• a Tips Panel with various tips about using XWiki

Demo Content

Wiki Syntaxes

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.

Tips Panel

This panel provides tips about using XWiki.

For example (using the Flamingo skin):

XWiki 8.1M1+ 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.
XWiki 16.6.0+ A new tip has been added to highlight the CKEditor help shortcut.

Here are some examples of tips proposed:

New tips can be added by adding UI Extension Points of the "Add Tips to Tips Panel" type.

Available Macros

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 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:

1. Log in the wiki with a user having Administration rights
2. Go to the Administration page and select the Import category
3. Follow the on-screen instructions to upload the downloaded XAR
4. Click on the uploaded XAR and follow the instructions
5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Dependencies

Dependencies for this extension (org.xwiki.platform:xwiki-platform-help-ui 16.8.0):

• org.xwiki.rendering:xwiki-rendering-macro-id 16.8.0
• org.xwiki.rendering:xwiki-rendering-macro-box 16.8.0
• org.xwiki.rendering:xwiki-rendering-macro-toc 16.8.0
• org.xwiki.rendering:xwiki-rendering-macro-message 16.8.0
• org.xwiki.rendering:xwiki-rendering-macro-comment 16.8.0
• org.xwiki.platform:xwiki-platform-rendering-macro-velocity 16.8.0
• org.xwiki.rendering:xwiki-rendering-macro-html 16.8.0
• org.xwiki.platform:xwiki-platform-rendering-macro-include 16.8.0
• org.xwiki.platform:xwiki-platform-icon-script 16.8.0
• org.xwiki.platform:xwiki-platform-skin-skinx 16.8.0
• org.xwiki.platform:xwiki-platform-rendering-wikimacro-store 16.8.0
• org.xwiki.platform:xwiki-platform-sandbox 16.8.0
• org.xwiki.platform:xwiki-platform-administration-ui 16.8.0
• org.xwiki.platform:xwiki-platform-extension-ui 16.8.0
• org.xwiki.platform:xwiki-platform-rendering-macro-gallery 16.8.0
• org.xwiki.platform:xwiki-platform-chart-macro 16.8.0
• org.xwiki.platform:xwiki-platform-index-tree-macro 16.8.0
• org.xwiki.platform:xwiki-platform-notifications-ui 16.8.0
• org.xwiki.platform:xwiki-platform-appwithinminutes-ui 16.8.0
• org.xwiki.platform:xwiki-platform-index-ui 16.8.0
• org.xwiki.platform:xwiki-platform-uiextension-api 16.8.0