[Home]FormattingRules

HomePage

Wiki Text Formatting Rules

Simple editing is one of the major benefits of using a wiki. Users can edit pages without knowing HTML, and still use many formatting features of HTML. Most wikis define a set of formatting rules to convert plain text into HTML. Some wikis (like this one) also allow some HTML "tags", like <b>, <i>, and <pre> within a page. (Some wikis use raw HTML instead of special formatting rules.)

The following text is an overview of the wiki text formatting rules. To try these rules for yourself, please feel free to edit the Sandbox page. To see how any page is formatted, just follow the link "Edit text of this page" at the bottom of the page.

Basic Text Formatting

Entering text on a wiki can be done simply. Follow these guidelines:

Repetition of the first character on the line generally increases the indentation or emphasis

Page and URL Links

Wiki Pages

You can link to a page by removing the spaces between two or more words, and starting each word with a capital letter. For instance FormattingRules is an example of a page link.

People abhorring PascalCase can use a free link: surround text with two pairs of square brackets like Sandbox. This allows all-downcase or atomic capitalized names as well as strange names including punctuation.

Nonexistent pages, like SampleUndefinedPage?, will be displayed with a question mark link. The question mark link indicates the page doesn't exist yet--follow the link to create and edit the page. [The sample page used here is a special example page--you can't define it.]

URLs

Plain URL link: http://www.tablix.org

Named URL link: [Tablix Home Page] -- [http://www.tablix.org Tablix Home Page]

Lists

Simple lists:
* Text for a bulleted list item.
** Text for second-level list.
*** Text for third level, etc.

...which looks like:

Numbered lists:

# Text for a numbered list item.
## Text for second-level list.
### Text for third level, etc.
## Another Text for the second level.

...which looks like:

  1. Text for a numbered list item.
    1. Text for second-level list.
      1. Text for third level, etc.
    2. Another Text for the second level.

Indented Text:

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

...which looks like:

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

Definition Text

Term with indented definition: [without a blank line between term and definition]
;Term:Definition (indented)
;;Term (indented):Definition (indented two levels)
;;;Term (indented twice):Definition (indented to third level)
...which looks like:
Term
Definition (indented)
Term (indented)
Definition (indented two levels)

Term (indented twice)
Definition (indented to third level)

Images

Just provide the URL, and the image will be inserted inline. However, the image must be hosted on another server. You can not upload it to this server.

These extensions are recognized: gif, jpg, png, bmp, jpeg

If you have a choice, results are usually best with png for computer generated images, and JPEG for photographic images.

Preformatted Text

Individual lines can be displayed as preformatted (fixed-width or "typewriter"-font) text by placing one or more spaces at the start of the line. Other wiki formatting (like links) will be applied to this kind of preformatted text.

Additionally, multi-line sections can be marked as pre-formatted text using lines starting with <pre> (to start pre-formatted text), and </pre> (to end preformatted text). The <pre> and </pre> tags are not displayed. Wiki links and other formatting is not done within a preformatted section. (If you want wiki formatting, use spaces at the start of the line instead of the <pre> and </pre> tags.)

For instance:

Pre-formatted section here.  No other link =link=
  or format processing


is done on pre-formatted sections.

For instance, UseModWiki is not a link here.
and:

   This is the starting-spaces version of
   preformatted text.  Note that links like
   UseModWiki? still work.

Miscellaneous rules

See also

http://www.usemod.com/cgi-bin/wiki.pl?TextFormattingRules http://www.usemod.com/cgi-bin/wiki.pl?TextFormattingExamples


HomePage
This page is read-only
Last edited April 14, 2005 9:46 pm by 192.168.1.2