User Documentation

The Wiki-tag system is the language you can use to format text and insert images when you edit Wiki pages. There's a common set of features that are usually present at all Wikis that Tiki maintains--as well as some special features not frequently found in Wikis that Tiki adds.

much needed tag

  • line break

needed tag behavior

  • between title tags an edit area... when wiki pages get large they become very difficult to edit efficiently


A quick reference to the Wiki-tag system is available at the bottom of a Wiki page. Click Wiki quick help to view it.

Image

Normal text

Normal text is just entered as is.

References to other Wiki pages


References are created when you use WikiWordscapitalized words smashed together, with a capital in the middle. If the referenced Wiki page already exists a link to it will be shown. If not, a link to edit the page will be displayeddesignated with a question mark after the Wiki word.

ThisIsaReference


You can prevent a name from being converted into a page by using the following syntax

))ThisIsNotReferenced((
  • Note this will not work with Tiki HotWords


You can use the following notation to create references to pages without using Wiki-style capitalization:

((this_is_a_wiki_page))


If you want to enter a description for a Wiki page use:

((this_page|This is the description))


In this case, This is the description will display instead of the original Wiki link.

Links to external pages


Links to external pages can be entered using one of the following formats:

[http://www.somesite.com]


[http://www.somesite.com|This is a nice site to visit]

[http://www.somesite.com|Hey|nocache]

VERY IMPORTANT: If you enable caching links to external pages please make sure to use the nocache directive when caching non-html pages: for example, PDF docs, binary files or similar. Otherwise, the caching system may make the page crash with an ugly message. Tiki can't determine whether a page is HTML or a large binary because it can be dynamically generated.


The first format will display the URL as a link while the second one will display the description as a link to the given URL. The third syntax can be used to prevent the link to the cache from being displayed in the page.

Tiki will automatically cache references to external pages or sites and a link to the cache will be displayed following the link. This is particulary useful when you link to notes or sections that may change or that may disappear in a near future. (Very similar to the Google cache when you see the results of a search in Google.) You can disable caching pages from the admin screen.

Bold and italic text


Bold text can be entered using two underscores before and after the text.

__This is text in bold__


Italics are displayed using two single quotes before and after the text

''this will be displayed in italics''

Underline


If you want to underline text you can use the following syntax:

===Some underlined text===

Monospaced


Sometimes it is useful to use a mono-spaced font inside a paragraph--indicating a Unix shell command, API name, etc. To do this use

-+Some monospaced text+-

Colors


You can display text using any HTML color with the following syntax:

~~#FF00FF:This is some text~~


The color can be written in hexadecimal, as in this example, or you can use a short name like red , blue and others (try them).

Centering text


If you want text to be centered you can use the following syntax:

::This text will be centered::

Special characters

~lt~, ~gt~, ~ddd~,
where ddd = decimal code of symbol (3 digits)

Additional Wiki Options


Plug-ins may also be used to format text on and add material to Wiki pages. A guide to the plug-in syntax is displayed when you click Show Plugins Help in the Wiki quick help screen above. More information on plug-ins is available: PluginsList and WikiSyntax.

For more information

WikiSyntax
WikiSyntax pages at http://doc.tiki.org
InterWiki - linking to Wikis other than your own.