Using the Wiki and Its Syntax

[User Guides and Resource Library :: Contributing Content :: This page]

Note: Normally you cannot display wiki codes because they will be interpreted. A special wiki code has been developed to 'display nothing' - use ._. to break up wiki codes if you wish to display them, as we do here.

Creating new pages:

The basic idea is that you create a page when you try to reach a page that doesn't exist yet. When you do this, you obtain a blank page in « edit » mode. Then you type the content and submit the new page ... you're done.

Step 1 : create a link to your future new page (edit your "index" or "home" page for example)

Pages are identified with their "page name". This can be any text, but you should try to keep page names as short as possible. You will set later a "page title" that can be more explicit.

Simply type: my page name , or my page name | hyperlink text .

Alternatively, if your new page name is a CamelCase word (that is two or more concatenated words starting with an uppercase letter: LikeThisOne), simply type it without square brackets.

Step 2 : Preview the current page, and click on the link you've just added. You will be taken to the new page in edit mode, now just type your content and save it.

Note: when a link to a new page is parsed, SimplyWiki appends a

to make it easy to understand the corresponding content doesn't exist yet and has to be created.

Organizing pages

One of the most irritating tasks in wikis is to maintain information about the page hierarchy (if applicable), and repeat it on each page you write, so that readers don't get lost and quickly browse back to page parents.

SimplyWiki's solution is an optional « parent » field in the page edit form. In view mode, Wiwi displays a navigation bar linking to all parents, climbing the page hierarchy till no more parents can be found (parent field left empty). SimplyWiki automatically sets the « parent » field of newly created pages to a reasonable guess: the wiki page that hosted the hyperlink (if applicable) leading to the current page creation.

Editing Content

SimplyWiki displays a wysiwyg editor whenever possible while editing pages. If the browser doesn't support it, the default ImpressCMS or XOOPS editor is displayed. This manual won't detail how to use the editors, yet they're easy to take hands on. Let us simply remind basic rules that are good to apply :

use tables to fully control page layout
don't use too many font styles neither colors
make simple sentences, better than neverending texts that are hard to read on screen

Table below details some special useful features :

XBLK blockref	This tag is replaced by the block with corresponding title or id. Important note: no check is (yet) done on user rights before displaying the block, so be sure of what you are doing ...
[ pagebreak]	This tag "cuts" your content in pages at display time ; a navigation bar to next and previous pages is automatically added. This is the only wiki code that cannot be displayed correctly here - there should be no space between the opening [ and the p
<[PageIndex]>	This tag is replaced by the alphabetical list of all wiki pages in the document store.
<[RecentChanges]>	This tag is replaced by the 20 last modified pages list.
Images, file attachments, flash	Depending on which editor you are using, you'll be able to upload and display resources within your page: images, files (icon displayed), flash animations.

Table below displays wiki codes that are interpreted by wiwi at display time, whenever they are found in a page content :

<text>	Text is strong
{{text}}	Text is italic
----	Horizontal rule
BR	Line break
IMG url alt	Image tag
url , or url title	Hyperlink
page name	link to another SimplyWiki page
page name \| link title	link to another SimplyWiki page
Xxx@domain.ext	« mailto » hyperlink
CamelCaseName	Link to the corresponding SimplyWiki page
~CamelCaseName	escaped camelcase: won't be converted in a link at display time.

Last modified on 2016/10/1 by Steve