Wiki

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:

  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

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.

Text Wiki Markup

The markup described on this page is for the default Text_Wiki rules.All text is entered as plain text, and will be converted to HTML entities as necessary. This means that <, >, &, and so on are converted for you (except in special situations where the characters are Wiki markup; Text_Wiki is generally smart enough to know when to convert and when not to).Just hit "return" twice to make a paragraph break. If you want to keep the same logical line but have to split it across two physical lines (such as when your editor only shows a certain number of characters per line), end the line with a backslash \ and hit return once. This will cause the two lines to be joined on display, and the backslash will not show. (If you end a line with a backslash and a tab or space, it will not be joined with the next line, and the backslash will be printed.)

Inline Formatting

//emphasis text// emphasis text
**strong text** strong text
//**emphasis and strong**// emphasis and strong
{{teletype text}} teletype text
@@--- delete text +++ insert text @@ delete text <ins> insert text </ins>
@@--- delete only @@ delete only
@@+++ insert only @@ <ins> insert only </ins>

Literal Text

If you don't want Text_Wiki to parse some text, enclose it in two backticks (not single-quotes). 

		
		This //text// gets **parsed**.
		
		``This //text// does not get **parsed**.``

This text gets parsed.This //text// does not get **parsed**.

Headings

You can make various levels of heading by putting equals-signs before and after the text (all on its own line): 

		
		+++  Level 3 Heading
		
		++++ Level 4 Heading
		
		+++++  Level 5 Heading
		
		++++++ Level 6 Heading

Level 3 Heading

Level 4 Heading

Level 5 Heading

= Level 6 Heading =

Table of Contents

To create a list of every heading, with a link to that heading, put a table of contents tag on its own line. 

		[[toc]]

Horizontal Rules

Use four dashes (----) to create a horizontal rule.

Lists

Bullet Lists

You can create bullet lists by starting a paragraph with one or more asterisks. 

		* Bullet one
		 * Sub-bullet
  • Bullet one
    • Sub-bullet

Numbered Lists

Similarly, you can create numbered lists by starting a paragraph with one or more hashes. 

		# Numero uno
		# Number two
		 # Sub-item
  1. Numero uno
  2. Number two
    1. Sub-item

Mixing Bullet and Number List Items

You can mix and match bullet and number lists: 

		# Number one
		 * Bullet
		 * Bullet
		# Number two
		 * Bullet
		 * Bullet
		  * Sub-bullet
		   # Sub-sub-number
		   # Sub-sub-number
		# Number three
		 * Bullet
		 * Bullet
  1. Number one
    • Bullet
    • Bullet
  2. Number two
    • Bullet
    • Bullet
      • Sub-bullet
        1. Sub-sub-number
        2. Sub-sub-number
  3. Number three
    • Bullet
    • Bullet

Definition Lists

You can create a definition (description) list with the following syntax: 

		: Item 1 : Something
		: Item 2 : Something else

Item 1SomethingItem 2Something else

Block Quotes

You can mark a blockquote by starting a line with one or more '>' characters, followed by a space and the text to be quoted. 

		This is normal text here.
		
		> Indent me! The quick brown fox jumps over the lazy dog. \ 
		Now this the time for all good men to come to the aid of \ 
		their country. Notice how we can continue the block-quote \ 
		in the same "paragraph" by using a backslash at the end of \ 
		the line.
		>
		> Another block, leading to...
		
		>> Second level of indenting.  This second is indented even \ 
		more than the previous one.
		
		Back to normal text.

This is normal text here.> Indent me! The quick brown fox jumps over the lazy dog. Now this the time for all good men to come to the aid of their country. Notice how we can continue the block-quote in the same "paragraph" by using a backslash at the end of the line. Another block, leading to…

Second level of indenting. This second is indented even more than the previous one.Back to normal text.—-

Links and Images

Wiki Links

]] to create a page link.You can force a ]] name not to be clickable by putting an exclamation mark in front of it. 

		WikiPage !WikiPage

]] WikiPageYou can create a "described" or "labeled" link to a wiki page by putting the page name in brackets, followed by some text. 

		[WikiPage Descriptive text for the link.]

]]> Note: existing wiki pages must be in the ]] pages configuration, and the ]] view_url configuration value must be set for the linking to work.

URLs

class Create a remote link simply by typing its URL: http://gforge.com.If you like, enclose it in brackets to create a numbered reference and avoid cluttering the page; [http://gforge.com/gf/project/] becomes 1.Or you can have a described-reference instead of a numbered reference: 

		[http://gforge.org GForge]

GForge

Images

You can put a picture in a page by typing the URL to the picture (it must end in gif, jpg, or png). 

		http://c2.com/sig/wiki.gif

http://c2.com/sig/wiki.gifYou can use the described-reference URL markup to give the image an ALT tag: 

		[http://phpsavant.com/etc/fester.jpg Fester]

Fester

Code Blocks

Create code blocks by using <code>…</code> tags (each on its own line). 

		This is an example code block!

Tables

You can create tables using pairs of vertical bars: 

		|| cell one || cell two ||
		|||| big ol' line ||
		|| cell four || cell five ||
		|| cell six || here's a very long cell ||
big ol' line
cell one cell two
cell four cell five
cell six here's a very long cell 
		|| lines must start and end || with double vertical bars || nothing ||
		|| cells are separated by || double vertical bars || nothing ||
		|||| you can span multiple columns by || starting each cell ||
		|| with extra cell |||| separators ||
		|||||| but perhaps an example is the easiest way to see ||
lines must start and end with double vertical bars nothing
cells are separated by double vertical bars nothing
you can span multiple columns by starting each cell
separators
but perhaps an example is the easiest way to see

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.

Monitoring Wiki

Monitor Wiki enables you to keep track on changes being made by other people to wiki content.

To receive mail notification whenever a change is made to a specific wiki page:

  1. Browse to page you wish to monitor
  2. Press Monitor this page option at left side menu.

To stop getting notifications from Page changes:

  1. Browse to a monitored page
  2. Press Stop monitoring page

By doing this you will not longer receive notifications when the selected page changes.

To receive email notifications when any wiki page changes:

  1. Browse to Project Wiki
  2. Select Monitor Wiki option at left side menu.

To stop getting notifications from Wiki changes

  1. Browse to Project Wiki
  2. Click on Stop monitoring option.

© 2004-2009 GForge, LLC