Redmine

h1. Wikis

{{>toc}}

h2. Creating a new wiki page

As in every wiki, just add a link to the page you want to create.

<pre>[[MyNewWikiPage]]</pre>

Save the page and click on that link: you have created a new wiki page with "MyNewWikiPage" as its name.

h2. Creating an additional wiki side bar

The content of the wiki page named '@Sidebar@' is rendered in the wiki sidebar if it exists. Permission to edit protected pages is required to create this page

h2. Creating sub-pages (parent/child relationships)

It is possible to create parent/child relationships between wiki-pages. This has two benefits:

* On the "[[RedmineWikis#Sidebar|Index by title]]", the page tree in sorted according to the relationhips:

> * Guide

> ** RedmineAccounts

> ** RedmineCustomFields

> ** RedmineInstall

> ** RedmineIssueList

> ** RedmineIssues

* On each child page a breadcrumb is displayed showing the location of the page within the page tree:

TODO, add image

These relations can be set by assigning a parent page to a to-be child-page. This assignment can be done via the @rename@ dialog only.

Thus, create both the child- and parent-pages and then open the to-be child-page and click "rename", then enter the name of the parent page and click "save".

h2. Text formatting

See [[RedmineTextFormatting]].

h2. Protecting a wiki page

If you have the permission to protect wiki pages, you can click on !/images/locked.png! *Lock*.

A locked wiki page can only be edited by users who have the permission to protect wiki page.

It can be unlocked by those users by clicking !/images/unlock.png! *Unlock*.

h2. Wiki page history

Redmine keeps a record of every change made to a wiki page. You can view the list of these changes by clicking on !/images/history.png! *History*.

p=. !history.png!

To view a specific version of the page click on its number.

p=. !page_version.png!

You can revert a page to a previous version by clicking on !/images/cancel.png! *Rollback to this version*, then *Save*.

h2. Sidebar

The contextual sidebar on the right of any wiki page provides links to:

* *Start page*: Link to the [[RedmineProjectSettings#Wiki|configured start page]] of the wiki

* *Index by title*: Index of all the wiki pages sorted by name (and, if [[RedmineWikis#Creating-sub-pages-parentchild-relationships|configured]], by parent/child relationships)

* *Index by date*: Index of all the wiki pages sorted by date of last modification