home index sites engineering software hardware email
 

How-To: Wikka Wakka Wiki



Wiki Formatting Guide


(Ref: http://docs.wikkawiki.org/FormattingRules)


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



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


Horizontal separator:


----



  • Forced line break


    ---
    text before
    and after a 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:
  • bulleted list
  • Line two
    ~1) numbered list:
  • numbered list
  • Line two
    ~A) Using uppercase characters:
  • Using uppercase characters
  • Line two
    ~a) Using lowercase characters:
  • Using lowercase characters
  • Line two
    ~I) using uppercase roman numerals:
  • using Latin numbers
  • Line two
    ~i) using lowercase roman numerals:
  • using Latin numbers
  • Line two

    Inline comments


    ~& Comment
    ~~& Subcomment
    ~~~& Subsubcomment


    • Comment
      • Subcomment
        • Subsubcomment


    Images


    To place images on a Wiki page, use:
    {{image class="center" alt="DVD logo" title="An Image Link" url="http://wikkawiki.org/images/dvdvideo.gif" link="/Welcome"}}
    dvd logo
    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.

    Image scaling is also supported (a non-wikka addition by Rod) using 'width="val"' and 'height="val"' tags, for example {{image class="center" alt="DVD logo" title="An Image Link" url="http://wikkawiki.org/images/dvdvideo.gif" link="/Welcome" width="100" height="50"}} looks like:
    dvd logo


    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> Google
    To open a web page in a new copy of your browser, use <A href="http://google.com" TARGET="_blank">Google</A> Google

    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> Click Here
    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> Click Here


    Tables


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

    BIG GREEN FROGS
    yes yes no
    no no


    ### means the cell is empty.


    Colored Text


    {{color c="blue" text="This is a test."}} gives:

    This is a test.

    If you want to use hex values:

    {{color hex="#DD0000" text="This is another test."}} to give:

    This is another test.


    Floats


    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
     



    Code formatters


    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.

    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.


    Embedded HTML


    Use two doublequotes around the html-tags.


    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)


    Alert Boxes


    {{ alterbox text="this is some altert box text" c="blue" }} looks like:

    this is some altert box text

  •