Wiki source for ImprovedFormattingRules
The following page replaces the current FormattingRules in the latest [[http://wush.net/trac/wikka/browser/trunk/ | development version]].
----
======Wikka Formatting Guide======
<<**Note:** Anything between 2 sets of double-quotes is not formatted.<<::c::
Once you have read through this, test your formatting skills in the SandBox.
----
===1. Text Formatting===
~##""**I'm bold**""##
~**I'm bold **
~##""//I'm italic text!//""##
~//I'm italic text!//
~##""And I'm __underlined__!""##
~And I'm __underlined__!
~##""##monospace text##""##
~##monospace text##
~##""''highlight text''""## (using 2 single-quotes)
~''highlight text''
~##""++Strike through text++""##
~++Strike through text++
~##""Press #%ANY KEY#%""##
~Press #%ANY KEY#%
~##""@@Center text@@""##
~@@Center text@@
===2. Headers===
Use between five ##=## (for the biggest header) and two ##=## (for the smallest header) on both sides of a text to render it as a header.
~##""====== Really big header ======""##
~====== Really big header ======
~##""===== Rather big header =====""##
~===== Rather big header =====
~##""==== Medium header ====""##
~==== Medium header ====
~##""=== Not-so-big header ===""##
~=== Not-so-big header ===
~##""== Smallish header ==""##
~== Smallish header ==
===3. Horizontal separator===
~##""----""##
----
===4. Forced line break===
~##""---""##
---
~##""This line to break --- right here""##
~This line to break --- right here
===5. Lists and indents===
You can indent text using a **~**, a **tab** or **4 spaces** (which will auto-convert into a tab).
##""~This text is indented<br />~~This text is double-indented<br /> This text is also indented<br /> This text is also double indented""##
~This text is indented
~~This text is double-indented
This text is also indented
This text is also double indented
To create bulleted/ordered lists, use the following markup (you can always use 4 spaces instead of a ##**~**##):
**Bulleted lists**
##""~- Line one""##
##""~~- Line two""##
##""~-Line three""##
~-Line one
~~-Line two
~-Line three
**Numbered lists**
##""~1) Line one""##
##""~1) Line two""##
~1)Line one
~1)Line two
**Ordered lists using uppercase characters**
##""~A) Line one""##
##""~A) Line two""##
~A)Line one
~A)Line two
**Ordered lists using lowercase characters**
##""~a) Line one""##
##""~a) Line two""##
~a)Line one
~a)Line two
**Ordered lists using roman numerals**
##""~I) Line one""##
##""~I) Line two""##
~I)Line one
~I)Line two
**Ordered lists using lowercase roman numerals**
##""~i) Line one""##
##""~i) Line two""##
~i)Line one
~i)Line two
===6. Inline comments===
To format some text as an inline comment, use an indent ( **~**, a **tab** or **4 spaces**) followed by a **""&""**.
**Example:**
##""~& Comment""##
##""~~& Subcomment""##
##""~~~& Subsubcomment""##
~& Comment
~~& Subcomment
~~~& Subsubcomment
===7. Images===
To place images on a Wiki page, you can use the ##image## action.
**Example:**
~##""{{image class="center" alt="DVD logo" title="An Image Link" url="images/dvdvideo.gif" link="RecentChanges"}}""##
~{{image class="center" alt="dvd logo" title="An Image Link" url="images/dvdvideo.gif" link="RecentChanges"}}
Links can be external, or internal Wiki links. You don't need to enter a link at all, and in that case just an image will be inserted. You can use the optional classes ##left## and ##right## to float images left and right. You don't need to use all those attributes, only ##url## is required while ##alt## is recommended for accessibility.
===8. Links===
To create a **link to a wiki page** you can use any of the following options: ---
~1) type a ##""WikiName""##: --- --- ##""FormattingRules""## --- FormattingRules --- ---
~1) add a forced link surrounding the page name by ##""[[""## | and ##""]]""## (everything after the first space will be shown as description): --- --- ##""[[SandBox | Test your formatting skills]]""## --- [[SandBox | Test your formatting skills]] --- --- ##""[[SandBox | 沙箱]]""## --- [[SandBox | 沙箱]] --- ---
~1) add an image with a link (see instructions above).
To **link to external pages**, you can do any of the following: ---
~1) type a URL inside the page: --- --- ##""http://www.example.com""## --- http://www.example.com --- ---
~1) add a forced link surrounding the URL by ##""[[""## | and ##""]]""## (everything after the first space will be shown as description): --- --- ##""[[http://example.com/jenna/ | Jenna's Home Page]]""## --- [[http://example.com/jenna/ | Jenna's Home Page]] --- --- ##""[[[email protected] | Write me!]]""## --- [[[email protected] | Write me!]] --- ---
~1) add an image with a link (see instructions above);
~1) add an interwiki link (browse the [[Docs:InterWiki | list of available interwiki tags]]): --- --- ##""WikiPedia:WikkaWiki""## --- WikiPedia:WikkaWiki --- --- ##""Google:CSS""## --- Google:CSS --- --- ##""Thesaurus:Happy""## --- Thesaurus:Happy --- ---
===9. Tables===
To create a table, you can use the ##table## action.
**Example:**
~##""{{table columns="3" cellpadding="1" cells="BIG;GREEN;FROGS;yes;yes;no;no;no;###"}}""##
~{{table columns="3" cellpadding="1" cells="BIG;GREEN;FROGS;yes;yes;no;no;no;###"}}
Note that ##""###""## must be used to indicate an empty cell.
Complex tables can also be created by embedding HTML code in a wiki page (see instructions below).
===10. Colored Text===
Colored text can be created using the ##color## action:
**Example:**
~##""{{color c="blue" text="This is a test."}}""##
~{{color c="blue" text="This is a test."}}
You can also use hex values:
**Example:**
~##""{{color hex="#DD0000" text="This is another test."}}""##
~{{color hex="#DD0000" text="This is another test."}}
===11. Floats===
To create a **left floated box**, use two ##<## characters before and after the block.
**Example:**
~##""<<Some text in a left-floated box hanging around<< Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler.""##
<<Some text in a left-floated box hanging around<<Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler.
::c::To create a **right floated box**, use two ##>## characters before and after the block.
**Example:**
~##"">>Some text in a right-floated box hanging around>> Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler.""##
>>Some text in a right-floated box hanging around>>Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler.
::c:: Use ##""::c::""## to clear floated blocks.
----
===12. Code formatters===
You can easily embed code blocks in a wiki page using a simple markup. Anything within a code block is displayed literally.
To create a **generic code block** you can use the following markup:
~##""%% This is a code block %%""##.
%% This is a code block %%
To create a **code block with syntax highlighting**, you must specify a code formatter (see below for a list of available code formatters). If line numbering is enabled in the wiki configuration, you can also specify a starting line number.
**Example:**
~##""%%(php;15)<br /><?php<br />phpinfo();<br />echo "Hello, World!";<br />?><br />%%""##
%%(php;15)
<?php
phpinfo();
echo "Hello, World!";
?>
%%
**List of available code formatters:**
{{table columns="2" cellpadding="1" cells="LANGUAGE;FORMATTER;Actionscript;actionscript;ADA;ada;Apache Log;apache;ASM;asm;ASP;asp;Bash;bash;C;c;C for Macs;c_mac;c#;csharp;C++;cpp;CAD DCL;caddcl;CadLisp;cadlisp;CSS;css;Delphi;delphi;HTML;html4strict;Java;java;Javascript;javascript;Lisp;lisp;Lua;lua;NSIS;nsis;Objective C;objc;OpenOffice BASIC;oobas;Pascal;pascal;Perl;perl;PHP;php;Python;phyton;Q(uick)BASIC;qbasic;Smarty;smarty;SQL;sql;VB.NET;vbnet;Visual BASIC;vb;Visual Fox Pro;visualfoxpro;XML;xml"}}
===13. Mindmaps===
Wikka has native support for [[Wikka:FreeMind | mindmaps]]. There are two options for embedding a mindmap in a wiki page.
**Option 1:** Upload a ""FreeMind"" file to a webserver, and then place a link to it on a wikka page:
~##""http://yourdomain.com/freemind/freemind.mm""##
~No special formatting is necessary.
**Option 2:** Paste the ""FreeMind"" data directly into a wikka page:
~- Open a ""FreeMind"" file with a text editor.
~- Select all, and copy the data.
~- Browse to your Wikka site and paste the Freemind data into a page.
===14. Embedded HTML===
You can easily paste HTML in a wiki page by wrapping it into two sets of doublequotes.
~##""[html code]""##
**Examples:**
~##""y = x<sup>n+1</sup>""##
~""y = x<sup>n+1</sup>""
~##""<acronym title="Cascade Style Sheet">CSS</acronym>""##
~""<acronym title="Cascade Style Sheet">CSS</acronym>""
By default, some HTML tags are removed by the ""SafeHTML"" parser to protect against potentially dangerous code. The list of tags that are stripped can be found on the Wikka:SafeHTML page.
It is possible to allow //all// HTML tags to be used, see Wikka:UsingHTML for more information.
----
CategoryWiki
----
======Wikka Formatting Guide======
<<**Note:** Anything between 2 sets of double-quotes is not formatted.<<::c::
Once you have read through this, test your formatting skills in the SandBox.
----
===1. Text Formatting===
~##""**I'm bold**""##
~**I'm bold **
~##""//I'm italic text!//""##
~//I'm italic text!//
~##""And I'm __underlined__!""##
~And I'm __underlined__!
~##""##monospace text##""##
~##monospace text##
~##""''highlight text''""## (using 2 single-quotes)
~''highlight text''
~##""++Strike through text++""##
~++Strike through text++
~##""Press #%ANY KEY#%""##
~Press #%ANY KEY#%
~##""@@Center text@@""##
~@@Center text@@
===2. Headers===
Use between five ##=## (for the biggest header) and two ##=## (for the smallest header) on both sides of a text to render it as a header.
~##""====== Really big header ======""##
~====== Really big header ======
~##""===== Rather big header =====""##
~===== Rather big header =====
~##""==== Medium header ====""##
~==== Medium header ====
~##""=== Not-so-big header ===""##
~=== Not-so-big header ===
~##""== Smallish header ==""##
~== Smallish header ==
===3. Horizontal separator===
~##""----""##
----
===4. Forced line break===
~##""---""##
---
~##""This line to break --- right here""##
~This line to break --- right here
===5. Lists and indents===
You can indent text using a **~**, a **tab** or **4 spaces** (which will auto-convert into a tab).
##""~This text is indented<br />~~This text is double-indented<br /> This text is also indented<br /> This text is also double indented""##
~This text is indented
~~This text is double-indented
This text is also indented
This text is also double indented
To create bulleted/ordered lists, use the following markup (you can always use 4 spaces instead of a ##**~**##):
**Bulleted lists**
##""~- Line one""##
##""~~- Line two""##
##""~-Line three""##
~-Line one
~~-Line two
~-Line three
**Numbered lists**
##""~1) Line one""##
##""~1) Line two""##
~1)Line one
~1)Line two
**Ordered lists using uppercase characters**
##""~A) Line one""##
##""~A) Line two""##
~A)Line one
~A)Line two
**Ordered lists using lowercase characters**
##""~a) Line one""##
##""~a) Line two""##
~a)Line one
~a)Line two
**Ordered lists using roman numerals**
##""~I) Line one""##
##""~I) Line two""##
~I)Line one
~I)Line two
**Ordered lists using lowercase roman numerals**
##""~i) Line one""##
##""~i) Line two""##
~i)Line one
~i)Line two
===6. Inline comments===
To format some text as an inline comment, use an indent ( **~**, a **tab** or **4 spaces**) followed by a **""&""**.
**Example:**
##""~& Comment""##
##""~~& Subcomment""##
##""~~~& Subsubcomment""##
~& Comment
~~& Subcomment
~~~& Subsubcomment
===7. Images===
To place images on a Wiki page, you can use the ##image## action.
**Example:**
~##""{{image class="center" alt="DVD logo" title="An Image Link" url="images/dvdvideo.gif" link="RecentChanges"}}""##
~{{image class="center" alt="dvd logo" title="An Image Link" url="images/dvdvideo.gif" link="RecentChanges"}}
Links can be external, or internal Wiki links. You don't need to enter a link at all, and in that case just an image will be inserted. You can use the optional classes ##left## and ##right## to float images left and right. You don't need to use all those attributes, only ##url## is required while ##alt## is recommended for accessibility.
===8. Links===
To create a **link to a wiki page** you can use any of the following options: ---
~1) type a ##""WikiName""##: --- --- ##""FormattingRules""## --- FormattingRules --- ---
~1) add a forced link surrounding the page name by ##""[[""## | and ##""]]""## (everything after the first space will be shown as description): --- --- ##""[[SandBox | Test your formatting skills]]""## --- [[SandBox | Test your formatting skills]] --- --- ##""[[SandBox | 沙箱]]""## --- [[SandBox | 沙箱]] --- ---
~1) add an image with a link (see instructions above).
To **link to external pages**, you can do any of the following: ---
~1) type a URL inside the page: --- --- ##""http://www.example.com""## --- http://www.example.com --- ---
~1) add a forced link surrounding the URL by ##""[[""## | and ##""]]""## (everything after the first space will be shown as description): --- --- ##""[[http://example.com/jenna/ | Jenna's Home Page]]""## --- [[http://example.com/jenna/ | Jenna's Home Page]] --- --- ##""[[[email protected] | Write me!]]""## --- [[[email protected] | Write me!]] --- ---
~1) add an image with a link (see instructions above);
~1) add an interwiki link (browse the [[Docs:InterWiki | list of available interwiki tags]]): --- --- ##""WikiPedia:WikkaWiki""## --- WikiPedia:WikkaWiki --- --- ##""Google:CSS""## --- Google:CSS --- --- ##""Thesaurus:Happy""## --- Thesaurus:Happy --- ---
===9. Tables===
To create a table, you can use the ##table## action.
**Example:**
~##""{{table columns="3" cellpadding="1" cells="BIG;GREEN;FROGS;yes;yes;no;no;no;###"}}""##
~{{table columns="3" cellpadding="1" cells="BIG;GREEN;FROGS;yes;yes;no;no;no;###"}}
Note that ##""###""## must be used to indicate an empty cell.
Complex tables can also be created by embedding HTML code in a wiki page (see instructions below).
===10. Colored Text===
Colored text can be created using the ##color## action:
**Example:**
~##""{{color c="blue" text="This is a test."}}""##
~{{color c="blue" text="This is a test."}}
You can also use hex values:
**Example:**
~##""{{color hex="#DD0000" text="This is another test."}}""##
~{{color hex="#DD0000" text="This is another test."}}
===11. Floats===
To create a **left floated box**, use two ##<## characters before and after the block.
**Example:**
~##""<<Some text in a left-floated box hanging around<< Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler.""##
<<Some text in a left-floated box hanging around<<Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler.
::c::To create a **right floated box**, use two ##>## characters before and after the block.
**Example:**
~##"">>Some text in a right-floated box hanging around>> Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler.""##
>>Some text in a right-floated box hanging around>>Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler.
::c:: Use ##""::c::""## to clear floated blocks.
----
===12. Code formatters===
You can easily embed code blocks in a wiki page using a simple markup. Anything within a code block is displayed literally.
To create a **generic code block** you can use the following markup:
~##""%% This is a code block %%""##.
%% This is a code block %%
To create a **code block with syntax highlighting**, you must specify a code formatter (see below for a list of available code formatters). If line numbering is enabled in the wiki configuration, you can also specify a starting line number.
**Example:**
~##""%%(php;15)<br /><?php<br />phpinfo();<br />echo "Hello, World!";<br />?><br />%%""##
%%(php;15)
<?php
phpinfo();
echo "Hello, World!";
?>
%%
**List of available code formatters:**
{{table columns="2" cellpadding="1" cells="LANGUAGE;FORMATTER;Actionscript;actionscript;ADA;ada;Apache Log;apache;ASM;asm;ASP;asp;Bash;bash;C;c;C for Macs;c_mac;c#;csharp;C++;cpp;CAD DCL;caddcl;CadLisp;cadlisp;CSS;css;Delphi;delphi;HTML;html4strict;Java;java;Javascript;javascript;Lisp;lisp;Lua;lua;NSIS;nsis;Objective C;objc;OpenOffice BASIC;oobas;Pascal;pascal;Perl;perl;PHP;php;Python;phyton;Q(uick)BASIC;qbasic;Smarty;smarty;SQL;sql;VB.NET;vbnet;Visual BASIC;vb;Visual Fox Pro;visualfoxpro;XML;xml"}}
===13. Mindmaps===
Wikka has native support for [[Wikka:FreeMind | mindmaps]]. There are two options for embedding a mindmap in a wiki page.
**Option 1:** Upload a ""FreeMind"" file to a webserver, and then place a link to it on a wikka page:
~##""http://yourdomain.com/freemind/freemind.mm""##
~No special formatting is necessary.
**Option 2:** Paste the ""FreeMind"" data directly into a wikka page:
~- Open a ""FreeMind"" file with a text editor.
~- Select all, and copy the data.
~- Browse to your Wikka site and paste the Freemind data into a page.
===14. Embedded HTML===
You can easily paste HTML in a wiki page by wrapping it into two sets of doublequotes.
~##""[html code]""##
**Examples:**
~##""y = x<sup>n+1</sup>""##
~""y = x<sup>n+1</sup>""
~##""<acronym title="Cascade Style Sheet">CSS</acronym>""##
~""<acronym title="Cascade Style Sheet">CSS</acronym>""
By default, some HTML tags are removed by the ""SafeHTML"" parser to protect against potentially dangerous code. The list of tags that are stripped can be found on the Wikka:SafeHTML page.
It is possible to allow //all// HTML tags to be used, see Wikka:UsingHTML for more information.
----
CategoryWiki
