Loading...
 

Quick guide to Tiki

A guide to customizing PHPRunner/ASPRunnerPro is created using Tiki Wiki CMS Groupware (Tiki) since it allows to work collaboratively with others.

Note that all website visitors can read the articles posted here. And only registered users can comment the articles, add and edit content helping us to extend and update the guide. Register or Log in to start editing.

How to add comments

To leave a comment to the article, use the comments editor at the bottom of each wiki page.

How to create a new article (wiki page)

Available to registered users only.

To add new article to the guide (create new wiki page), use the Add page box at the top of each article. Note that new article will be created as next page to the currently opened page on the table of contents (Child option disabled) or as a child page to the currently opened page (Child option enabled).

Another method of creating wiki pages is by using the Quick Edit a Wiki Page box on the left panel. Since the pages created in such a way are not added to the guide structure automatically and this should be done manually, we do not recommend to use this option for creating new articles.

How to edit a page

Available to registered users only.

To edit a page, use the Edit this page button at the bottom of each wiki page. If you know the name of the page that you want to edit, you can use Quick Edit a Wiki Page box on the left panel.

Wiki syntax

Wiki syntax is used to format and style the text in a wiki page. Wiki page is opened for editing in the wiki editor that supports basic text formatting options and allows to style the text without learning wiki syntax.

For those who are interested with the notation of wiki syntax, we propose to learn the wiki syntax for some common text formatting. Full list of wiki syntax elements you can find at http://doc.tiki.org/Using+Wiki+Pages.

Bold
__text__
(two underscores) produces
text

Italic
''text''
(two single quotes) produces
text

Underline
===text===
produces
text

Bulleted list
* text
produces

  • text

Numbered list
# text
produces

  1. text

Link to a Wiki page
((Wiki Page Name))

Link to a Web page
[http://www.somesite.org]
[http://www.somesite.org|Site name]

Plain text
To turn off tiki formatting, surround your text with ~np~ and ~/np~ tags.
~np~__text__~/np~
produces
__text__

LineBreak (forced)
text %%% text %%% text
produces

text
text
text

Indent
;Intro Text: First example of indented text
produces

Intro Text
First example of indented text


;:2nd example of indented text
produces

2nd example of indented text


Table of Contents
Use the {maketoc} tag to automatically create a table of contents, based on the headings on the current wiki page. Use the {toc} tag to create a table of contents, based on the sub-pages of the current page.

Displaying code
Surround you code with {CODE()} and {CODE} tags. Note this is a smarty construct, not a Wiki syntax.

{CODE(caption="PHP" wrap="1" colors="php")}echo "Hello World";{CODE}
produces

PHP
echo "Hello World";


Displaying images
Any image of the following formats .BMP, .JPG, .GIF, .PNG can be displayed on a wiki page through the use of img plugin. When editing a page, click on the Image icon in the toolbar to bring up a popup form to easily enter the parameters for this plugin.

To display an image on a page, it must be uploaded to a web site. To upload images, click on the Image icon in the toolbar when editing a page.

Tables
||row1-column1|row1-column2
row2-column1|row2-column2||

produces

row1-column1row1-column2
row2-column1row2-column2


Headings
!Heading1
produces

Heading1

!!Heading2
produces

Heading2

The content below a Heading can also be expandable. An Expandable Area is created by adding a Plus (+) or Minus (-) character after the Exclamation Marks. The Plus (+) and Minus (-) characters define what the default value is for the expandable area as shown below.

[-] Open Expandable Area

text text text

[+] Closed Expandable Area