FormattingRules

Wikka Formatting Guide



 

Escaping Markup


Anything between 2 sets of double-quotes is not formatted.
This is the equivalent of escaping a character(s):

In this case, the second set of ** (escaped) stars will be ignored, i.e., will not terminate the bold markup.

You can also use double-quote escaping to avoid linking of CamelCase words, e.g.

1. Text Formatting


 
 
 
 
 
Elides (hides) content from displaying. Eliminates trailing whitespace so there are no unsightly gaps in output. Useful for commenting Wikka markup.
 
Elides (hides) content from displaying. Preserves trailing
whitespace (note the gap).

2. Headers


Use between six = (for the biggest header) and two = (for the smallest header) on both sides of a text to render it as a header.

 
 
 

3. Horizontal separator

-


-

4. Forced line break


Line 1 Line 2

Line 1
Line 2

5. Lists and indents


You can indent text using a tilde (~), a tab, or four spaces (which will auto-convert into a tab).
 

To create bulleted/ordered lists, use the following markup (you can always use 4 spaces instead of a tilde):

Bulleted lists
 

Numbered lists
 

Ordered lists using uppercase characters
 

Ordered lists using lowercase characters
 

Ordered lists using uppercase Roman numerals
 

Ordered lists using lowercase Roman numerals
 

6. Inline comments


To format some text as an inline comment, use an indent (tilde, tab, or four spaces) followed by a &.

 


7. Images


To place images on a Wiki page, you can use the image action.

Image 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.



To create a link to a wiki page you can use any of the
following options:


FormattingRules
Wikka Formatting Guide




[[SandBox|Test your formatting skills]]
Test your formatting skills

[[SandBox|沙箱]]
沙箱





To link to external pages , you can do any of the following:


http://blog.wikkawiki.org
http://blog.wikkawiki.org




[[http://docs.wikkawiki.org|Wikka documentation]]
Wikka documentation

[[community@wikkawiki.org|Wikka community list]]
Wikka community list





WikiPedia:WikkaWiki
WikiPedia:WikkaWiki

Google:CSS
Google:CSS

Thesaurus:Happy
Thesaurus:Happy




9. Tables


 

Tables can be created using two pipe (||) symbols. Everything in a single line is rendered as a table row.

Example:


||Cell 1||Cell 2||

Cell 1Cell 2


Header cells can be rendered by placing an equals sign between the pipes.

Example:
|=|Header 1|=|Header 2||
||Cell 1||Cell 2||

Header 1Header 2
Cell 1Cell 2


Row and column spans are specified with x: and y: in parentheses just after the pipes.

Example:


|=| |=|(x:2)Columns||
|=|(y:2) Rows||Cell 1||Cell 2||
||Cell 3||Cell 4||

Columns
RowsCell 1Cell 2
Cell 3Cell 4


Many additional features are available using table markup. A more comprehensive table markup guide is available on this server's Wikka Table Markup Guide page. A complete syntax reference is available on this server's Wikka Table Markup Reference page.

10. Colored Text


Colored text can be created using the color action:

You can also use hex values:
 

Alternatively, you can specify a foreground and background color using the fg and bg parameters (they accept both named and hex values):
 


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 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.

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 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.
 

Note: 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 need to specify a code formatter (see below for a list of available code formatters).

%%(php)
echo "Hello, World!";
?>
%%



<?php
echo "Hello, World!";
?>



You can also specify an optional starting line number.
%%(php;15)
echo "Hello, World!";
?>
%%



  1. <?php
  2. echo "Hello, World!";
  3. ?>



If you specify a filename , this will be used for downloading the code.
%%(php;15;test.php)
echo "Hello, World!";
?>
%%



test.php (line 15)
  1. <?php
  2. echo "Hello, World!";
  3. ?>




List of available code formatters
LanguageFormatterLanguageFormatterLanguageFormatter
ActionscriptactionscriptABAPabapADAada
Apache LogapacheAppleScriptapplescriptASMasm
ASPaspAutoITautoitBashbash
BlitzBasicblitzbasicBasic4GLbasic4glbnfbnf
CcC for Macsc_macC#csharp
C++cppC++ (+QT)cpp-qtCAD DCLcaddcl
CadLispcadlispCFDGcfdgColdFusioncfm
CSScssDdDelphidelphi
Diff-OutputdiffDIVdivDOSdos
DotdotEiffeleiffelFortranfortran
FreeBasicfreebasicFOURJ's Genero 4GLgeneroGMLgml
GroovygroovyHaskellhaskellHTMLhtml4strict
INIiniInno ScriptinnoIoio
Java 5java5JavajavaJavascriptjavascript
LaTeXlatexLisplispLualua
MatlabmatlabmIRC ScriptingmircMicrochip Assemblermpasm
Microsoft RegistryregMotorola 68k Assemblerm68kMySQLmysql
NSISnsisObjective CobjcOpenOffice BASICoobas
Objective CamlocamlObjective Caml (brief)ocaml-briefOracle 8oracle8
PascalpascalPer (FOURJ's Genero 4GL)perPerlperl
PHPphpPHP (brief)php-briefPL/SQLplsql
PythonphytonQ(uick)BASICqbasicrobots.txtrobots
Ruby on RailsrailsRubyrubySASsas
SchemeschemesdlBasicsdlbasicSmartysmarty
SQLsqlTCL/iTCLtclT-SQLtsql
TexttextthinBasicthinbasicUnoidlidl
VB.NETvbnetVHDLvhdlVisual BASICvb
Visual Fox ProvisualfoxproWinBatchwinbatchXMLxml
X++xppZiLOG Z80 Assemblerz80


13. Mindmaps


Wikka has native support for 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:


14. Embedded HTML


You can easily paste HTML in a wiki page by wrapping it into two sets of doublequotes.

[html code]
 

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.


-Wiki
There are 2 comments on this page. [Show comments]