Wiki

Go back to Integria IMS Documentation Index

The Wiki is a very basic system for sharing information with other users, it contains formatted and structured text with external and internal hyperlinks. Being editable, it is a simple tool for collaboration and information sharing that supports the following features:

  • Wiki syntax title hierarchies, hyperlinks, lists, images.
  • Change management.
  • File upload and linking them from the Wiki.
  • Generating tables of contents and hierarchical information views (title, subtitle, etc.).
  • Preformatted, bold, italic.
  • Integria IMS Wiki has an ACL system by which you may restrict who has read or write access to it. It also has an extended ACL system by which you may also specify at user level who has permissions to see a page and who does not.

Basic syntax

This is a brief summary of its syntax.

Headers

One or more exclamation points are placed at the beginning of a line. Example:

!Heading H2
!!Heading H3!!!Heading H4

The more exclamation points you use, the smaller the title (up to 5 exclamation points). The exclamation marks have to be exactly at the beginning of the line. After saving the edit, each title or subtitle will have a button to edit the corresponding section.

Lists and numbered lists

Each item in the list must begin with one or more asterisks. Unnumbered list example:

* Fruit
** Apple
*** Granny smith
** Orange
* Vegetables
** Garlic
** Onion

It will look like:

  • Fruit
    • Apple
      • Granny smith
    • Orange
  • Vegetables
  • Garlic
  • Onion

Example of numbered list:

# First item
## First subitem
### First subsubitem
## Second subitem

It will look like:

  1. First item
    1. First subitem
      1. First subsubitem
    2. Second subitem

Letter styles

Bold : three single quotes at the beginning and end of the text.

'''bold'''

Italic: Two single quotes at the beginning and end of the text.

''italic''

Underlined: With quotation mark and two dashes at the beginning and end of the text.

'__underlined__'

Strikethrough: With quotation mark and two dashes at the beginning and end of the text.

'--strikethrough--'

Just write the link like this:

[http://www.example.com/]

http://www.example.com

or, if you want to add text to the link:

[Main project page|http://www.example.com/]

Main project page

Emails and web pages are also automatically recognized:

http://example.com

http://example.com

[email protected]

[email protected]

You may also use relative links, but it has to start with ./ (otherwise it will be interpreted as page or internal Wiki link). So if you want to link some HTML page in the same directory, you may use:

[Interesting page|./SomeWebPage.html] → Interesting page

Images

To use the image as a link:

[http://myweb.com/lion.jpg|link=http://myweb.com/]

You may place the image left, right, or centered and add a caption, like in this example.

[http://myweb.com/lion.jpg|link=http://myweb.com/|center|title=Big Lion]

Tables of contents

Table of contents can be generated automatically with {TOC}. Each title or subtitle (header) will be used as an item for the table of contents.

Code or preformat

It is very useful when you wish to avoid that the Wiki “formats” something or misinterprets it, useful to enter code, or raw information. The format used is { { followed by the code or text and } }. All the text in between will be formatted like this:

{{
import sys
if len(sys.argv) == 2:
print "Hello",sys.argv[1]
}}

Horizontal line

Using four hyphens —- in one line and nothing else.


Avoiding the Wiki format

Using the ^ character before any special word (character escaping). For instance:

^{{code}}

HTML code

You may enter HTML code directly into the wiki, as long as you use the {html} and {/html} tags. For example, a header could also be entered like this:

{html}<h2>HTML code</h2>{/html}

Blank line

Use {br} to enter newlines and/or blank lines.

Wiki Menu

You may modify the Wiki menu, inserting your own links in HTML format. For that you have to have a special page called side_menu. Go to the Admin pages section from the Wiki menu, for all pages, including the special side_menu page.

In there you must enter the HTML code directly linking to what you want, it can be a Wiki page or something external.

Example: Suppose you have a Wiki page named “office”. The link would be something like:

http://localhost/integria/index.php?sec=wiki&sec2=operation/wiki/wiki&page=Office

Create a code in the side_menu page with the following format:

<li><a href='http://localhost/integria/index.php?sec=wiki&sec2=operation/wiki/wiki&page=Telephone_ES'>Phone numbers</a>

Read and write permissions

This Enterprise feature allows you to manage access to content. Overall, all pages are accessible and editable by all users. But administrator users can create access lists for reading and writing of each page in the side menu entries: ACL Reading and ACL writing.

If a content does not have users on its read or write list, it will be accessible to everyone. See for example the read access for this page:

When you add a user to the access lists, only those users (and any administrator) will have read or write permissions.

To edit a page's access, go to that particular page and from there, use the Read ACL or Write ACL menu options to edit the read or write access lists for that particular page. Each Wiki page will have its own access list.

Go back to Integria IMS Documentation Index