Wiki-Syntax

The Clip-Share? Wiki (using TikiWiki) has a rich and flexible system for formatting and presenting 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

[+]

Table of contents

• Formatting text with wiki syntax
• About Wiki-Syntax
• • Quick Reference - Basic Text Formatting
  • Basic Text Formatting
  • Colored Text
  • Web-Safe? HTML Colors (Click the + to Open)
  • Bold Text
  • Italic Text
  • Underlined Text
  • Strike through text
  • Centered Text
  • Monospaced Text for Code
  • Superscript and subscript
  • Text box
  • Plain Text
  • Indent
• Using Square Brackets
• Non-breaking space
• PHP Code Highlighting

Quick Reference - Basic Text Formatting

Formatting Reason	Characters Used	Example
Bold Text	2 Underscores "_"	__text__
Centered Text	2 Colons ":"	::text::
Colored Text	2 Tildes "~"	~~blue:text~~
Italic Text	2 Single Quotes "'"	''text''
MonoSpaced Text	Minus & Plus "-" & "+"	-+text+-
Underlined Text	3 Equals "="	===text===
Text Box	One carat "^"	^text^
Plain Text	surrounding np tags "~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.



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.

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

[+]

Bold Text

Two Underscore (_) characters are used to make text 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 the {TAG} plugin.

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.

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.


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.

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.

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.

PHP Code Highlighting

Use the {CODE}{CODE} tag to properly highlight code.

{CODE(ln=>1,colors=>php|highlights|phpcode,caption=>caption text,wrap=>1,wiki=>1,rtl=>1)}code{CODE} - note: colors and ln are exclusive

Parameter	Accepted values	Effect	Since
ln	0,1	This setting if present (set to 1) will provide line numbering. Warning: The ln or colors parameters are used mutually exclusively
colors	php,highlights,phpcode	This will provide code syntax colouring and highlighting. You can set this to "php","highlights" or "phpcode". Additional syntaxes may be added at a future date. Warning: The ln or colors parameters are used mutually exclusively
caption	"Caption"	This allows you to provide a caption for the code box
wrap	0,1	This enables line wrapping on the code, if necessary.
wiki	0,1	This enables wiki interpretation of the code, otherwise wiki style markup in the code is left alone.
rtl	0,1	This enables the right to left display of text

• 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 accross applications. There is an initiative to publish the Wiki-Syntax as an RFC from the IETF. See RFCWiki

---