Help On Formatting


Help Menu: Wiki? | Creating A New Page | Editing | Formatting | Emoticons | Headers | Linking | Macros | Processing Instructions | Tables | Images

OpenWiki offers many system options to the administrator of an OpenWiki site, so the formatting rules may differ between various OpenWiki sites.

This particular wiki has every system option turned on except the one that would give editors the ability to enter raw HTML into a page (with some minor exceptions to that exception ;-) ).

The Basics

  • Forget HTML. It is not allowed. So <b>bold</b> will not appear in a bold font, but instead as you see it right now. The & character references will not work either.

  • Do not indent paragraphs.

  • Words wrap and fill as needed.

  • Leave a blank line between paragraphs.

  • Type 4 or more minus/dash/hyphen (-) characters to create a horizontal rule.

  • URL's and email addresses are automatically hyperlinked.

  • Wiki Names are automatically hyperlinked. A Wiki Name conforms to the Link Pattern, which basically is a word containing more than one capital letter where the capitals aren't right next to each other. In other words, simply SmashWordsTogetherLikeSo.

That's basically all you need to know to get started. Following are more basic rules. For advanced formatting rules see Help On Editing.

Bold, Italic, Underscore, Strikethrough

To mark text as bold enclose text by two asterisks (*) characters on both sides. To mark text as italic enclose text by two slash (/) characters on both sides. To mark text underlined enclose text by two underscore (_) characters on both sides. To mark text strikethrough enclose text by two dash (-) characters on both sides.

**Some bold text**, //some italic text//,
**//some bold and italic text//**
__Some underlined text__ --Some strikethrough text--

will appear as:

Some bold text, some italic text, and some bold and italic text
Some underlined text Some strikethrough text

OpenWiki also supports the "old" style of placing emphasis on text which is used by several original wikis.

''2 quotes are italic'', '''3 quotes are bold''', 
and '''''5 quotes are bold and italic'''''

will appear as:

2 quotes are italic, 3 quotes are bold, and 5 quotes are bold and italic

Note: whether the "new" and/or "old" style of placing emphasis on text is in effect depends on the system options as configured by the administrator of this site.

Linking

See also Help On Linking.

Inter Wiki links, e.g.:

Lists

All lists start with 2 spaces at the beginning of a line. Sublists are created by adding an additional 2 spaces for every level that you want to add. See also HelpOnLists.

Bulleted Lists

  * Bulleted Item
  * Another one
    * Subbulleted item
    * And another one
  * Last one

will appear as:

  • Bulleted Item
  • Another one
    • Subbulleted item
    • And another one
  • Last one

Numbered Lists

  1. First item
  2. Second item
    1. First subitem of //second item//
    1. Second subitem of //second item//
      a. subitem a
      a. subitem b
    1. Third subitem of //second item//
      i. subitem 1
      i. subitem 2      
  3. Third item
    1.#17 another item
    1. yet another one
  4. Fourth item
    a.#17 another item
    a. yet another one
  5. Fifth item
    i.#17 another item
    i. yet another one

will appear as:

  1. First item
  2. Second item
    1. First subitem of second item
    2. Second subitem of second item
      1. subitem a
      2. subitem b
    3. Third subitem of second item
      1. subitem 1
      2. subitem 2
  3. Third item
    1. another item
    2. yet another one
  4. Fourth item
    1. another item
    2. yet another one
  5. Fifth item
    1. another item
    2. yet another one

Dictionary Lists

Terms with indented definitions: [without a blank line between term and definition]
  ; Term One : Definition for One (indented)
  ; Term Two : Definition for Two (indented)
  ; Term Three : Definition for Three (indented)
    ; Term (indented) : Definition (indented two levels)
      ; Term (indented twice) : Definition (indented to third level)

will appear as:

Term One
Definition for One (indented)
Term Two
Definition for Two (indented)
Term Three
Definition for Three (indented)
Term (indented)
Definition (indented two levels)
Term (indented twice)
Definition (indented to third level)

Mixing Lists

You can also mix lists, for example:

  * First bulleted item
  * Second bulleted item
    1. First subitem of **second item**
       Some more text about first subitem....
       End of this subitem.
    2. Second subitem of **second item**
  * Last bulleted item

will appear as:

  • First bulleted item
  • Second bulleted item
    1. First subitem of second item

    2. Some more text about first subitem....
      End of this subitem.
    3. Second subitem of second item
  • Last bulleted item

Indented text

  : Paragraph to be indented (quote-block)
    : Paragraph indented more
      : Paragraph indented to third level

will appear as:

Paragraph to be indented (quote-block)
Paragraph indented more
Paragraph indented to third level

Preformatted text

Sourcecode

If you want to display sourcecode use the <code> tag or enclose the source by three acolades (e.g. {{{some code}}}).

Singleline example:
The command {{{foo := bar + 1;}}} will add 1 to bar and assign it to foo.    

will appear as:

The command foo := bar + 1; will add 1 to bar and assign it to foo.

Multiline example:
{{{
begin
    foo := bar + 1;
end;
}}}

will appear as:

begin
    foo := bar + 1;
end;

Note that within sourcecode most features won't work, such as: automatic hyperlinking of URLs, Wiki Names, making text italic, etc. What still does work within sourcecode is the ability to highlight text by using three single quotes and the ability to use the <nowiki> tag.

Example:
<code>
begin
    '''foo := bar + 1;'''
    foo := foo << 1;
    return foo;
end;
</code>

will appear as:

begin
    foo := bar + 1;
    foo := foo << 1;
    return foo;
end;

Tables

|| **ID** || **Name** || **Description** ||
|| 123 || John Foo || Some foo user ||
|| 456 || Mary Richardson || Contact person from Foo Corp. ||

will appear as:

ID Name Description
123 John Foo Some foo user
456 Mary Richardson Contact person from Foo Corp.

From more details about how to format tables see Help On Tables.

Miscellaneous


Category Help

Last Edited December 16, 2006



--