Help Application

Last modified by Admin on 2017/10/05 14:57

helpProvides help within your wiki
TypeXAR
Developed by

XWiki Development Team

Rating
Rate!
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Enterprise

Compatibility

Since 5.1M1 (before that, it was bundled in the XWiki XAR)

Installable with the Extension Manager

Description

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

Wiki Syntaxes

You can access this help when editing a page as shown on the following image:

help-link.png

When you click on the link you are presented with the XWiki Syntax help page:

help-syntax.png

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: 

help-syntax-links.png

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

New in 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.

Here are some examples of tips proposed:

tippanel-1.png

tippanel-2.png

tippanel-3.png

tippanel-4.png

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

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

Tags:
Created by Vincent Massol on 2013/05/28 11:31
    

Get Connected