h1. Overview {anchor:id=KSuser.Wiki.Wiki_Overview}
This section provides you a guide to use all *Wiki* features and configure the *Wiki* application to make it work in your desired way. Before going further, you should know some basic concepts about *Wiki*.
After [accessing the *Wiki* application|#KSuser.access_knowledge], the *Wiki* homepage will appear as below:

!images/wiki_overview.png|align="center" width="150mm" fo:scalefit="1" html:scalefit="0"!

*Details*:
||Item|| Description||
|!images/no1.png|width="4mm" fo:scalefit="1" html:scalefit="0"!|The *Breadcrumb* which shows the page hierarchy.|
|!images/no2.png|width="4mm" fo:scalefit="1" html:scalefit="0"!|The Wiki administration area which allows administrators only to configure the space settings. |
|!images/no3.png|width="4mm" fo:scalefit="1" html:scalefit="0"!|The *Search* box.|
|!images/no4.png|width="4mm" fo:scalefit="1" html:scalefit="0"!|The pages tree view.|
|!images/no5.png|width="4mm" fo:scalefit="1" html:scalefit="0"!|The *Page Control* area which helps users take actions with the current page.|
|!images/no6.png|width="4mm" fo:scalefit="1" html:scalefit="0"!|The page content.|
|!images/7.png|width="4mm" fo:scalefit="1" html:scalefit="0"!|The page information. You can click *View Change* to see changes in latest versions, click *Attachment(s)* and *Revisions* links to open the *Attachments* details pane and the *Revisions* pane respectively. These two panes can be collapsed by clicking the relevant links again. |

h2. The page hierarchy in Wiki {anchor:id=KSuser.Wiki_Overview.Page_hierarchy}
*Wiki* content is organized as a page tree in which each page may contain many sub-pages. The hierarchy is reflected on UI by the *Breadcrumb* and the page tree at the left pane. When a page is added, it is always defined as a sub-page to the current one. You can have wikis for portals, wikis for groups or users.

h2. Wiki Spaces {anchor:id=KSuser.Wiki_Overview.Wiki_spaces}
A space is a set of pages, so the space partitioning means they are independent trees. This separation is to enable *Wiki* to provide knowledge spaces for different groups.

There are 3 space types:

* *Portal wiki*: wiki for the current portal site.

* *Group wiki*: wiki available for members of a group.

* *User wiki*: wiki for personal pages.

{docbook}
<note>
    <para>
    In this document, Spaces are referred as wikis, particularly portal wikis, group wikis and user wikis.
    </para>
    <para>
    Any space which has an implicit root page is named Wiki Home.
    </para>
</note>
{docbook}


h1. Work with Wiki pages {anchor:id=KSuser.Work_with_Wiki_pages}
Pages are places where information in *Wiki* is stored and shared. Pages are stored within a spaces. Actions that a user can perform on a specific wiki page depends on permissions assigned by the administrator. See the [Page Permissions|#KSuser.Wiki_Administration.Page_permissions] for detailed permissions.

In a page, you can:

* [Create a page with the simple markup language or the Rich Text editor|#KSuser.Work_with_Wiki_pages.Create_pages].

* [Edit a page|#KSuser.Work_with_Wiki_pages.Edit_pages].

* [Delete a page|#KSuser.Work_with_Wiki_pages.Delete_pages].

* [Move a page to another location|#KSuser.Work_with_Wiki_pages.Move_pages].

* [Watch a page|#KSuser.Work_with_Wiki_pages.Watch_pages].

* [View page information|#KSuser.Work_with_Wiki_pages.View_page_info].

h2. Create a page {anchor:id=KSuser.Work_with_Wiki_pages.Create_pages}
There are two ways to create a page:

*The first way* {anchor:id=KSuser.Work_with_Wiki_pages.Create_pages.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 click *From Template...* to add a page with a template.

!images/add_wiki_page.png|align="center" width="50mm" fo:scalefit="1" html:scalefit="0"!

If you select *From Template...*, a list of available templates will appear.

!images/wiki_template.png|align="center" width="120mm" fo:scalefit="1" html:scalefit="0"!

You can:

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

!images/Wiki_template_preview.png|align="center" width="120mm" fo:scalefit="1" html:scalefit="0"!

ii. Click *Select* corresponding to the template you want to select for your new page. The selected template appears.

!images/wiki_available_template.png|align="center" width="120mm" fo:scalefit="1" html:scalefit="0"!

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

*4.* Enter the content of your page by using *[Wiki Markup|#KSuser.Wiki.Syntax_Help]* or the *[WYSIWYG|#KSuser.Wiki.Use_WYSIWYG_editor]* editor.

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

*6.* Click *Save* to finish.

*The second way* {anchor:id=KSuser.Work_with_Wiki_pages.Create_pages.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.

{docbook}
<citetitle>
<para>
<emphasis role="bold">Add an undefined link for creating a page later</emphasis>
</para>
</citetitle>
{docbook}

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

For example:

||Syntax||What you type|| What you get||
|Xwiki 2.0 |{noformat}[[eXo User Guide]]{noformat}|!images/undefined_link.png| width="17mm" fo:scalefit="1" html:scalefit="0"!|
|Confluence 1.0|{noformat}[eXo User Guide]{noformat}|!images/undefined_link.png| width="17mm" fo:scalefit="1" html:scalefit="0"!|

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

*3.* Click this link will open the *Add Page* form.

*4.* Follow the steps stated [above|#KSuser.Work_with_Wiki_pages.Create_pages.First_way] to enter the page title, content and save the page.

h2. Edit a page {anchor:id=KSuser.Work_with_Wiki_pages.Edit_pages}
You can edit a page at any time if you have the edit permission on that page.

{docbook}
<citetitle>
<para>
<emphasis role="bold">Edit a whole page content</emphasis>
</para>
</citetitle>
{docbook}

To edit a whole page content, click *Edit* in the *Page Control* area. Your page will be switched to the Edit mode.

!images/page_control.png|align="center" width="150mm" fo:scalefit="1" html:scalefit="0"!

Now, you can rename the page and edit the page content. In view mode, hover your cursor over the page title and double click to edit page title. The toolbar in the edit mode will be changed to activate the following actions.

!images/wiki_page_edit.png|align="center" width="150mm" fo:scalefit="1" html:scalefit="0"!

*Details:*
||Item|| Description||
|!images/no1.png|width="4mm" fo:scalefit="1" html:scalefit="0"!| Switch to the *Rich Text (WYSIWYG)* editor. |
|!images/no2.png|width="4mm" fo:scalefit="1" html:scalefit="0"!| 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. |
|!images/no3.png|width="4mm" fo:scalefit="1" html:scalefit="0"!| Open the Wiki syntax help pane. |
|!images/no4.png|width="4mm" fo:scalefit="1" html:scalefit="0"!| Show more syntax help. |
|!images/no5.png|width="4mm" fo:scalefit="1" html:scalefit="0"!| Input the edit reason if necessary. |
|!images/no6.png|width="4mm" fo:scalefit="1" html:scalefit="0"!| Save the current page and go back to the view mode. Changes will be sent to watchers via mail notification. |
|!images/7.png|width="4mm" fo:scalefit="1" html:scalefit="0"!| Save the current page without sending notification to the watcher. |
|!images/8.png|width="4mm" fo:scalefit="1" html:scalefit="0"!| Discard the current changes and go back to the view mode. |
|!images/9.png|width="4mm" fo:scalefit="1" html:scalefit="0"!| The *Syntax* drop-down list. You can select your preferred syntax here.|


{docbook}
<citetitle>
<para>
<emphasis role="bold">Edit a page section</emphasis>
</para>
</citetitle>
{docbook}

To edit only a section in the whole page content, hover the mouse over the title of the section you want to edit and click !images/Wiki_edit_icon.png|width="4mm" fo:scalefit="1" html:scalefit="0"!.

!images/Wiki_edit_section.png|align="center" width="120mm" fo:scalefit="1" html:scalefit="0"!

The selected section will be switched to the Edit mode.

{docbook}
<tip>
<para>
In the View mode, you can quickly edit the page title by double-clicking it and press Enter when finish.
</para>
</tip>
{docbook}

h2. Move a page to another location {anchor:id=KSuser.Work_with_Wiki_pages.Move_pages}

*1.* Select a page that you want to move.

*2.* Click *More* in the *Page Control* area, then select *Move Page* from the drop-down menu.

!images/wiki_move_page.png|align="center" width="50mm" fo:scalefit="1" html:scalefit="0"!

The form to select the destination page appears.

!images/wiki_destination_page.png|align="center" width="120mm" fo:scalefit="1" html:scalefit="0"!

*3.* Select the destination page.

*4.* Click *Move*.

{docbook}
<note>
<para>
The Move page action is not displayed when you are at the Wiki Home. You can only move pages inside a wiki space and not between spaces.
</para>
</note>
{docbook}

h2. Delete a page {anchor:id=KSuser.Work_with_Wiki_pages.Delete_pages}

*1.* Open the page you want to delete and select *More* in the *Page Control* area.

!images/Delete_page.png|align="center" width="50mm" fo:scalefit="1" html:scalefit="0"!

*2.* Click *Delete Page* from the drop-down menu.

*3.* Click *OK* in the confirmation message to accept your deletion.

{docbook}
<note>
<para>
The Delete page action is not displayed when you are in the Wiki Home.
</para>
</note>
{docbook}


h2. View page information {anchor:id=KSuser.Work_with_Wiki_pages.View_page_info}

Viewing page information is accessible to users who have the View permission on that page. The page information provides details about related pages of the current page, the hierarchy structure of the current page, the page history and more.

*1.* Select the page you want to view the information.

*2.* Click *More* from the page toolbar, then select *Page Info* from the drop-down menu.

All information of the opening page, including page summary, related pages, page hierarchy, recent changes will be displayed.

!images/wiki_page_info.png|align="center" width="150mm" fo:scalefit="1" html:scalefit="0"!


h3. Add a related page {anchor:id=KSuser.Work_with_Wiki_pages.Add_related_pages}
This feature allows you to add pages related to your page. This function can be done in the *Page Info* view and is activated to users with the Edit permission.

*1.* Click *Add More Relations* in the [Page Info|#KSuser.Work_with_Wiki_pages.View_page_info] view, then select the related pages in the *Select a page* window.

*2.* Click *Select* to add the selected page to the list of the *Related Pages*.

!images/wiki_select_page.png|align="center" width="100mm" fo:scalefit="1" html:scalefit="0"!

The related pages of the opening page are displayed in the side pane as below.

!images/wiki_related_page.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!


h3. View a page history {anchor:id=KSuser.Work_with_Wiki_pages.View_page_history}

To access the page history, just click *View Page History* in the [Page Info|#KSuser.Work_with_Wiki_pages.View_page_info] view.

The *History Page* appears.

!images/page_history.png|align="center" width="150mm" fo:scalefit="1" html:scalefit="0"!

*Details:*

||Area|| Function ||
|!images/no1.png| width="4mm" fo:scalefit="1" html:scalefit="0"!|[Compare selected page versions|#KSuser.Work_with_page_version.Compare_versions].|
|!images/no2.png| width="4mm" fo:scalefit="1" html:scalefit="0"!|Allow you to select two versions that you want to compare.|
|!images/no3.png| width="4mm" fo:scalefit="1" html:scalefit="0"!|Allow you to specify the version labels of the page and [link to view a specific version|#KSuser.Work_with_page_version.View_versions].|
|!images/no4.png| width="4mm" fo:scalefit="1" html:scalefit="0"!|The date and time when the page is changed. |
|!images/no5.png| width="4mm" fo:scalefit="1" html:scalefit="0"!|The authors who make changes of the page.|
|!images/no6.png| width="4mm" fo:scalefit="1" html:scalefit="0"!|The reasons why the changes are made (optional).|
|!images/7.png| width="4mm" fo:scalefit="1" html:scalefit="0"!|[Restore a page to the selected version|#KSuser.Work_with_page_version.Restore_page_version].


h2. Watch a page  {anchor:id=KSuser.Work_with_Wiki_pages.Watch_pages}
Watching a page allows you to receive a notification message about any changes in the page.

{docbook}
<citetitle>
<para>
    <emphasis role="bold">Watch a page</emphasis>
</para>
</citetitle>
{docbook}

*1.* Open the page you want to watch.

*2.* Click *More* in the *Page Control* area, then select *Watch* from the drop-down menu.

!images/wiki_watch_page.png|align="center" width="60mm" fo:scalefit="1" html:scalefit="0"!


{docbook}
<citetitle>
<para>
    <emphasis role="bold">Stop watching a page</emphasis>
</para>
</citetitle>
{docbook}


*1.* Open the page which you watch.

*2.* Click *More* in the *Page Control* area, then select *Stop Watching* from the drop-down menu.

!images/wiki_stop_watch_page.png|align="center" width="50mm" fo:scalefit="1" html:scalefit="0"!

h1. Work with attachments {anchor:id=KSuser.Work_with_attachment}
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:

* [View all attachments of a page|#KSuser.Work_with_attachment.View_attachments].

* [Add an attachment|#KSuser.Work_with_attachment.Add_attachment].

* [Delete an attachment|#KSuser.Work_with_attachment.Delete_attachment].

* [Download an attachment|#KSuser.Work_with_attachment.Download_attachment].


h2. View all attachments of a page {anchor:id=KSuser.Work_with_attachment.View_attachments}

*1.* Open the page you want to view attachments.

*2.* Click *Attachment(s)* link in the *Page info* area.

!images/wiki_attachment.png|align="center" width="120mm" fo:scalefit="1" html:scalefit="0"!

The *Attachment* pane of that page will appear:

!images/Wiki_attachments_list.png|align="center" width="150mm" fo:scalefit="1" html:scalefit="0"!

{docbook}
<citetitle>
<para xml:id="KSuser.Work_with_attachment.Delete_attachment">
    <emphasis role="bold">Delete an attachment</emphasis>
</para>
</citetitle>
{docbook}

To delete an attachment, click !images/Wiki_attachment_delete_icon.png| width="3mm" fo:scalefit="1" html:scalefit="0"! corresponding to the attachment.

{docbook}
<citetitle>
<para xml:id="KSuser.Work_with_attachment.Download_attachment">
    <emphasis role="bold">Download an attachment</emphasis>
</para>
</citetitle>
{docbook}

To download an attachment, click the attachment name.

h2. Add an attachment to a page {anchor:id=KSuser.Work_with_attachment.Add_attachment}
There are two ways to add an attachment to a page:

*The first way* {anchor:id=Add_attachment_Attachment_pane}

In this way, you need to open the *Attachment* pane of the page.

!images/Wiki_upload_attachment.png|align="center" width="100mm" fo:scalefit="1" html:scalefit="0"!

*1.* Click the *Upload New File* in the attachment list pane. The upload window will appear.

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

*The second way* {anchor:id=Add_attachment_WYSIWYG editor}

You can use this method when editing the page content by *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|#KSuser.Work_with_Wiki_pages.Edit_pages] section.

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

!images/rich_text_editor.png|align="center" width="50mm" fo:scalefit="1" html:scalefit="0"!

*4.* Click !images/Link_icon.png| width="13mm" fo:scalefit="1" html:scalefit="0"! on the toolbar of the *Rich Text* editor, then select *Attached File...* from the drop-down menu.

!images/wiki_attach_file.png|align="center" width="100mm" fo:scalefit="1" html:scalefit="0"!

The *Link* form is displayed as below.

!images/wiki_link_form.png|align="center" width="100mm" fo:scalefit="1" html:scalefit="0"!

*5.*  Select a file to upload. Now you can choose to upload a new file or select from existing files.

* *Upload a new file:*
*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 from existing files:* Click the file, then click *Select*.

The form to edit the link parameters appears.

!images/wiki_edit_link.png|align="center" width="80mm" fo:scalefit="1" html:scalefit="0"!

*6.* Provide the link label and tooltip.

*7.* Click *Create Link* to update the link.

h2. Insert image {anchor:id=KSuser.Work_with_attachment.Link_to_image}

*1.* Click !images/Image_btn.png| width="13mm" fo:scalefit="1" html:scalefit="0"! on the text editor, then click *Insert Image...*

!images/wiki_link_to_image.png|align="center" width="100mm" fo:scalefit="1" html:scalefit="0"!

*2.* Select an inserted image of the current page or click the *All Pages* tab to select an image attached to another page in the space.

*3.* Click *Insert Image*.

h1. Use the WYSIWYG Editor (Rich Text editor) {anchor:id=KSuser.Wiki.Use_WYSIWYG_editor}

*WYSIWYG* stands for What You See Is What You Get. The *WYSIWYG* editor allows you to edit an wiki pages directly in wiki markup language. This has the advantage of being faster than the Rich Text Editor for some formatting tasks.

You can switch between the *Source* and *WYSIWYG* editors at any time by clicking !images/rich_text_editor.png| width="40mm" fo:scalefit="1" html:scalefit="0"! or !images/source_editor_btn.png| width="20mm" fo:scalefit="1" html:scalefit="0"!. In the *Source* editor, which is selected by default when you edit a page, you have to use the wiki markup language for text formatting, while the *WYSIWYG* editor enables the contents to be appeared during editing that is very similar to the published result. Thanks to available tools on this editor, you can format your content visually without using wiki markups.

!images/wiki_wysiwyg_editor.png|align="center" width="150mm" fo:scalefit="1" html:scalefit="0"!

{docbook}
<note>
    <para>
    If the final result is not similar to what you wish when editing a page by the <emphasis role="bold">WYSIWYG</emphasis> editor, you can go back to the <emphasis role="bold">Source</emphasis> editor and use <emphasis role="bold">Wiki</emphasis> markups to edit the content.
    </para>
    <para>
    When using the <emphasis role="bold">WYSIWYG</emphasis> editor, examples of commonly used markup are displayed in a lateral panel with a link to the <link linkend="KSuser.Wiki.Syntax_Help"><emphasis role="bold">Full Syntax Notation</emphasis></link> page for more details.
    </para>
</note>
{docbook}

To learn more about the *WYSIWYG* editor, you can refer to this guide.

* [*WYSIWYG* editor user guide|http://platform.xwiki.org/xwiki/bin/view/Features/WysiwygEditor]

h1. Syntax Help {anchor:id=KSuser.Wiki.Syntax_Help}
If you do not know how to use a syntax, you can use the Syntax Help function. The *Syntax Help* is displayed by clicking !images/Wiki_help_btn.png| width="30" fo:scalefit="1" html:scalefit="0"! from the page toolbar. When being clicked, a lateral pane slides beside the editing area will show all the information of the currently used syntax.
The lateral pane can be hidden by clicking !images/Close_button.png| width="4mm" fo:scalefit="1" html:scalefit="0"! in the upper right corner or by clicking !images/Wiki_help_btn.png| width="30" fo:scalefit="1" html:scalefit="0"! again.

!images/Quick_notation.png|align="center" width="50mm" fo:scalefit="1" html:scalefit="0"!

You can click !images/More_syntaxes.png| width="7mm" fo:scalefit="1" html:scalefit="0"! at the bottom of short *Help Tips* form to open the *Full Syntax Notation* page.

You can insert icons, emoticons to emphasize the content. The usage is described in the *Full Syntax Notation* page with example so you can easily remember and use them.

*Example of Emoticons and icons*:

!images/Smiley_special_notation.png|align="center" width="80mm" fo:scalefit="1" html:scalefit="0"!

h1. Work with Macros {anchor:id=KSuser.Wiki.Work_with_Macros}
By using macros, you can apply extra formatting, functionality and customization to your content.
You can easily add macro tags by using the *Rich Text* editor.

*1.* Switch to [*Rich Text* editor|#KSuser.Wiki.Use_WYSIWYG_editor].

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

!images/wiki_macros.png|align="center" width="120mm" fo:scalefit="1" html:scalefit="0"!

The *Insert Macros* form appears.

!images/wiki_macros_form.png|align="center" width="100mm" fo:scalefit="1" html:scalefit="0"!

The macro is classified into different categories: *Content*, *Formatting*, *Navigation*.

*3.* Select a macro category.

*4.* Select your desired macro from the selected categories list, then click the *Select* or simply double-click it. For example, if you select the *Box* macro, you will go to the *Macro Parameters* form.

!images/Macro_parameters_form.png|align="center" width="100mm" fo:scalefit="1" html:scalefit="0"!

*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.

||Macro||Function||
|*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.|
|*No Format* |Keep the content displayed like you type.|
|*Note Message*|Display a note message.|
|*Panel* |Embrace a block of text within a fully customizable panel. |
|*Table* {example}{example}*Table cell*{example}{example}*Table row*| Inset a table. {example}{example}Insert a table cell. {example}{example}Insert a table row.|
|*Tip Message* |Display a tip message block.{example}{example} |
|*Warning Message* |Display a warning message block. {example}{example} |
|*Anchor* |Create an anchor in a page. |
|*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 columns. |

h1. Work with page versions {anchor:id=KSuser.Wiki.Work_with_Page_versions}
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|#KSuser.Work_with_Wiki_pages.View_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:

* [View versions of a page|#KSuser.Work_with_page_version.View_versions].

* [Compare page versions|#KSuser.Work_with_page_version.Compare_versions].

* [Restore a page version to the current version|#KSuser.Work_with_page_version.Restore_page_version].

{docbook}
<note>
    <para>
    All functions, including viewing, comparing and restoring, can also be done by clicking the <emphasis role="bold">Revisions</emphasis> link at the <emphasis role="bold">Page Info</emphasis> bar. One pop-up pane appears right under this bar, allowing you to do the same steps as described below.
    </para>
</note>
{docbook}

h2. View versions of a page {anchor:id=KSuser.Work_with_page_version.View_versions}
To view a specific version of a page, just click a version label in the *Page History* page. The selected version of that page will be displayed.

!images/wiki_view_version.png|align="center" width="120mm" fo:scalefit="1" html:scalefit="0"!

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

||Item|| Description||
|!images/no1.png| width="4mm" fo:scalefit="1" html:scalefit="0"!|Compare the current version with the selected one.|
|!images/no2.png| width="4mm" fo:scalefit="1" html:scalefit="0"!|Replace the current version with the selected version.|
|!images/no3.png| width="4mm" fo:scalefit="1" html:scalefit="0"!|Go to the *Page History* page.|
| *Prev* |View content of the previous version.|
| *Next* |View content of the next version.|

h2. Compare page versions {anchor:id=KSuser.Work_with_page_version.Compare_versions}

*Wiki* tracks histories of changes to pages by maintaining a version of the page each time it is modified. To compare two versions, select two checkboxes corresponding to each relevant version, then click !images/Compare_selected_button.png| width="25mm" fo:scalefit="1" html:scalefit="0"!.

!images/Select_page_version.png|align="center" width="150mm" fo:scalefit="1" html:scalefit="0"!

A page which shows the changes between these two versions will be displayed.

!images/wiki_compare_version1.png|align="center" width="150mm" fo:scalefit="1" html:scalefit="0"!

The changes between two versions will be marked with colors:

*  Words/lines which are red-highlighted with strike-throughs indicate that they were removed.

*  Words/lines highlighted in green indicate that they were added.


{docbook}
<note>
    <para>
    Only two revisions can be selected at one time.
    </para>
</note>
{docbook}

h2. Restore a page version to the current version  {anchor:id=KSuser.Work_with_page_version.Restore_page_version}
When you notice that there are changes in the current page version that you are not satisfied, you can rollback to an older version of that page quickly.

To restore an older version, click !images/Restore_button.png| width="30" fo:scalefit="1" html:scalefit="0"! corresponding to your desired version in the *Page History* page.


{docbook}
<note>
    <para>
    Restoring an older version will create a copy of that version. For example, if the [current version (v.2)] is restored to the [older version (v.1)], <emphasis role="bold">Wiki</emphasis> will create a new version (v.3) containing contents of v.1. The version v.3 will become the current version.
    </para>
</note>
{docbook}

h1. Work with Spaces {anchor:id=KSuser.Wiki.Work_with_Spaces}
*Wiki* provides permanent bookmarkable URLs to all wiki pages. *Wiki* will resolve wiki pages by inspecting the URL used to call it. URLs are in the following form:

{code}http://hostname/$CONTAINER/$SITE/$NAV_URI/[$OWNER_TYPE/$OWNER]/$WIKI_PAGE_URI{code}

{docbook}
<para>
</para>
{docbook}

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

Any wiki page should be accessed by a friendly URL. For example:

* Portal wiki URL: http://hostname/portal/classic/wiki/eXo+Wiki+Specification.

* Group wiki URL: http://hostname/portal/classic/wiki/group/platform/Administrators/Admin+Guide.

* Personal wiki page URL: http://hostname/portal/classic/wiki/user/john/Sandbox.


h1. Search {anchor:id=KSuser.Wiki.Search}
In *Wiki*, you can search spaces, or pages in a space and attached files. There are two types of search in *Wiki*:

* [Quick Search|#KSuser.Wiki.Search.Quick_search]
* [Advanced Search|#KSuser.Wiki.Advanced_Search]

h2. Quick Search {anchor:id=KSuser.Wiki.Search.Quick_search}

*1.* Enter a key word in the search box.

!images/wiki_quick_search.png|align="center" width="170" fo:scalefit="1" html:scalefit="0"!

*2.* Select your desired page from the drop-down menu. You will be redirected to the selected page.

{docbook}
<note>
<para>
If you are standing in the portal wiki, quick search will search on all wiki spaces, otherwise it will only search on the current wiki.
</para>
</note>
{docbook}

h2. Advanced Search {anchor:id=KSuser.Wiki.Advanced_Search}
The Advanced Search function allows you to search with a key word in a specific space. This mode helps you limit the search results.

*1.* Enter a key term into the search box and hit the *Enter* key.

The search results are displayed like the illustration below.

!images/wiki_advanced_search_result.png|align="center" width="120mm" fo:scalefit="1" html:scalefit="0"!

If no results matched with the key words, the search screen informs "*there is no search result...!*"

*2.* Click !images/down_arrow_icon.png| width="4mm" fo:scalefit="1" html:scalefit="0"! to select a space from the drop-down menu to define a scale where to search for the entered word.

*3.* Click *Search*.

h1. Wiki Administration {anchor:id=KSuser.Wiki.Wiki_Administration}


{docbook}
<note>
    <para>
    This section is for administrators only.
    </para>
</note>
{docbook}

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.

h2. Set up space settings {anchor:id=KSuser.Wiki_Administration.Set_up_space_settings}

For each space, you can manage page templates and change the syntax.

{docbook}
<citetitle>
<para>
    <emphasis role="bold">Access the Space Settings page</emphasis>
</para>
</citetitle>
{docbook}
*1.* Open a *Wiki* space.

*2.* Click *Browse*, then  select *Space Settings*.

!images/wiki_space_settings.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

The *Space Settings* page appear.

!images/wiki_space_settings_page.png|align="center" width="150mm" fo:scalefit="1" html:scalefit="0"!

Now you can:

* [Manage permissions on spaces and pages|#KSuser.Wiki_Administration.Manage_permissions].
* [Manage page templates|#KSuser.Wiki_Administration.Manage_page_tempplate].
* [Set up wiki syntax|#KSuser.Wiki_Administration.Set_up_syntax].

h2. Manage Permissions {anchor:id=KSuser.Wiki_Administration.Manage_permissions}
*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.

h3. Space Permissions  {anchor:id=KSuser.Wiki_Administration.Manage_permissions.Space_Permission}
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.
Click *Permission* in the *Space Settings* page that appears.

!images/wiki_space_permissions_page.png|align="center" width="150mm" fo:scalefit="1" html:scalefit="0"!

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 pages of 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.

h4. Add space permissions {anchor:id=KSuser.Wiki_Administration.Add_space_permissions}
In the *Space Permissions* form, you can add permissions for individual users, groups of users or memberships.

*1.* Click !images/select_permission_icon.png| width="14mm" fo:scalefit="1" html:scalefit="0"! to assign permissions to a user, a group or a membership respectively.

The form to select the user, the group and the membership appears.

*2.* Select a user, a group or a membership, then click  *Add*.

*3.* Click the plus icon to add the selectors to the *Owner* column in the *Space Permissions* form.

*4.* Click the checkboxes corresponding to each permission you want to assign to the selectors.

*5.* Click *Save* to commit.


{docbook}
<note>
    <para>
    View, Edit, Admin Pages permissions are applied by default to any pages of the space unless specific page permissions are set. The super user has all permissions implicitly.
    </para>
</note>
{docbook}

h4. Delete space permissions {anchor:id=KSuser.Wiki_Administration.Delete_space_permissions}

To delete the permissions of a user, group or a membership in a space, just click !images/Delete_icon.png| width="4mm" fo:scalefit="1" html:scalefit="0"! corresponding to a user/a group or a membership in the *Space Permissions* form.

h3. Page Permissions {anchor:id=KSuser.Wiki_Administration.Page_permissions}
The *Page Permissions* allows you to set the view and edit permissions for a specific page of a space.

*1.* Open a page of the space that you want to set the permissions.

*2.* Click *More* and select *Page Permissions* from the drop-down menu.

!images/wiki_page_permissions.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

The *Page Permissions* form appears.

!images/wiki_page_permissions_form.png|align="center" width="120mm" fo:scalefit="1" html:scalefit="0"!

Pages are viewable/editable according to the space permission. On each page, a user with the *Admin Pages* permission will be able to override the view and edit permissions on this specific page.

A *Page Permissions* action appears in the page action menu when the user has the *Admin Pages* permission.

You can add and delete the *View Pages Permission* or the *Edit Pages Permissions* for the page. Do the same as *[Add space permissions|#KSuser.Wiki_Administration.Add_space_permissions]* and *[Delete space permissions|#KSuser.Wiki_Administration.Delete_space_permissions]*.


h3. Manage a page template {anchor:id=KSuser.Wiki_Administration.Manage_page_tempplate}

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.

!images/wiki_setting_template.png|align="center" width="150mm" fo:scalefit="1" html:scalefit="0"!

*Details:*
||Item ||Description ||
|!images/no1.png| width="4mm" fo:scalefit="1" html:scalefit="0"!|[Search for a template|#KSuser.Wiki_Administration.Search_templates].|
|!images/no2.png| width="4mm" fo:scalefit="1" html:scalefit="0"!|[Create a new template|#KSuser.Wiki_Administration.Add_templates].|
|!images/no3.png| width="4mm" fo:scalefit="1" html:scalefit="0"!|[Edit a template|#KSuser.Wiki_Administration.Edit_templates].|
|!images/no4.png| width="4mm" fo:scalefit="1" html:scalefit="0"!|[Delete a template|#KSuser.Wiki_Administration.Delete_templates].|

h4. Search for a template {anchor:id=KSuser.Wiki_Administration.Search_templates}

This feature allows you to find your desired template quickly from the existing list as follows:

*1.* Input a word included in the title of your desired template in the *Search* textbox.

*2.* Press the *Enter* key or click the *Search* button next to the textbox to start your search.

All matching results which contain your entered search term are displayed right below the textbox.


{docbook}
<note>
    <para>
    The <emphasis role="bold">Search</emphasis> function is only performed by the template titles and you must enter a complete word into the <emphasis role="bold">Search</emphasis> textbox. For example, to find the template whose title contains "daily report", you can input "report" rather than "repo", or "daily" rather "ly".

    </para>
</note>
{docbook}

h4. Create a new template {anchor:id=KSuser.Wiki_Administration.Add_templates}

*1.* Click *Add more...* in the *Spage Settings* page and the sample template form appears.

!images/wiki_sample_template.png|align="center" width="120mm" fo:scalefit="1" html:scalefit="0"!

*2.* Add the title for the template.

*3.* Write the description in the *Description...*.

*4.* Write the content for the template.

*5.* Select the *Syntax* to write the content.

*6.* Click *Save Template* at the *Page Control* area. A message will inform your successful template creation.

h4. Edit a template {anchor:id=KSuser.Wiki_Administration.Edit_templates}

*1.* Click the *Edit* icon corresponding to the template you want to edit.

*2.* Change the title, the description or the content as you want.

*3.* Click *Save Template* at the *Page Control* area.

h4.  Delete a template {anchor:id=KSuser.Wiki_Administration.Delete_templates}

*1.* Click !images/Delete_icon.png| width="4mm" fo:scalefit="1" html:scalefit="0"! corresponding to the template you want to delete.

*2.* Click *OK* in the pop-up confirmation message.


h3. Set up the wiki syntax {anchor:id=KSuser.Wiki_Administration.Set_up_syntax}

By setting up the Wiki syntax, you can select the default syntax and allow user to choose syntax while writing a document or not.

*1.* Click *Syntax* in the *Space Settings* page.

!images/wiki_setting_syntax.png|align="center" width="120mm" fo:scalefit="1" html:scalefit="0"!

*2.* Click the *Default Syntax* box and select a syntax from the drop-down menu. This syntax is set as the default for your document.

In case you want to use another syntax, tick the "*Allow user to select other syntaxes*" checkbox.


{docbook}
<note>
<para>It is highly recommended that you should use such simple syntaxes, such as XWiki 2.0, or Confluence 1.0. </para>
</note>
{docbook}


