Loading...
 
Skip to main content

History: Wiki Syntax

Preview of version: 24

TikiWiki has a rich and flexible system for formatting and presenting pages.


-

Wiki-Syntax Images
Wiki-Syntax Links
Wiki-Syntax Lists
Wiki-Syntax Special Characters
Wiki-Syntax Tables
Advanced Wiki Syntax usage examples
Plugins advanced features/formatting that can be included in wiki pages

Formatting text with wiki syntax


-


On this page, you'll learn how to format text on Wiki pages and other area that support Wiki formatting (including articles, forums, and blogs).

About Wiki-Syntax

Wiki syntax is a markup language used in wiki. To avoid requiring users to learn HTML, it uses common characters in uncommon ways (or character combinations that are not normally used together) and provides them with a special meaning. Some of the character combinations only work at the beginning of a line, while others can be inserted anywhere in the text and are active until they are turned off.

Wiki-Syntax uses a character repeated twice for most functions, but it also has a few 2-character combinations. With a 2-character combination, the characters are reversed when the function is turned off. MonoSpaced Text provides a good example of this; the Minus (-) and Plus (+) characters are used to start the using MonoSpaced Text and a Plus (+) and Minus (-) characters specifies the end of it.

Quick Reference - Basic Text Formatting

Desired Formatting Syntax Result
Bold __text__ text
Centered ::text::
text
Color Font ~~blue:text~~ text
Italic ''text'' text
MonoSpaced -+text+- text
Underlined ===text=== text
Text box ^text^
text
Display syntax ~np~__not bold__~/np~ ~np~__not bold__~/np~

Basic Text Formatting

The Wiki-Syntax given in this section can be located anywhere in the text so that specific characters, words, or sentences can be emphasized.

Colored Text

Text can be any color you want it to be. Two Tildes (~) are used followed by the name of a color and a Colon (:) to specify the start of the Colored Text. Two other Tildes (~) are used to end the Colored Text.

Example: ~~red:This is text is Red~~ produces: This is text is Red


Colored Text can also be specified using HTML colors. HTML colors use 3 pairs of Hex numbers; one for Red, Blue, & Green so that 00 00 00 would produce black and ff ff ff would produce white. The syntax is two Tildes (~) followed by the Pound (#) character and the Hex Numbers with a Colon (:) followed by the text to be colored. Two Tildes (~) mark the end of the Colored Text.

Example: ~~#ff00ff:This is text is the color Magenta ~~ produces: This is text is the color Magenta

Web-Safe HTML Colors (Click the + to Open)

[+]

Bold Text

Two Underscore (_) characters are used to make text Bold.

Example: __This Text is Bold__ produces: This Text is Bold

Italic Text

Two Single Quote (') characters are used to make text Italic.

Example: ''This Text is Italic'' produces: This Text is Italic

Underlined Text

Three Equal (=) characters are used to underline text.

Example: ===This Text is Underlined=== produces: This Text is Underlined

Strike through text

Use the {TAG} plugin.

Example:
{TAG(tag=>strike)}This text uses strikethrough{TAG}
produces:
This text uses strikethrough.

Centered Text

Two Colon (:) characters are used to Center text. The Centered Text can be centered within a Box, a Table, or almost anything else.

Example: ::This Text is Centered:: produces:
This Text is Centered

Monospaced Text for Code

Monospaced Text is useful when displaying Code and can be created in two ways. The easiest is to start a new line with one or more spaces. The Minus (-) and Plus (+) character combination can also be used to specify a Monospaced Text.

Example: -+This Text uses a Monospaced Font+- produces: This Text uses a Monospaced Font

Image If using a Monospaced Font, be sure to keep the line length short. If the lines are too long, they will push the right column out of the browser display area.
Image The Leading Space Monospaced Font is disabled on many sites.

Superscript and subscript

Use the {TAG} plugin (also see PluginTag).

Example:
This text is {TAG(tag=>sup)}super{TAG} script.
produces:
This text is super script.


This text is {TAG(tag=>sub)}sub{TAG} script.
produces:
This text is sub script.


Image Another alternative is to use the {SUB} and {SUP} plugins which are documented at PluginSub and PluginSup.

Text box

Apply one caret at start and end of text to be in a box.

Example: ^This Text is in a box^ produces:

This Text is in a box


NOTE: This CSS style is called "simplebox" and may look different or may not exist, depending on your theme CSS.

Plain Text

To turn off tiki formatting, surround your text with 'np' a.k.a. 'no processing' tags

Example: ~np~This ''text'' is __not__ being ===formatted===~/np~ produces:

This ''text'' is __not__ being ===formatted===

NOTE: np tags cannot be used within an np block. To display an unprocessed ~np~ tag, escape all the characters (not just the tildes) while in normal processing mode:

~126~~110~~112~~126~ produces: ~np~
~126~~47~~110~~112~~126~ produces: ~/np~

Indent

Indent is formed by the combination of the ; and : characters. ; must appear at the beginning of a line and : must appear between introduction text and the indented text. The introduction text portion is useful for forming definition type indention like Example 1 below. However the introduction text can be eliminated by simply including ;: together followed by the text as shown in Example 2.

Example 1:

;Intro Text: First example of indented text
produces:

Intro Text
Indented text

Example 2:
;:2nd example of indented text

2nd example of indented text

Using Square Brackets

If you wish to include square brackets in your text (i.e. as regular text and not a link) simply add an additional open bracket to start. E.g.

[[this would not be a link]

Would render like this...

[this would not be a link]

Non-breaking space

Use ~hs~ to add the HTML " " for a non-breaking space.

Comments

Wiki Comments

~tc~ this is a tiki comment ~/tc~
Will be kept in the file but not seen when the page or page source is viewed

html Comments

~hc~ this is an html comment ~/hc~
Will be kept in the file and will generate an html comment of the form
<!-- this is an html comment -->
it will not be seen when the page is viewed but will be seen when the page source is viewed.

Useful Links

History

Information Version
Bernard Sfez / Tiki Specialist Typo 44
Bernard Sfez / Tiki Specialist Oups, changed url from Dynamic Variables doc for Wiki Argument Variables doc 43
Bernard Sfez / Tiki Specialist Wiki Daynamic Variable link added 42
Bob wiki syntax in smarty templates 41
Bernard Sfez / Tiki Specialist More cleaning about %%% 40
Bernard Sfez / Tiki Specialist Adding spaces around %%% 39
Yves Kipondo 38
Marc Laporte AutoTOC 37
Bernard Sfez / Tiki Specialist 36
Gary Cunningham-Lee Syntax characters for bold displayed in the Fancy Table, so replaced with HTML. 35
Gary Cunningham-Lee 34
Gary Cunningham-Lee Changed example external links to simplify. 33
Gary Cunningham-Lee Added missing syntax from wiki help modal. 32
Gary Cunningham-Lee 31
Gary Cunningham-Lee Removed sub and sup plugin info, improved text, etc. 30
Gary Cunningham-Lee Removed unnecessary capitalization, updated info, added link, etc. 29
lindon [Rollback by chibaguy to version 24] 28
Rick Sapir / Tiki for Smarties 27
lindon 25
lindon 24
lindon 23
Marc Laporte let's only link when page is ready. 22
lindon 21
Marc Laporte 20
Marc Laporte 19
hoyla Minor spelling correction: accross>across 18
Marc Laporte 17
campbe13 add information on comments in the wiki pages 16
mlpvolt 15
tekoa spelling correction 14
tekoa Corrected description of HTML colors. Previously said, "so that 00 00 00 would produce white". 13
Marc Laporte Why Wiki Syntax is Important 12
Carsten Schmitz 11
Carsten Schmitz 10
Rick Sapir / Tiki for Smarties added super/subscripts (via the TAG plugin) 9
Nelson Ko 8
mlpvolt 7
mlpvolt Bring back text formatting. 6
mlpvolt 5
mlpvolt 4
Danny Staple 3
amette testing - bug hunting 2
Danny Staple 1