Revision history for FormattingRules


Revision [2469]

Last edited on 2019-09-02 18:16:32 by WikkaInstaller [Upgrading from 1.1.7-docs to master]
Additions:
======Wikka Formatting Guide======---<<===General Guidelines===If a markup sequence is not in these guidelines, then it is not officially supported. Use caution when implementing markup that is not officially supported by this document, as undocumented functionality may change with version updates.--- ---Unless otherwise stated in these guidelines, all markup is line based, that is, a newline character should not intervene. These are identified as 'inline' markup.<<::c::---===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.---<<
~##""""WikiWord"" is not parsed as a link""##
~""WikiWord"" is not parsed as a link
<<::c::===1. Text Formatting===---<<
~**I'm bold**
<<::c::<<
<<::c::<<
~##""__And I'm underlined!__""##
~__And I'm underlined!__
<<::c::<<
~##""##Monospace text##""##
~##Monospace text##
<<::c::<<
~##""''Highlighted text''""## (using 2 single quotes)
~''Highlighted text''
<<::c::<<
<<::c::<<
~##""££Text insertion££""##
~ ££Text insertion££
<<::c::<<
~##""¥¥Text deletion¥¥""##
~ ¥¥Text deletion¥¥
<<::c::<<
~##""#%Press any key#%""##
~#%Press any key#%
<<::c::<<
<<::c::Elides (hides) content from displaying. Eliminates trailing whitespace so there are no unsightly gaps in output. Useful for commenting Wikka markup.---<<
~##""/*Elided content (eliminates trailing whitespace)*/""##
~/*Elided content (eliminates trailing whitespace)*/
<--//there was a comment here followed by whitespace in the markup//
<<::c::Elides (hides) content from displaying. Preserves trailing
whitespace (note the gap).---<<
~##""``Elided content (preserves trailing whitespace)``""##
~``Elided content (preserves trailing whitespace)``
<--//there was a comment here followed by ws in the markup//
<<::c::---===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.--- ---<<
~##""======Really big header======""##
~======Really big header======
<<::c::<<
~##""=====Rather big header=====""##
~=====Rather big header=====
<<::c::<<
~##""====Medium header====""##
~====Medium header====
<<::c::<<
~##""===Not-so-big header===""##
~===Not-so-big header===
<<::c::<<
~##""==Smallish header==""##
~==Smallish header==
<<::c::---===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).---<<
##""~This text is indented<br />~~This text is double-indented<br />    This text is also indented""## <<::c::<<
~This text is also indented
<<::c::---To create bulleted/ordered lists, use the following markup (you can always use 4 spaces instead of a tilde):--- ---**Bulleted lists**---<<
<<::c::<<
~- Line one
~- Line two
<<::c::---**Numbered lists**---<<
<<::c::<<
~1) Line one
~1) Line two
<<::c::---**Ordered lists using uppercase characters**---<<
<<::c::<<
~A) Line one
~A) Line two
<<::c::---**Ordered lists using lowercase characters**---<<
<<::c::<<
~a) Line one
~a) Line two
<<::c::---**Ordered lists using uppercase Roman numerals**---<<
<<::c::<<
~I) Line one
~I) Line two
<<::c::---**Ordered lists using lowercase Roman numerals**---<<
<<::c::<<
~i) Line one
~i) Line two
<<::c::---===6. Inline comments===---To format some text as an inline comment, use an indent (tilde, tab, or four spaces) followed by a **""&""**.--- ---<<
<<::c::<<
~& Comment
~~& Subcomment
~~~& Subsubcomment
<<::c::--- ---===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.--- ---<<
~##""{{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"}}
<<::c::---===8. Links===---To create a ** link to a wiki page ** you can use any of the
following options:--- ---
~- Type a ##""WikiName""## (works only for page names with no whitespace): --- --- ##""FormattingRules""## --- FormattingRules --- ---
~- Add a forced link surrounding the page name by ##""[[ target URL or page | description ]]""## (everything after the | will be shown as description): --- --- ##""[[SandBox | | Test
your formatting skills]]""## --- [[SandBox | | Test your formatting skills]] --- --- ##""[[SandBox | | 沙箱]]""## --- [[SandBox | | 沙箱]] --- --- ##""[[http://docs.wikkawiki.org | | Wikka documentation]]""## --- [[http://docs.wikkawiki.org | | Wikka documentation]] --- --- ##""[[community@wikkawiki.org | | Wikka community list]]""## --- [[community@wikkawiki.org | | Wikka community list]] --- ------
~- Add an image with a link (see instructions above)
--- ---To ** link to external pages **, you can do any of the following:--- ---
~- Type a URL inside the page: --- --- ##""http://blog.wikkawiki.org""## --- http://blog.wikkawiki.org --- ---
~- Add an image with a link (see instructions above)
~- Add an interwiki link ([[InterWiki | | browse the list of available interwiki tags]]): --- --- ##""WikiPedia:WikkaWiki""## --- WikiPedia:WikkaWiki --- --- ##""Google:CSS""## --- Google:CSS --- --- ##""Thesaurus:Happy""## --- Thesaurus:Happy --- ---
--- ---===9. Tables===---<<The ##table## action has been deprecated as of Wikka version 1.2 and has been replaced with the syntax that follows. Please visit the [[Docs:TableActionInfo|Wikka | documentation server]] for information about the older ##table## action.<<::c::---Tables can be created using two pipe (##""||""##) symbols. Everything in a single line is rendered as a table row.--- ---**Example:**--- ---
--- ---Header cells can be rendered by placing an equals sign between the pipes.--- ---**Example:**
--- ---Row and column spans are specified with ##x:## and ##y:## in parentheses just after the pipes.--- ---**Example:**--- ---
--- ---Many additional features are available using table markup. A
more comprehensive table markup guide is available on this server's
TableMarkup page. A complete syntax reference is available on the document
server [[Docs:TableMarkupReference | TableMarkupReference]] page.--- ---===10. Colored Text===---Colored text can be created using the ##color## action:---<<
~##""{{color c="blue" text="This is a test"}}""##
~{{color c="blue" text="This is a test"}}
<<::c::---You can also use hex values:---<<
~##""{{color hex="#DD0000" text="This is another test"}}""##
~{{color hex="#DD0000" text="This is another test"}}
<<::c::---Alternatively, you can specify a foreground and background color using the ##fg## and ##bg## parameters (they accept both named and hex values):---<<
<<::c::<<
<<::c::--- ---===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::
** 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:--- ---
---To create a ** code block with syntax highlighting **, you need to specify a // code formatter // (see below for a list of available code formatters).--- ---
--- ---You can also specify an optional // starting line // number.---
--- ---If you specify a // filename //, this will be used for downloading the code.---
--- ---
|?|List of available code formatters||
||
|=|Language|=|Formatter|=|Language|=|Formatter|=|Language|=|Formatter||
|#|
|=|Actionscript||##actionscript##|=|ABAP||##abap##|=|ADA||##ada##||
|=|Apache Log||##apache##|=|""AppleScript""||##applescript##|=|ASM||##asm##||
|=|ASP||##asp##|=|""AutoIT""||##autoit##|=|Bash||##bash##||
|=|""BlitzBasic""||##blitzbasic##|=|""Basic4GL""||##basic4gl##|=|bnf||##bnf##||
|=|C||##c##|=|C for Macs||##c_mac##|=|C#||##csharp##||
|=|C""++""||##cpp##|=|C""++"" (+QT)||##cpp-qt##|=|CAD DCL||##caddcl##||
|=|""CadLisp""||##cadlisp##|=|CFDG||##cfdg##|=|""ColdFusion""||##cfm##||
|=|CSS||##css##|=|D||##d##|=|Delphi||##delphi##||
|=|Diff-Output||##diff##|=|DIV||##div##|=|DOS||##dos##||
|=|Dot||##dot##|=|Eiffel||##eiffel##|=|Fortran||##fortran##||
|=|""FreeBasic""||##freebasic##|=|FOURJ's Genero 4GL||##genero##|=|GML||##gml##||
|=|Groovy||##groovy##|=|Haskell||##haskell##|=|HTML||##html4strict##||
|=|INI||##ini##|=|Inno Script||##inno##|=|Io||##io##||
|=|Java 5||##java5##|=|Java||##java##|=|Javascript||##javascript##||
|=|""LaTeX""||##latex##|=|Lisp||##lisp##|=|Lua||##lua##||
|=|Matlab||##matlab##|=|mIRC Scripting||##mirc##|=|Microchip Assembler||##mpasm##||
|=|Microsoft Registry||##reg##|=|Motorola 68k Assembler||##m68k##|=|""MySQL""||##mysql##||
|=|NSIS||##nsis##|=|Objective C||##objc##|=|""OpenOffice"" BASIC||##oobas##||
|=|Objective Caml||##ocaml##|=|Objective Caml (brief)||##ocaml-brief##|=|Oracle 8||##oracle8##||
|=|Pascal||##pascal##|=|Per (FOURJ's Genero 4GL)||##per##|=|Perl||##perl##||
|=|PHP||##php##|=|PHP (brief)||##php-brief##|=|PL/SQL||##plsql##||
|=|Python||##phyton##|=|Q(uick)BASIC||##qbasic##|=|robots.txt||##robots##||
|=|Ruby on Rails||##rails##|=|Ruby||##ruby##|=|SAS||##sas##||
|=|Scheme||##scheme##|=|sdlBasic||##sdlbasic##|=|Smarty||##smarty##||
|=|SQL||##sql##|=|TCL/iTCL||##tcl##|=|T-SQL||##tsql##||
|=|Text||##text##|=|thinBasic||##thinbasic##|=|Unoidl||##idl##||
|=|VB.NET||##vbnet##|=|VHDL||##vhdl##|=|Visual BASIC||##vb##||
|=|Visual Fox Pro||##visualfoxpro##|=|""WinBatch""||##winbatch##|=|XML||##xml##||
|=|X""++""||##xpp##|=|""ZiLOG"" Z80 Assembler||##z80##|=| ||
--- ---===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.
::c::
---===14. Embedded HTML===---You can easily paste HTML in a wiki page by wrapping it into two sets of doublequotes.--- ---
<<
<<::c::<<
<<::c::---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
Deletions:
======Wikka Formatting Guide======
<<===General Guidelines===
If a markup sequence is not in these guidelines, then it is not officially supported. Use caution when implementing markup that is not officially supported by this document, as undocumented functionality may change with version updates.
Unless otherwise stated in these guidelines, all markup is line based, that is, a newline character should not intervene. These are identified as 'inline' markup.
<<::c::
===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.
~##""This ""WikiWord"" is not parsed as a link""##
~This ""WikiWord"" is not parsed as a link
===1. Text Formatting===
All this section is inline.
~**I'm bold **
~##""And I'm __underlined__!""##
~And I'm __underlined__!
~##""##monospace text##""##
~##monospace text##
~##""''highlight text''""## (using 2 single-quotes)
~''highlight text''
~##""Press #%ANY KEY#%""##
~Press #%ANY KEY#%
===2. Headers===
All this section is inline.
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===
~##""---""##
===5. Lists and indents===
These items are block based, each entry (list item) being an inline
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""##
This text is also 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
**Numbered lists**
1) Line one
1) Line two
**Ordered lists using uppercase characters**
A) Line one
A) Line two
**Ordered lists using lowercase characters**
a) Line one
a) Line two
**Ordered lists using roman numerals**
I) Line one
I) Line two
**Ordered lists using lowercase roman numerals**
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
===7. Images===
Images may be used inline or at paragraph(block) level. The markup must be inline
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"}}
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.
===8. Links===
{{since version="1.3" display="inline"}}
<<The CamelCase requirement for Wikka page names has been deprecated as of Wikka version [[WhatsNew13 1.3]]. Consequently, since whitespace is now allowed in page names, all forced links must use the | separator between the link and the description. Legacy forced links that uses whitespace as a separator should continue to work, but backwards compatibility with such links in future versions is not guaranteed.<<::c::
All links are inline.
To create a **link to a wiki page** you can use any of the following options: ---
~1) type a ##""WikiName""## (works only for page names with no whitespace): --- --- ##""FormattingRules""## --- FormattingRules --- ---
~1) add a forced link surrounding the page name by ##""[[""## | and ##""]]""## (everything after the | 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://blog.wikkawiki.org""## --- http://blog.wikkawiki.org --- ---
~1) add a forced link surrounding the URL by ##""[[""## | and ##""]]""## (everything after the | will be shown as description): --- --- ##""[[http://docs.wikkawiki.org|Wikka | documentation]]""## --- [[http://docs.wikkawiki.org|Wikka | documentation]] --- --- ##""[[community@wikkawiki.org|Wikka | community list]]""## --- [[community@wikkawiki.org|Wikka | community list]] --- ---
~1) add an image with a link (see instructions above);
~1) add an interwiki link (browse the [[InterWiki | list of available interwiki tags]]): --- --- ##""WikiPedia:WikkaWiki""## --- WikiPedia:WikkaWiki --- --- ##""Google:CSS""## --- Google:CSS --- --- ##""Thesaurus:Happy""## --- Thesaurus:Happy --- ---
===9. Tables===
The table is at the block level, each row being inline.
{{since version="1.2" display="inline"}}
<<The ##""{{table}}""## action has been deprecated as of Wikka version [[WhatsNew12 | 1.2]] and has been replaced with the syntax that follows. Please visit the [[TableActionInfo | legacy documentation page]] for information about the older ##table## action.<<::c:: Tables can be created using two pipe (##""||""##) symbols. Everything in a single line is rendered as a table row.
**Example:**
Header cells can be rendered by placing an equals sign between the pipes.
**Example:**
Row and column spans are specified with ##x:## and ##y:## in parentheses just after the pipes.
**Example:**
Many additional features are available using table markup. A more comprehensive table markup guide is available on this server's TableMarkup page. A complete syntax reference is available on this server's TableMarkupReference page.
===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."}}
Alternatively, you can specify a foreground and background color using the ##fg## and ##bg## parameters (they accept both named and hex values):
**Examples:**
===11. Floats===
These are inline along with any accompanying text.
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===
These are at the block level and may contain newlines. All white space within the block is respected. No further markup is acted upon within the block, but see syntax highlighting below.
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:
To create a **code block with syntax highlighting**, you need to specify a //code formatter// (see below for a list of available code formatters).
You can also specify an optional //starting line// number.
If you specify a //filename//, this will be used for downloading the code.
**List of available code formatters:**
{{table columns="6" cellpadding="1" cells="LANGUAGE;FORMATTER;LANGUAGE;FORMATTER;LANGUAGE;FORMATTER;ABAP;abap;Actionscript;actionscript;ADA;ada;Apache Log;apache;AppleScript; applescript;ASM;asm;ASP;asp;AutoIT;autoit;Axapta/Dynamics Ax X++;xpp;Bash;bash;BlitzBasic;blitzbasic;BNF;bnf;C;c;C for Macs;c_mac;c#;csharp;C++;cpp;C++ (QT extensions);cpp-qt;CAD DCL;caddcl;CadLisp;cadlisp;CFDG;cfdg;ColdFusion;cfm; CSS;css;D;d;Delphi;delphi;Diff-Output;diff;DIV; div;DOS;dos;dot;dot;Eiffel;eiffel;Fortran;fortran;FOURJ's Genero 4GL;genero;FreeBasic;freebasic;GML;gml;Groovy;groovy;Haskell;haskell;HTML;html4strict;INI;ini;IO;io;Inno Script;inno;Java 5;java5;Java;java;Javascript;javascript;LaTeX;latex;Lisp;lisp;Lua;lua;Matlab;matlab;Microchip Assembler;mpasm;Microsoft Registry;reg;mIRC;mirc;Motorola 68000 Assembler;m68k;MySQL;mysql;NSIS;nsis;Objective C;objc;OpenOffice BASIC;oobas;Objective Caml;ocaml;Objective Caml (brief);ocaml-brief;Oracle 8;oracle8;Pascal;pascal;Per (forms);per;Perl;perl;PHP;php;PHP (brief);php-brief;PL/SQL;plsql;Python;phyton;Q(uick)BASIC;qbasic;robots.txt;robots;Ruby;ruby;Ruby on Rails;rails;SAS;sas;Scheme;scheme;sdlBasic;sdlbasic;SmallTalk;smalltalk;Smarty;smarty;SQL;sql;TCL/iTCL;tcl;T-SQL;tsql;Text;text;thinBasic;thinbasic;Unoidl;idl;VB.NET;vbnet;VHDL;vhdl;Visual BASIC;vb;Visual Fox Pro;visualfoxpro;WinBatch;winbatch;XML;xml;ZiLOG Z80;z80;###"}}
===13. Mindmaps===
Wikka has native support for [[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.
**Examples:**
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 UsingHTML for more information.
===15. Converting HTML to Wiki===
Visit http://diberri.dyndns.org/html2wiki.html
It allows you to paste HTML into a textbox and it will then convert it to Wikka Wiki markup (as well as a bunch of other Wiki dialects)
CategoryEN


Revision [2177]

Edited on 2010-07-11 05:51:41 by DarTar [version tag]
Additions:
{{since version="1.2" display="inline"}}
<<The ##""{{table}}""## action has been deprecated as of Wikka version [[WhatsNew12 | 1.2]] and has been replaced with the syntax that follows. Please visit the [[TableActionInfo | legacy documentation page]] for information about the older ##table## action.<<::c:: Tables can be created using two pipe (##""||""##) symbols. Everything in a single line is rendered as a table row.
Deletions:
<<The ##""{{table}}""## action has been deprecated as of Wikka version [[WhatsNew12 | 1.2]] and has been replaced with the syntax that follows. Please visit the [[TableActionInfo | legacy documentation page]] for information about the older ##table## action.<<::c::
Tables can be created using two pipe (##""||""##) symbols. Everything in a single line is rendered as a table row.


Revision [2168]

Edited on 2010-07-06 20:21:08 by BrianKoontz [Added since 1.3 tag]
Additions:
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.
{{since version="1.3" display="inline"}}
<<The CamelCase requirement for Wikka page names has been deprecated as of Wikka version [[WhatsNew13 1.3]]. Consequently, since whitespace is now allowed in page names, all forced links must use the | separator between the link and the description. Legacy forced links that uses whitespace as a separator should continue to work, but backwards compatibility with such links in future versions is not guaranteed.<<::c::
Deletions:
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.
<<The CamelCase requirement for Wikka page names has been deprecated as of Wikka version [[WhatsNew13 | 1.3]]. Consequently, since whitespace is now allowed in page names, all forced links must use the | separator between the link and the description. Legacy forced links that uses whitespace as a separator should continue to work, but backwards compatibility with such links in future versions is not guaranteed.<<::c::


Revision [2166]

Edited on 2010-07-06 20:12:34 by BrianKoontz [Modified links section to conform to new page naming convention in 1.3]
Additions:
<<The CamelCase requirement for Wikka page names has been deprecated as of Wikka version [[WhatsNew13 | 1.3]]. Consequently, since whitespace is now allowed in page names, all forced links must use the | separator between the link and the description. Legacy forced links that uses whitespace as a separator should continue to work, but backwards compatibility with such links in future versions is not guaranteed.<<::c::
~1) type a ##""WikiName""## (works only for page names with no whitespace): --- --- ##""FormattingRules""## --- FormattingRules --- ---
~1) add a forced link surrounding the page name by ##""[[""## | and ##""]]""## (everything after the | will be shown as description): --- --- ##""[[SandBox|Test | your formatting skills]]""## --- [[SandBox|Test | your formatting skills]] --- --- ##""[[SandBox|沙箱]]""## | --- [[SandBox|沙箱]] --- ---
~1) type a URL inside the page: --- --- ##""http://blog.wikkawiki.org""## --- http://blog.wikkawiki.org --- ---
~1) add a forced link surrounding the URL by ##""[[""## | and ##""]]""## (everything after the | will be shown as description): --- --- ##""[[http://docs.wikkawiki.org|Wikka | documentation]]""## --- [[http://docs.wikkawiki.org|Wikka | documentation]] --- --- ##""[[community@wikkawiki.org|Wikka | community list]]""## --- [[community@wikkawiki.org|Wikka | community list]] --- ---
Deletions:
~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) 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]] --- --- ##""[[mail@example.com | Write me!]]""## --- [[mail@example.com | Write me!]] --- ---


Revision [2141]

Edited on 2009-09-12 02:13:48 by DarTar [further cleanup]
Additions:
<<===General Guidelines===
Deletions:
<<==General Guidelines==


Revision [2140]

Edited on 2009-09-12 02:11:43 by DarTar [further cleanup]
Additions:
<<==General Guidelines==
If a markup sequence is not in these guidelines, then it is not officially supported. Use caution when implementing markup that is not officially supported by this document, as undocumented functionality may change with version updates.
Unless otherwise stated in these guidelines, all markup is line based, that is, a newline character should not intervene. These are identified as 'inline' markup.
<<::c::
===Escaping Markup===
Anything between 2 sets of double-quotes is not formatted. This is the equivalent of escaping a character(s):
~##""**two bold &#34&#34**&#34&#34 stars**""##
~**two bold ""**"" stars**
You can also use double-quote escaping to avoid linking of CamelCase words, e.g.
~##""This ""WikiWord"" is not parsed as a link""##
~This ""WikiWord"" is not parsed as a link
Deletions:
**General Guidelines**. If a markup sequence is not in these guidelines, then it
is not officially supported. If you find something that works
that contradicts these guidelines, let us know via the mailing
list. Use caution when implementing markup that is not officially supported by this document,
as undocumented functionality may change with version updates.
Unless otherwise stated in these guidelines, all markup is line based,
that is, a newline character should not intervene. These are
identified as 'inline' markup
<<**Note:** Anything between 2 sets of double-quotes is not formatted.<<::c::
This is the equivalent of escaping a character(s):
~##""**bold&#34&#34**&#34&#34stars**""##
~**bold""**"" stars**


Revision [2139]

Edited on 2009-09-11 18:20:57 by BrianKoontz [minor cleanup]
Additions:
list. Use caution when implementing markup that is not officially supported by this document,
as undocumented functionality may change with version updates.
This is the equivalent of escaping a character(s):
~##""**bold&#34&#34**&#34&#34stars**""##
~**bold""**"" stars**
In this case, the second set of ""**"" (escaped) stars will be ignored, //i.e.,// will not terminate the bold markup.
Deletions:
list; but don't use it! It may change with a new version
This is the equivalent of escaping a character(s). E.g. **bold ""**""
stars** , the two stars will be ignored, i.e. will not terminate the bold markup.


Revision [2131]

Edited on 2009-09-11 08:47:26 by DavePawson [Dave Pawson. No change to syntax, Clarifications only]
Additions:
**General Guidelines**. If a markup sequence is not in these guidelines, then it
is not officially supported. If you find something that works
that contradicts these guidelines, let us know via the mailing
list; but don't use it! It may change with a new version
Unless otherwise stated in these guidelines, all markup is line based,
that is, a newline character should not intervene. These are
identified as 'inline' markup
This is the equivalent of escaping a character(s). E.g. **bold ""**""
stars** , the two stars will be ignored, i.e. will not terminate the bold markup.
All this section is inline.
All this section is inline.
These items are block based, each entry (list item) being an inline
Images may be used inline or at paragraph(block) level. The markup must be inline
All links are inline.
The table is at the block level, each row being inline.
These are inline along with any accompanying text.
These are at the block level and may contain newlines. All white space within the block is respected. No further markup is acted upon within the block, but see syntax highlighting below.


Revision [2112]

Edited on 2009-09-03 03:52:44 by DarTar [tables]
Additions:
<<The ##""{{table}}""## action has been deprecated as of Wikka version [[WhatsNew12 | 1.2]] and has been replaced with the syntax that follows. Please visit the [[TableActionInfo | legacy documentation page]] for information about the older ##table## action.<<::c::
Deletions:
<<The ##table## action has been deprecated as of Wikka version 1.2 and has been replaced with the syntax that follows. Please visit the [[TableActionInfo | Wikka legacy documentation page]] for information about the older ##table## action.<<::c::


Revision [2111]

Edited on 2009-09-03 03:51:46 by DarTar [tables]
Additions:
<<The ##table## action has been deprecated as of Wikka version 1.2 and has been replaced with the syntax that follows. Please visit the [[TableActionInfo | Wikka legacy documentation page]] for information about the older ##table## action.<<::c::
Deletions:
<<The ##table## action has been deprecated as of Wikka version 1.2 and has been replaced with the syntax that follows. Please visit the [[Docs:TableActionInfo | Wikka documentation server]] for information about the older ##table## action.<<::c::


Revision [2110]

Edited on 2009-09-03 03:50:45 by DarTar [tables]
Additions:
===9. Tables===
Deletions:
==9. Tables===


Revision [2109]

Edited on 2009-09-03 03:50:04 by DarTar [tables]
Additions:
==9. Tables===
<<The ##table## action has been deprecated as of Wikka version 1.2 and has been replaced with the syntax that follows. Please visit the [[Docs:TableActionInfo | Wikka documentation server]] for information about the older ##table## action.<<::c::
Tables can be created using two pipe (##""||""##) symbols. Everything in a single line is rendered as a table row.
##""||Cell 1||Cell 2||""##
||Cell 1||Cell 2||
Header cells can be rendered by placing an equals sign between the pipes.
##""|=|Header 1|=|Header 2||""##
##""||Cell 1||Cell 2||""##
|=|Header 1|=|Header 2||
||Cell 1||Cell 2||
Row and column spans are specified with ##x:## and ##y:## in parentheses just after the pipes.
##""|=| |=|(x:2)Columns||""##
##""|=|(y:2) Rows||Cell 1||Cell 2||""##
##""||Cell 3||Cell 4||""##
|=| |=|(x:2)Columns||
|=|(y:2) Rows||Cell 1||Cell 2||
||Cell 3||Cell 4||
Many additional features are available using table markup. A more comprehensive table markup guide is available on this server's TableMarkup page. A complete syntax reference is available on this server's TableMarkupReference page.
Deletions:
===9. Tables===
To create a table, you can use the ##table## action.
~##""{{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).


Revision [842]

Edited on 2008-02-21 19:58:28 by DarTar [removing SandBox link]
Deletions:
Once you have read through this, test your formatting skills in the SandBox.


Revision [841]

Edited on 2008-02-21 19:57:04 by DarTar [using 1.1.6.4 page]
Additions:
======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===
~##""---""##
---
===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""##
~This text is indented
~~This text is double-indented
This text is also 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 one
**Numbered lists**
##""~1) Line one""##
##""~1) Line two""##
1) Line one
**Ordered lists using uppercase characters**
##""~A) Line one""##
##""~A) Line two""##
A) Line one
**Ordered lists using lowercase characters**
##""~a) Line one""##
##""~a) Line two""##
a) Line one
**Ordered lists using roman numerals**
##""~I) Line one""##
##""~I) Line two""##
I) Line one
**Ordered lists using lowercase roman numerals**
##""~i) Line one""##
##""~i) Line two""##
i) Line one
To format some text as an inline comment, use an indent ( **~**, a **tab** or **4 spaces**) followed by a **""&""**.
**Example:**
##""~& 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]] --- --- ##""[[mail@example.com | Write me!]]""## --- [[mail@example.com | Write me!]] --- ---
~1) add an image with a link (see instructions above);
~1) add an interwiki link (browse the [[InterWiki | list of available interwiki tags]]): --- --- ##""WikiPedia:WikkaWiki""## --- WikiPedia:WikkaWiki --- --- ##""Google:CSS""## --- Google:CSS --- --- ##""Thesaurus:Happy""## --- Thesaurus:Happy --- ---
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).
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."}}
Alternatively, you can specify a foreground and background color using the ##fg## and ##bg## parameters (they accept both named and hex values):
**Examples:**
~##""{{color fg="#FF0000" bg="#000000" text="This is colored text on colored background"}}""##
~{{color fg="#FF0000" bg="#000000" text="This is colored text on colored background"}}
~##""{{color fg="yellow" bg="black" text="This is colored text on colored background"}}""##
~{{color fg="yellow" bg="black" text="This is colored text on colored background"}}
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.
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).
~##""%%(""{{color c="red" text="php"}}"")<br /><?php<br />echo "Hello, World!";<br />?><br />%%""##
%%(php)
<?php
echo "Hello, World!";
?>
%%
You can also specify an optional //starting line// number.
~##""%%(php;""{{color c="red" text="15"}}"")<br /><?php<br />echo "Hello, World!";<br />?><br />%%""##
%%(php;15)
<?php
echo "Hello, World!";
?>
%%
If you specify a //filename//, this will be used for downloading the code.
~##""%%(php;15;""{{color c="red" text="test.php"}}"")<br /><?php<br />echo "Hello, World!";<br />?><br />%%""##
%%(php;15;test.php)
<?php
echo "Hello, World!";
?>
%%
**List of available code formatters:**
{{table columns="6" cellpadding="1" cells="LANGUAGE;FORMATTER;LANGUAGE;FORMATTER;LANGUAGE;FORMATTER;ABAP;abap;Actionscript;actionscript;ADA;ada;Apache Log;apache;AppleScript; applescript;ASM;asm;ASP;asp;AutoIT;autoit;Axapta/Dynamics Ax X++;xpp;Bash;bash;BlitzBasic;blitzbasic;BNF;bnf;C;c;C for Macs;c_mac;c#;csharp;C++;cpp;C++ (QT extensions);cpp-qt;CAD DCL;caddcl;CadLisp;cadlisp;CFDG;cfdg;ColdFusion;cfm; CSS;css;D;d;Delphi;delphi;Diff-Output;diff;DIV; div;DOS;dos;dot;dot;Eiffel;eiffel;Fortran;fortran;FOURJ's Genero 4GL;genero;FreeBasic;freebasic;GML;gml;Groovy;groovy;Haskell;haskell;HTML;html4strict;INI;ini;IO;io;Inno Script;inno;Java 5;java5;Java;java;Javascript;javascript;LaTeX;latex;Lisp;lisp;Lua;lua;Matlab;matlab;Microchip Assembler;mpasm;Microsoft Registry;reg;mIRC;mirc;Motorola 68000 Assembler;m68k;MySQL;mysql;NSIS;nsis;Objective C;objc;OpenOffice BASIC;oobas;Objective Caml;ocaml;Objective Caml (brief);ocaml-brief;Oracle 8;oracle8;Pascal;pascal;Per (forms);per;Perl;perl;PHP;php;PHP (brief);php-brief;PL/SQL;plsql;Python;phyton;Q(uick)BASIC;qbasic;robots.txt;robots;Ruby;ruby;Ruby on Rails;rails;SAS;sas;Scheme;scheme;sdlBasic;sdlbasic;SmallTalk;smalltalk;Smarty;smarty;SQL;sql;TCL/iTCL;tcl;T-SQL;tsql;Text;text;thinBasic;thinbasic;Unoidl;idl;VB.NET;vbnet;VHDL;vhdl;Visual BASIC;vb;Visual Fox Pro;visualfoxpro;WinBatch;winbatch;XML;xml;ZiLOG Z80;z80;###"}}
===13. Mindmaps===
Wikka has native support for [[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.
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 UsingHTML for more information.
CategoryEN
Deletions:
[[WikkaDocumentation | Wikka Documentation]]
======The Wiki Formatting Guide======
<<This is the Wikka formatting guide for version ##1.1.6.0-dev## running this server. For an updated list of formatting rules available in the latest stable release (##**[[WhatsNew | 1.1.6.2]]**##), please refer to [[http://demo.wikkawiki.org/FormattingRules | this page]].<<::c::
===1. Text formatting===
''Note: Anything between 2 sets of double-quotes is not formatted.''
""**bold**""
**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 six = (for the biggest header) and two = (for the smallest header) on both sides of a text.
""====== 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:===
""---""
text before---and after a break
===5. Lists / Indents:===
Indent text using **4** spaces (which will auto-convert into tabs) or using "~". To make bulleted / ordered lists, use the following codes (you can use 4 spaces instead of "~"):
""~- bulleted list:""
- bulleted list
""~1) numbered list:""
1) numbered list
""~A) Using uppercase characters:""
A) Using uppercase characters
""~a) Using lowercase characters:""
a) Using lowercase characters
""~I) using uppercase roman numerals:""
I) using Latin numbers
""~i) using lowercase roman numerals:""
i) using Latin numbers
""~& Comment""
""~~& Subcomment""
""~~~& Subsubcomment""
===7. Images:===
To place images on a Wiki page, use:
""{{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 have to enter a link at all, and in that case just an image will be inserted. You can also use the classes 'left' and 'right' to float images left and right. You don't need to use all those attributes, only url is essential.
===8. [[AddingLinks | Links]]===
To link to other wiki-pages, write
- a WikiName
- or a forced link with ""[["" | and ""]]"" around it (everything after the first space will be shown as description)
- or an image with a link
To link to external pages, write
- a http-address inside the page, eg www.google.com
- or a forced link with ""[["" | and ""]]"" around it (everything after the first space will be shown as description)
- or an image with a link
- or an InterWiki-link (see page for wiki-list)
To open a web page, use <A href=http://google.com>Google</A> ""<A href=http://google.com>Google</A>""
To open a web page in a new copy of your browser, use <A href=&quothttp://google.com&quot TARGET="_blank">Google</A> ""<A href="http://google.com" TARGET="blank">Google</A>""
**These next 2 lines will not work on this Wiki because the refered docs do not exist. This is ok; they are merely an example of //how// to do it**
To embed a reference to a document stored on a web server, use ''<A href="../dirname/demo.doc">Click Here</A>'' ""<A href="../dirname/demo.doc">Click Here</A>""
To embed a reference to a document stored on a web server (and see it in a new browser window), use ''<A href="../dirname/demo.doc" TARGET="_blank">Click Here</A>'' ""<A href="../dirname/demo.doc" TARGET="_blank">Click Here</A>""
To create a table use this code:
""{{table columns="3" cellpadding="1" cells="BIG;GREEN;FROGS;yes;yes;no;no;no;###"}}"" to give:
{{table columns="3" cellpadding="1" cells="BIG;GREEN;FROGS;yes;yes;no;no;no;###"}}
""###"" means the cell is empty.
""{{color c="blue" text="This is a test."}}"" gives:
{{color c="blue" text="This is a test."}}
If you want to use hex values:
""{{color hex="#DD0000" text="This is another test."}}"" to give:
{{color hex="#DD0000" text="This is another test."}}

**Left floated box - use two < signs before and after the block**
<<Some text in a 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. This filler text is higher than the box so the next section starts on a new line below the box automatically.
**Right floated box, use two > characters before and after the block**
>>Some text in a floated box hanging around. And a little more to create a larger box. If the text in the box gets higher than the surrounding text, you'll need the "clearer" (see ""::c::"") to get new text to start on a new line //below// the box instead of next to the floated box. >>Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler.
""Use ::c:: to clear floated blocks... as done just below""
::c::
Simply use ""%%(formatter[;#number]) code %%"" - for the formatters, see the list below. If you add a number and it is enabled in the config, you will have line numbers starting at #number.
{{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;html;Java;java;Javascript;javascript;Lisp;lisp;Lua;lua;NSIS;nsis;Objective C;objc;OpenOffice BASIC;oobas;Pascal;pascal;Perl;perl;PHP;php;Python;python;Q(uick)BASIC;qbasic;Smarty;smarty;SQL;sql;VB.NET;vbnet;Visual BASIC;vb;Visual Fox Pro;visualfoxpro;XML;xml"}}
With the same syntax you can also use Wikka's built-in formatters: //email//, //ini// and //code//. If you haven't installed GeSHi //php// will be formatted by Wikka's built-in formatter, too.
Take a look at SyntaxHighlighter to see some examples.
===13. FreeMind maps===
See the FreeMind page on how to include FreeMind-maps
Use two doublequotes around the html-tags. Note the limitations on UsingHTML.
CategoryDocumentation


Revision [189]

Edited on 2006-08-04 06:11:01 by DarTar [minor]
Additions:
[[WikkaDocumentation | Wikka Documentation]]
======The Wiki Formatting Guide======
<<This is the Wikka formatting guide for version ##1.1.6.0-dev## running this server. For an updated list of formatting rules available in the latest stable release (##**[[WhatsNew | 1.1.6.2]]**##), please refer to [[http://demo.wikkawiki.org/FormattingRules | this page]].<<::c::
===1. Text formatting===
''Note: Anything between 2 sets of double-quotes is not formatted.''
""**bold**""
**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 six = (for the biggest header) and two = (for the smallest header) on both sides of a text.
""====== 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:===
""---""
text before---and after a break
===5. Lists / Indents:===
Indent text using **4** spaces (which will auto-convert into tabs) or using "~". To make bulleted / ordered lists, use the following codes (you can use 4 spaces instead of "~"):
""~- bulleted list:""
- bulleted list
- Line two
""~1) numbered list:""
1) numbered list
1) Line two
""~A) Using uppercase characters:""
A) Using uppercase characters
A) Line two
""~a) Using lowercase characters:""
a) Using lowercase characters
a) Line two
""~I) using uppercase roman numerals:""
I) using Latin numbers
I) Line two
""~i) using lowercase roman numerals:""
i) using Latin numbers
i) Line two
""~& Comment""
""~~& Subcomment""
""~~~& Subsubcomment""
===7. Images:===
To place images on a Wiki page, use:
""{{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 have to enter a link at all, and in that case just an image will be inserted. You can also use the classes 'left' and 'right' to float images left and right. You don't need to use all those attributes, only url is essential.
===8. [[AddingLinks | Links]]===
To link to other wiki-pages, write
- a WikiName
- or a forced link with ""[["" | and ""]]"" around it (everything after the first space will be shown as description)
- or an image with a link
To link to external pages, write
- a http-address inside the page, eg www.google.com
- or a forced link with ""[["" | and ""]]"" around it (everything after the first space will be shown as description)
- or an image with a link
- or an InterWiki-link (see page for wiki-list)
To open a web page, use <A href=http://google.com>Google</A> ""<A href=http://google.com>Google</A>""
To open a web page in a new copy of your browser, use <A href=&quothttp://google.com&quot TARGET="_blank">Google</A> ""<A href="http://google.com" TARGET="blank">Google</A>""
**These next 2 lines will not work on this Wiki because the refered docs do not exist. This is ok; they are merely an example of //how// to do it**
To embed a reference to a document stored on a web server, use ''<A href="../dirname/demo.doc">Click Here</A>'' ""<A href="../dirname/demo.doc">Click Here</A>""
To embed a reference to a document stored on a web server (and see it in a new browser window), use ''<A href="../dirname/demo.doc" TARGET="_blank">Click Here</A>'' ""<A href="../dirname/demo.doc" TARGET="_blank">Click Here</A>""
To create a table use this code:
""{{table columns="3" cellpadding="1" cells="BIG;GREEN;FROGS;yes;yes;no;no;no;###"}}"" to give:
{{table columns="3" cellpadding="1" cells="BIG;GREEN;FROGS;yes;yes;no;no;no;###"}}
""###"" means the cell is empty.
""{{color c="blue" text="This is a test."}}"" gives:
{{color c="blue" text="This is a test."}}
If you want to use hex values:
""{{color hex="#DD0000" text="This is another test."}}"" to give:
{{color hex="#DD0000" text="This is another test."}}

**Left floated box - use two < signs before and after the block**
<<Some text in a 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. This filler text is higher than the box so the next section starts on a new line below the box automatically.
**Right floated box, use two > characters before and after the block**
>>Some text in a floated box hanging around. And a little more to create a larger box. If the text in the box gets higher than the surrounding text, you'll need the "clearer" (see ""::c::"") to get new text to start on a new line //below// the box instead of next to the floated box. >>Some more text as a filler. Some more text as a filler. Some more text as a filler. Some more text as a filler.
""Use ::c:: to clear floated blocks... as done just below""
::c::
Simply use ""%%(formatter[;#number]) code %%"" - for the formatters, see the list below. If you add a number and it is enabled in the config, you will have line numbers starting at #number.
{{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;html;Java;java;Javascript;javascript;Lisp;lisp;Lua;lua;NSIS;nsis;Objective C;objc;OpenOffice BASIC;oobas;Pascal;pascal;Perl;perl;PHP;php;Python;python;Q(uick)BASIC;qbasic;Smarty;smarty;SQL;sql;VB.NET;vbnet;Visual BASIC;vb;Visual Fox Pro;visualfoxpro;XML;xml"}}
With the same syntax you can also use Wikka's built-in formatters: //email//, //ini// and //code//. If you haven't installed GeSHi //php// will be formatted by Wikka's built-in formatter, too.
Take a look at SyntaxHighlighter to see some examples.
===13. FreeMind maps===
See the FreeMind page on how to include FreeMind-maps
Use two doublequotes around the html-tags. Note the limitations on UsingHTML.
===15. Converting HTML to Wiki===
Visit http://diberri.dyndns.org/html2wiki.html
It allows you to paste HTML into a textbox and it will then convert it to Wikka Wiki markup (as well as a bunch of other Wiki dialects)
CategoryDocumentation
Deletions:
======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===
~##""---""##
---
===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""##
~This text is indented
~~This text is double-indented
~This text is also 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 one
~- Line two
**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
To format some text as an inline comment, use an indent ( **~**, a **tab** or **4 spaces**) followed by a **""&""**.
**Example:**
##""~& 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]] --- --- ##""[[mail@example.com | Write me!]]""## --- [[mail@example.com | Write me!]] --- ---
~1) add an image with a link (see instructions above);
~1) add an interwiki link (browse the [[InterWiki | list of available interwiki tags]]): --- --- ##""WikiPedia:WikkaWiki""## --- WikiPedia:WikkaWiki --- --- ##""Google:CSS""## --- Google:CSS --- --- ##""Thesaurus:Happy""## --- Thesaurus:Happy --- ---
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).
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."}}
Alternatively, you can specify a foreground and background color using the ##fg## and ##bg## parameters (they accept both named and hex values):
**Examples:**
~##""{{color fg="#FF0000" bg="#000000" text="This is colored text on colored background"}}""##
~{{color fg="#FF0000" bg="#000000" text="This is colored text on colored background"}}
~##""{{color fg="lightgreen" bg="black" text="This is colored text on colored background"}}""##
~{{color fg="lightgreen" bg="black" text="This is colored text on colored background"}}
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.
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).
~##""%%(""{{color c="red" text="php"}}"")<br /><?php<br />echo "Hello, World!";<br />?><br />%%""##
%%(php)
<?php
echo "Hello, World!";
?>
%%
You can also specify an optional //starting line// number.
~##""%%(php;""{{color c="red" text="15"}}"")<br /><?php<br />echo "Hello, World!";<br />?><br />%%""##
%%(php;15)
<?php
echo "Hello, World!";
?>
%%
If you specify a //filename//, this will be used for downloading the code.
~##""%%(php;15;""{{color c="red" text="test.php"}}"")<br /><?php<br />echo "Hello, World!";<br />?><br />%%""##
%%(php;15;test.php)
<?php
echo "Hello, World!";
?>
%%
|?|List of available code formatters||
|[|
|=|Language|=|Formatter|=|Language|=|Formatter|=|Language|=|Formatter||
|#|
|=|Actionscript||##actionscript##|=|ADA||##ada##|=|Apache Log||##apache##||
|=|""AppleScript""||##applescript##|=|ASM||##asm##|=|ASP||##asp##||
|=|""AutoIT""||##autoit##|=|Bash||##bash##|=|""BlitzBasic""||##blitzbasic##||
|=|C||##c##|=|C for Macs||##c_mac##|=|C#||##csharp##||
|=|C""++""||##cpp##|=|CAD DCL||##caddcl##|=|""CadLisp""||##cadlisp##||
|=|CFDG||##cfdg##|=|""ColdFusion""||##cfm##|=|CSS||##css##||
|=|D||##d##|=|Delphi||##delphi##|=|Diff-Output||##diff##||
|=|DIV||##div##|=|DOS||##dos##|=|Eiffel||##eiffel##||
|=|Fortran||##fortran##|=|""FreeBasic""||##freebasic##|=|GML||##gml##||
|=|Groovy||##groovy##|=|HTML||##html4strict##|=|INI||##ini##||
|=|Inno Script||##inno##|=|Java 5||##java5##|=|Java||##java##||
|=|Javascript||##javascript##|=|Lisp||##lisp##|=|Lua||##lua##||
|=|Matlab||##matlab##|=|Microchip Assembler||##mpasm##|=|Microsoft Registry||##reg##||
|=|""MySQL""||##mysql##|=|NSIS||##nsis##|=|Objective C||##objc##||
|=|""OpenOffice"" BASIC||##oobas##|=|Objective Caml||##ocaml##|=|Objective Caml (brief)||##ocaml-brief##||
|=|Oracle 8||##oracle8##|=|Pascal||##pascal##|=|Perl||##perl##||
|=|PHP||##php##|=|PHP (brief)||##php-brief##|=|Python||##phyton##||
|=|Q(uick)BASIC||##qbasic##|=|robots.txt||##robots##|=|Ruby||##ruby##||
|=|SAS||##sas##|=|Scheme||##scheme##|=|sdlBasic||##sdlbasic##||
|=|Smarty||##smarty##|=|SQL||##sql##|=|TCL/iTCL||##tcl##||
|=|T-SQL||##tsql##|=|Text||##text##|=|Unoidl||##idl##||
|=|VB.NET||##vbnet##|=|VHDL||##vhdl##|=|Visual BASIC||##vb##||
|=|Visual Fox Pro||##visualfoxpro##|=|""WinBatch""||##winbatch##|=|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.
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



Full history for this page cannot be displayed within a single page, click here to view more.

Valid XHTML :: Valid CSS: :: Powered by WikkaWiki