Wikka Documentation : TextFormatting

HomePage :: Index :: RecentChanges :: Search :: Login/Register
[619] Latest edit on 2008-02-01 04:38:55 by YanB [1.1.6.0]


Additions:

Wikka Formatting Guide

NOTE
This feature is available since:
WikkaWiki 1.1.6.0

Note: Anything between 2 sets of double-quotes is not formatted.
 

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
~~This text is double-indented
    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
Numbered lists
~1) Line one
~1) Line two
  1. Line one
  2. Line two
Ordered lists using uppercase characters
~A) Line one
~A) Line two
  1. Line one
  2. Line two
Ordered lists using lowercase characters
~a) Line one
~a) Line two
  1. Line one
  2. Line two
Ordered lists using roman numerals
~I) Line one
~I) Line two
  1. Line one
  2. Line two
Ordered lists using lowercase roman numerals
~i) Line one
~i) Line two
  1. Line one
  2. 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

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"}}
dvd logo
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

  2. 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]]
    Test your formatting skills

    [[SandBox 沙箱]]
    沙箱

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

  2. 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]]
    Jenna's Home Page

    [[mail@example.com Write me!]]
    Write me!

  3. add an image with a link (see instructions above);
  4. add an interwiki link (browse the 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;###"}}
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."}}
This is a test.
You can also use hex values:
Example:
{{color hex="#DD0000" text="This is another test."}}
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"}}
This is colored text on colored background
{{color fg="lightgreen" bg="black" text="This is colored text on colored background"}}
This is colored text on colored background

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.
 
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.
 
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)
<?php
echo "Hello, World!";
?>
%%
<?php
echo "Hello, World!";
?>

You can also specify an optional starting line number.
%%(php;15)
<?php
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)
<?php
echo "Hello, World!";
?>
%%
test.php (line 15)
  1. <?php
  2. echo "Hello, World!";
  3. ?>

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
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 Eiffel eiffel Fortran fortran
FreeBasic freebasic GML gml Groovy groovy
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 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 PL/SQL plsql Python phyton
Q(uick)BASIC qbasic robots.txt robots Ruby ruby
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 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]""
Examples:
""y = x<sup>n+1</sup>""
y = xn+1
""<acronym title="Cascade Style Sheet">CSS</acronym>""
CSS
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:

The Wiki Formatting Guide

This formatting guide applies to version 1.1.6.0-dev running this server. For an updated list of formatting rules available in the latest stable release (1.1.6.2), please refer to this page.
 

Anything between 2 sets of double-quotes is ignored and presented exactly as typed (that means the formatting commands below are ignored whenever surrounded by double double-quotes.)
Once you've read through this, test your formatting skills in the SandBox.

Basic formatting:

**I'm bold text!**
I'm bold text!
//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

Headers:

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

Horizontal separator:

----

Forced line break:

---

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:
~1) numbered list:
  1. numbered list
  2. Line two
~A) Using uppercase characters:
  1. Using uppercase characters
  2. Line two
~a) Using lowercase characters:
  1. Using lowercase characters
  2. Line two
~I) using uppercase roman numerals:
  1. using Latin numbers
  2. Line two
~i) using lowercase roman numerals:
  1. using Latin numbers
  2. Line two
Tables:
To create a table use this code:
{{table columns="3" cellpadding="1" cells="BIG;GREEN;FROGS;yes;yes;no;no;no;###"}} to give:
BIG GREEN FROGS
yes yes no
no no

### means the cell is empty.
Textboxes
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.
Right floated box, use two > characters 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.
Use ::c:: to clear floated blocks...


[618] Edited on 2008-02-01 03:40:33 by DarTar [refers to 1.1.6.0-dev must be updated to 1.1.6.4]


Additions:
CategoryEN - CategoryReview
Deletions:
CategoryEN

[266] Edited on 2006-11-12 14:01:14 by YanB [cat]


Additions:
HomePage
CategoryEN
Deletions:
Wikka Documentation
CategoryDocumentation

[190] The oldest known version of this page was created on 2006-08-04 06:12:24 by DarTar [adding note on version]

History of recent changes for TextFormatting
Wikka Documentation

The Wiki Formatting Guide


This formatting guide applies to version 1.1.6.0-dev running this server. For an updated list of formatting rules available in the latest stable release (1.1.6.2), please refer to this page.
 


Anything between 2 sets of double-quotes is ignored and presented exactly as typed (that means the formatting commands below are ignored whenever surrounded by double double-quotes.)

Once you've read through this, test your formatting skills in the SandBox.

Basic formatting:


**I'm bold text!**
I'm bold text!

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

Headers:

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

Horizontal separator:

----

Forced line break:

---


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:

~1) numbered list:
  1. numbered list
  2. Line two

~A) Using uppercase characters:
  1. Using uppercase characters
  2. Line two

~a) Using lowercase characters:
  1. Using lowercase characters
  2. Line two

~I) using uppercase roman numerals:
  1. using Latin numbers
  2. Line two

~i) using lowercase roman numerals:
  1. using Latin numbers
  2. Line two


Tables:

To create a table use this code:
{{table columns="3" cellpadding="1" cells="BIG;GREEN;FROGS;yes;yes;no;no;no;###"}} to give:

BIG GREEN FROGS
yes yes no
no no


### means the cell is empty.

Textboxes

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.

Right floated box, use two > characters 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.

Use ::c:: to clear floated blocks...

CategoryDocumentation
2008-02-01 04:38:55 feed icon :: Public page ::
Creative Common Attribution-ShareAlike License
Valid XHTML 1.0 Transitional :: Valid CSS :: Powered by WikkaWiki
Page was generated in 0.3230 seconds