Wiki

A wiki is a tool where everyone can collaborate on the content and modify the pages created by the Project Administrator. This ease of interaction and operation makes a wiki an effective tool for collaborative writing.

How to use a Wiki

A project wiki is built as a collection of related pages starting from the Front Page; each new page addition is made by clicking at new topic links in an existing page.

Adding a new page

To insert a new page, you must

1. Edit an existing page
2. Set a meaningful title and format it in a way that Wiki understands that new content should be added to that topic. There are several ways on doing this:
• String together the title text with each word capitalized, e.g. AddingNewPages.
• Put the title inside square brackets, e.g. [adding new pages].
3. Once Wiki recognizes a title as new topic, click on the question sign ( ? ) that appears at the end of the title to add content into a new page.

Editing a page

You can edit a Wiki page by clicking on Edit this Page button at page bottom when you are browsing it; or you can:

1. Click on List All Pages option at left side menu.
2. Click on Edit option next to page name in Wiki Page list

• NOTE: you must have a valid Role with Wiki write permissions to be able to edit a page.

You can format the text using the text editor controls; by this way you can also insert images, hyperlinks and tables.

You can also create links to other sections in the GForge system enclosing an item ID number inside square brackets, i.e. to add a link to forum topic 9999 you just need to enclose the section code "#F" followed of the topic number [#F9999].

Deleting a page

You can delete a page by clicking on Delete Page button at page bottom when you are browsing it; or you can:

1. Click on List All Pages option at left side menu.
2. Delete option next to page name in Wiki Page list.

• NOTE: you must have a valid Role with Wiki write permissions to be able to remove a page.

Locking / Unlocking a Page

Locking a page blocks it for further modification, also when a page is locked couldn´t be removed.

To lock / unlock page click on Lock Page / Unlock Page button at page bottom when you’re browsing it; or you can:

1. Click on List All Pages option at left side menu.
2. Click on Lock Page / Unlock Page option next to page name in Wiki Page list.

• NOTE: you must have Wiki Administrator permissions to be able to lock /unlock a page.

Version control

Version control is a powerful tool that enables keep track of page modifications and also makes possible to recover data and revert unwanted changes in an easy way.

Version control tab is located at page bottom; it shows a list of modifications along with the author and modification time starting from the current page version.

To compare changes between two versions:

1. Click in the left side check box at version entry
2. Press Show diff button.

To restore to a previous version:

1. Select it from the version list by clicking in the left side check box.
2. Press Restore Version button.

To remove an older version:

1. Select it from the version list by clicking in the left side check box.
2. Press Remove Version button.

• NOTE: you must have Wiki Administrator permissions to Remove or Restore page versions.

Associations

Association make possible to link wiki pages with other Gforge content. Association control tab is located at page bottom; it shows a list of current content associated with the wiki page.

To add a new association:

1. Click on the Add Association button in Associations tab.
2. At add new association form: select the plug-in that holds the associated item.
3. Enter its ID number
4. Add a comment to the new association
5. Press Add button.

To remove an existing association:

1. Find association reference in associations list
2. Click on Delete link.

• NOTE: you must have a valid Role with Wiki write permissions to be able to add or remove associations.