History: Wiki Syntax
Preview of version: 29
Tiki Wiki CMS Groupware has a rich and flexible system for formatting and presenting pages.
Related 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
-
This page describes 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 a wiki web page. (For a broader overview of wiki syntax, please see Why Wiki Syntax Is Important.) To avoid requiring users to learn HTML, wiki syntax 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 a closing combination of characters is met.
Wiki syntax uses a character repeated twice for most functions, but it also has a few two-character combinations. With a two-character combination, the characters are reversed to turn off the function. Monospaced text provides a good example of this; the minus (-) and plus (+) characters are used to start the using monospaced text and plus (+) and minus (-) characters specify the end of it.
Table of contents
Quick reference - basic text formatting
Desired Formatting | Syntax | Result |
---|---|---|
Bold | __text__ | text |
Centered | ::text:: | text |
Colored Text | ~~blue:text~~ | text |
Italic | ''text'' | text |
Monospaced | -+text+- | text |
Underlined | ===text=== | text |
Text in a box | ^text^ | text |
Display syntax | ~np~__not bold__~/np~ | ~np~__not bold__~/np~ |
Basic text formatting
The wiki syntax described 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 more tildes ( ~ ) are used to end the section of colored text.
Colored text can also be specified using HTML hex color codes. (See https://en.wikipedia.org/wiki/Web_colors). 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.
Bold text
Two underscore ( _ ) characters are used to make text bold.
__This text is bold__
produces:
This text is bold
Italic text
Two single quote ( ' ) characters are used to make text italic.
Underlined text
Three equal ( = ) characters are used to underline text.
Strike-through text
Use two hyphens ( - ) to create strike-through text.
--This text uses strikethrough.--
produces:
Centered text
Two colon ( : ) characters are used to center text or other content. The centered-text syntax (which create a centered HTML div) can be used in conjunction with a box, a table, or other page element.
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.
This Text uses a Monospaced Font
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.
The Leading Space Monospaced Font is disabled on many sites.
Superscript and subscript
Use the {TAG} plugin (also see PluginTag).
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.
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:
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.
;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 it will not be seen when the page is viewed but will be seen when the page source is viewed.<!-- this is an html comment -->
Useful Links
- Why Wiki Syntax is Important
- The Color Picker II is located at http://www.pagetutor.com/pagetutor/makapage/picker/
- Web Developer extension for Mozilla Firefox
- The wiki syntax is not standardised across applications. There is an initiative to publish the Wiki-Syntax as an RFC from the IETF. See RFCWiki