This section provides you a guide to use all Wiki features and configure the Wiki portlet to make it work in your desired way. Before going further, you should know some basic concepts about Wiki. After accessing the Wiki application, the Wiki homepage will appear automatically as below.

Details:

Item Description
The Breadcrumb which shows the page hierarchy.
The Wiki administration area which allows administrators only to do space settings.
The Search box.
The pages tree view.
The Page Control area which helps users take actions with the current page.
The defaul content. The small page could be a Wiki quick guide that explains how to create a page, switch between different edit modes, or create a page, and more.
The page information. Click View Change to go to the Page History page for comparing changes between versions. Click Attachment(s) and Revisions links to open the Attachments details pane and the Revisions pane respectively right under the Page information bar. These two panes can be collapsed by clicking the relevant links again.

Pages are sites where information in Wiki is stored and shared. Pages are stored within a Space. To do or view actions on a specific Wiki page, you should contact the administrator to get the appropriate permissions. See the Page Permissions for detailed permissions.

In a page, you can:

There are two ways to create a page:

The first way

In this way, you need to use the toolbar.

1. Go to a Wiki space in which you want to create a page.

2. Click Add Page and select Blank Page or From Template... from the drop-down menu if you want to use an available template.

If you select From Template..., a list of available templates appears.

You can:

i. Click Preview corresponding to the template you want to see. The template preview appears:

ii. Click Select corresponding to the template you want to select for your new page.

The selected template appears:

3. Enter the title for your page. The page title must be unique.

4. Enter the content for your page by using Wiki Markup or the Rich Text editor.

5. Optionally, click Preview to see how your page looks like.

6. Click Save to finish.

The second way

In this way, you need to use the undefined link in a page.

In the Wiki application of eXo Platform, you can add a link pointing to a page which you are going to create later. Such links are called undefined links. These links are often used to remind other Wiki users to create the page.

Add an undefined link for creating a page later

1. Add a link by typing the page title between square brackets '[[...]]' or '[.... ]' (depending on your selected syntax) into your page body.

For example:

SyntaxWhat you type What you get
Xwiki 2.0 [[eXo User Guide]]
Confluence 1.0[eXo User Guide]

2. Click Save to save the page containing the link. The undefined link is colored in red with the underline.

3. Click the created red link to open the 'Add Page' form.

4. Follow the steps stated above to enter the page title, content, and save the page.

You can edit a page at any time provided that you have the edit permission on that page.

To edit a page, click Edit in the Page Control area. Your page will switch to the Edit mode.

Now, you can rename the page and edit the page content. The toolbar in the edit mode will be changed to activate the following actions.

Details:

Item Description
Switch to the Rich Text (WYSIWYG) editor.
Open the Wiki syntax help page.
Display the preview mode of the currently edited content. Previewing a page helps you verify the result of rendering the markup you just entered without saving.
Show more syntax help.
Input the edit reason if neccessary.
Save the current page and go back to the view mode.
Save the current page without sending notification to the watcher.
Discard the current changes and go back to the view mode.

Attachments are any files enclosed with your pages. The attachments may be images, documents, presentation or multimedia files.

In this section, you will know how to:

There are two ways to add an attachment to a page:

The first way

In this way, you need to use the attachment pane at the bottom of the page.

1. Click the Upload New File field. The upload window will appear.

2. Select a file from your local device and click the Open button. The file will be uploaded automatically then.

The second way

In this way, you need to use the WYSIWYG editor (Rich Text editor).

1. Select a page to which you want to add an attachment.

2. Select Edit at the Page Control area. For more details, see the Edit a page section.

3. Select the Rich Text editor on the page toolbar.

4. Click on the toolbar of the Rich Text editor, then select Attached File... from the drop-down menu.

The Link form is displayed as below.

5. Select a file to upload by doing one of two following cases:

  • Upload a new file from your local device:

i. Double-click Upload new file or click Upload new file --> Select in the Current page or All pages tab.

ii. Click Browse to select a file from your local device, then click Upload.

  • Select an existing file: Double-click it or click it, then click Select in the Current page or All pages tab.

The form to edit the link parameters appears.

6. Edit the link parameters by typing the label and the tooltip for the link.

7. Click Create Link to commit.

The uploaded file will be in the undefined link format. By clicking this link, you can create a new page.

Note

If you click Upload new file in the All pages tab, it means that the attachment is added to all pages.

Using a macro, you can apply extra formatting, functionality and customization to your content. You can easily add macro tags by using the Rich Text editor.

1. Click Rich Text to open the rich text editor.

2. Click Macros, then select Insert Macros... from the drop-down menu.

The Insert Macros form appears.

The macros are classified into different categories: Content, Formatting, Navigation.

3. Select a macro category.

4. Select your desired macro from the selected categories list and then click the Select button; or double-click it. For example, if you select the Box macro, you are redirected to the Macro Parameters form.

5. Enter parameters into the corresponding fields for your selected macro. Click Insert Macro to perform your macro insertion; Or, click Previous to return to initial Insert Macro form.

The following table describes specific functions of common macros.

MacroFunction
Excerpt Create additional information for the current page and it can be set to "hidden" in the current page, but displayed to add more information as the summary about the page when it is used with the Page Tree macro.
Include Page Include the content of another page in the current page.
Box Draw a box around the provided content.
Color

Change the text color.

Code

Highlight code snippets of various programming languages.

Error Message Display an error message note.
Float

Allow a content to 'float' on the left or the right.

Info Message

Display an info message.

NoFormat

Keep the content displayed when you type.

Note Message

Display a note message.

Panel

Embrace a block of text within a fully customizable panel.

Table

Table cell

Table row

Inset a table.

Insert a table cell.

Insert a table row.

Tip Message

Display a tip message block.

Warning Message

Display a warning message block.

Anchor Create an anchor for the selected contents.
Children

Display the children and descendants of a specific page in the current page.

Page Tree

Display the hierarchy of a page in the current page.

Related Pages Render the related pages of the current page.
Table of Content Generate a table of content for the current page.
Section & Column

Using the Section and Column macros allows you to write the content in the columns in the section.

When editing the content of a page, Wiki will automatically create a version of that page after it is saved. Thanks to the page versions, you can make changes to the page safely and rollback to an earlier version without worrying about messing things up.

In the Page History view, you can see all versions of a page.

Each version includes the following information:

  • Revision numbers.

  • Author making changes.

  • Date and time when changes are made.

  • Summary (if any).

In the Page History page, you can:

Note

All functions, including viewing, comparing and restoring, can also be done by clicking the Revisions link at the Page Info bar. One pop-up pane appears right under this bar, allowing you to do the same steps as described below.

To view a specific version of a page, just click a version number in the Page History page. The selected version of that page will be displayed.

At a version of the page, you can do the following actions:

Item Description
Compare the current version with the selected one.
Replace the current version with the selected version.
Go to the Page History page.
Prev View content of the previous version.
Next View content of the next version.

Wiki provides permanent bookmarkable URLs to all wiki pages. Wiki will resolve wiki pages by inspecting the URL used to call it and outputting links as clean URLs in the following form:

Item Description
$CONTAINER$ The portal container.
$SITE The portal site (e.g,'classic').
$NAV_URI The URI of navigation bound to a page containing the Wiki portlet.
$OWNER_TYPE May be 'group' or 'user'.
$OWNER The wiki owner which can be name of user or of group.
$WIKI_PAGE_URI The URI inferred automatically from the wiki page name.

Any wiki page should be accessed by a friendly URL, for example:

The administrator has the highest right in Wiki. The administrator can delete a page, change the space settings, set the edit permission for users, and more.

Wiki gives you the choice to make a space or an individual page to be open or restricted to specific users, groups or memberships. There are two levels of permissions in Wiki: Space Permissions and Page Permissions.

Each space may have its own permissions. Space permissions determine which actions a user can do within the space. A permission can be assigned to any users, groups or memberships.

To change the space permission, open a space, click Browse and select Space Settings from the drop-down list. Clik Permission in the Space Settings page that appears.

There are some permissions to a space as follows:

Permission Description
View Pages Specify who can view and watch pages of this space, its attachments and history.
Edit Pages Specify who can edit pages of this space.
Admin Pages Specify who have the administration rights on this space.
Admin Space Specify who can administrate the space permissions and settings

In the Space Permissions form, you can add or remove the space permissions of the users, groups and memberships.

When adding a new page, you are not required to write the content from scratch. You can start by selecting a page template which is actually a Wiki page with predefined contents.

In the Space Settings form, select the Template tab, and the form to manage templates appears.

Details: