Help:Formatting

This Help topic explains the available text formatting, including wiki syntax, supported HTML tags, and markup templates. It covers almost all of the important formatting options - if you need more information see the generic mediawiki help topic: Help:Formatting.

The Wiki Editor contains tool buttons for the most important wiki functionality (these are shown below in the "Wiki Editor" column) and a help information section for many of the remaining options. As a result, many users will not need to ever know this syntax described here. Note however that there is some wiki specfic markup for code blocks and inline code.

Description	Wiki Editor	Markup	Result
Bold		'''Bold text'''	Bold text
Italic		''Italic text''	Italic text
Bold & Italic		'''''Bold and Italic text'''''	Bold and Italic text
Bigger		This text is <big>Bigger</big> than the rest	This text is Bigger than the rest
Smaller		This text is <small>Smaller</small> than the rest	This text is Smaller than the rest
Superscript		This text is <sup>superscript</sup>	This text is superscript
Subscript		This text is <sub>subscript</sub>	This text is subscript
File or Image		[[File:NotifierExample.zip]]	File:NotifierExample.zip. Note if the file is an image, the image will be displayed rather than a file link. See Help:Links for more information.
Link		[[Target page]] (internal link)	Target page. See Help:Links for information about internal, external and other link formats
Signature and timestamp		--~~~~	--hamishwillee 09:34, 13 May 2011 (EEST)
Headings		== Level 2 Heading == === Level 3 Heading === ==== Level 4 Heading ==== ===== Level 5 Heading ===== ====== Level 6 Heading ====== Notes: Level 1 heading is rarely used, and is hence not provided by wiki editor The heading must start on a new line	Level 2 Heading Level 3 Heading Level 4 Heading Level 5 Heading Level 6 Heading
Bulleted list		* Each bullet is started by an asterisk on a new line ** Nested bullets are created using multiple asterisks *** There can be many levels of nesting Notes: The wiki editor simply creates an asterisk (a top level bullet). It doesn't do multi level or group bulleting. Line breaks do break levels	Each bullet is started by an asterisk on a new line Nested bullets are created using multiple asterisks There can be many levels of nesting
Numbered list		# Each numbered item is preceded by a "#" on a new lin # There can be as many numbers as you like ## You can indent the numbers ### Multiple times ## If you need to Notes: The wiki editor simply creates a hash(a top level bullet). It doesn't do multi level or group numbering.	Each numbered item is preceded by a "#" on a new lin There can be as many numbers as you like You can indent the numbers Multiple times if you need to
Indentation		: first level indentation. :: second level indentation ::: third level indentation :: second level indentation Notes: Indentation occurs when any line starts with a colon (:) The wiki editor simply creates a colon before the first selected text.	first level indentation. second level indentation third level indentation second level indentation
Gallery		<gallery widths="200px" heights="400px"> File:Example.jpg|Caption1 File:Example.jpg|Caption2 </gallery>	If optional parameters widths and heights are specified, the images will be resized to the chosen resolution
Table		-	See Help:Tables for information
Newline		<br /> Note: The preferred approach is to simply put a blank line between lines of text. This just adds a HTML line break.	-
Underline	-	<u>Underline</u>	Underline
Strikethrough	-	<del>Strikethrough</del> or <s>Strikethrough</s> or <strike>Strikethrough</strike>	Strikethrough or Strikethrough or Strikethrough
Blockquotes	-	some text some text <blockquote>blockquote</blockquote> some text some text	some text some text blockquote some text some text
Comment	-	<!-- This is a comment -->	Comments only visible when editing
Preformatted text	-	Text on a line that starts with a space. Wiki '''markup''' is still ''obeyed''	Text on a line that starts with a space. Wiki markup is still obeyed
Fully Preformatted text	-	<pre>Preformatted text. Wiki '''markup''' is not ''obeyed''</pre>	Preformatted text. Wiki '''markup''' is not ''obeyed''
Preformatted text with styling	-	<pre style="color:red">Preformatted text with styling</pre>	Preformatted text with styling
Horizontal line	-	some text ---- some text	some text some text
Inline code	-	{{Icode|ApiName}} (preferred) or <tt>ApiName</tt>	ApiName (preferred) or ApiName
Code blocks	-	See Help:Code Syntax Highlighting <code cpp> class CMyActiveObject: public CActive { public: ~CMyActiveObject(); static CMyActiveObject* NewL(); protected: CMyActiveObject(); void ConstructL(); protected: virtual void RunL(); // Inherited from CActive. virtual void DoCancel(); virtual TInt RunError(TInt aError); private: ... };</code> Notes: You can specify the type of code - cpp (C++ - as above), java, python, text, etc. The list of supported languages is here. Add line numbers using the "n" parameter. ie <code cpp n> (There is no way to specify the "starting" line number) Example class CMyActiveObject: public CActive { public: ~CMyActiveObject(); static CMyActiveObject* NewL(); protected: CMyActiveObject(); void ConstructL(); ... };	class CMyActiveObject: public CActive { public: ~CMyActiveObject(); static CMyActiveObject* NewL(); protected: CMyActiveObject(); void ConstructL(); protected: virtual void RunL(); // Inherited from CActive. virtual void DoCancel(); virtual TInt RunError(TInt aError); private: ... };
Table of contents	-	__NOTOC__ to turn of the TOC __FORCETOC__ to force TOC to render in a certain position __NOEDITSECTION__ to disable edit link for subheadings Note: By default the TOC is displayed if there are more than 4 headings in a topic.	-

Special Characters

The Wiki Editor provides a section for adding hundreds of special characters, including Latin, Latin Extended, IPA,Symbols, Greek, Cyrillic, Arabic, Hebrew, Telugu, Sinhala, and Gujarati:

If the character you need is not offered by the Wiki Editor you can add it manually using its character code. These codes can usually be found through a simple Internet search.