A wiki-style content module for ImpressCMS

Login

Username:


Password:




Lost Password?

Main Menu

[Welcome to SimplyWiki! :: This page]  

Help With Wiki Syntax

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.

 

Method 1

Step 1: Edit an existing page and add a link to your new page


Pages are identified with their "page name". This can be any text, but you should try to keep page names as short and relevant 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 or save 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 page is viewed, any links to other wiki pages that don't exist have nopage.gif beside them to make it easy to understand the corresponding content doesn't exist yet and has to be created.

 

Method 2

 If the Add a New Page block has been activated for you, you can simply type the name of the new page in the block and click on the Submit button. You'll be taken to the new blank page to start creating your content.

 

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

 

Editing Content

SimplyWiki - The Module displays a wysiwyg editor whenever possible while editing pages. If the browser doesn't support it, the default 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 Xoops 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 wiwi pages in the document store.
<[RecentChanges]> This tag is replaced by the 20 last modified pages list.
<[Children]> Retrieves a list of pages with the current page as their parent page and displays as an unordered list
<[Siblings]> Retrieves a list of pages with the same parent page as the current page and displays as an unordered list
<[Headings]>  Create a linked table of contents for a page This will locate all the heading tags <h1> -  <h6> and creates a linked list to assist with navigation and organiztion. The list will only be created if there are 3 or more headings. You must insert <[Headings]> in the page for your TOC to display
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. Best practices are to use wiki markup only for wiki features, for HTML elements and styling, use the features of the WYSIWYG editor.

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

 

Last modified on 2023/11/7 by Curator
This page was created on 2010/11/23 by Curator

Comments
The comments are owned by the poster. We aren't responsible for their content.

Share this page!

bookmark at: Twitter bookmark at: Facebook bookmark at: MySpace bookmark at: Del.icio.us bookmark at: Digg bookmark at: Yahoo bookmark at: Google bookmark at: Diigo

Back to Top