Overview

1. Tips and Hints
2. Basic Text Formatting
2.1. URLs
2.2. URLs Using Anchors
2.3. User Links
3. Lists
3.1. Simple lists
3.2. Numbered lists
3.3. Indented Text
3.4. Definition List
4. Images
5. Preformatted Text
6. Miscellaneous rules
7. HTML
8. Colors & Size
9. Comments

1. Tips and Hints

The following text is an overview of the UseModWiki text formatting rules.

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

  • To see how any page is formatted, just follow the link "Edit text of this page" at the bottom of the page.
  • and to try these rules for yourself, please feel free to edit the Sandbox page.

2. Basic Text Formatting

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

  • Carriage returns (ie pressing the Enter key) are significant in formatting a wiki page
  • Multiple spaces and tabs are ignored
  • use '' (two single-quotes) for italics, ''' (three single-quotes) for bold, and ''''' (five single-quotes) for bold-italics. Alternatively, use tags <b>bold</b> and <i>italic</i>
  • Use tag <tt>for monospace text</tt> (tt stands for typewriter text)
  • The first character entered on a line often controls the formatting of the text on that line (shades of Fortran), in brief (see below and sub pages for details):
    • " " space causes text to appear in a monospaced font where spaces are significant
    • ":" colon causes text to be indented
    • "=" equals - followed by a space - creates a heading, a trailing "=" - preceded by a space - is required
    • "*" asterisk creates a bulleted list
    • "#" hash creates a numbered list
    • ";" semicolon creates a definition list, a ":" colon is required subsequently on the same line
    • "----" four hyphens creates a horizontal line
    • "||" vertical bar creates a table (requires a table patch for versions prior to 1.0, eg WikiPatches/TableSyntaxCommonMarkup).
Repetition of the first character on the line generally increases the indentation or emphasis
  • Leave a single blank line between paragraphs.
  • Suppress wiki formatting and linking through escaped WikiWiki text -- <nowiki>WikiWiki</nowiki>
  • Insert an image using a full URL, eg http://usemod.com/wiki.gif

People abhorring PascalCase can use a free link: surround text with two pairs of square brackets like [[Sample Free Link]]. This allows all-downcase or atomic capitalized names as well as strange names including punctuation. This is the default channel in creating pages.

2.1. URLs

Plain URL link: http://www.flproject.info/ -- http://www.flproject.info/

Named URL link: Main Page -- [http://www.flproject.info/ Main Page]

2.2. URLs Using Anchors

 Buried Treasure  -- [http:/wiki/wiki.pl?SandBox#anchor Buried Treasure]

(Tip: you should be able to use relative addressing eg http:/wiki.pl?SandBox#Anchor)

To set an anchor:

  • -- [#anchor]

2.3. User Links

User link: jibber -- User:jibber

User link: sawarahh -- User:sawarahh

You can separate links from adjacent text with spaces or the special "" (two double-quotes) delimiter. The "" delimiter is not displayed - it is useful for cases like plural forms of page links (such as UseModWiki""s). In nearly all cases, trailing punctuation is ignored, so you can safely make links like http://www.flproject.info/, without the trailing comma being part of the link. You can also use FreeLinks.

3. Lists

3.1. Simple lists

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

...which looks like:

  • Text for a bulleted list item.
    • Text for second-level list.
      • Text for third level, etc.

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

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

3.4. Definition List

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)

4. Images

Just provide the URL, and the image will be inserted inline.

These extensions are recognized: gif, jpg, png, bmp, jpeg, ico and tiff.

Note case sensitivity: capitalized extensions such as .GIF, .PNG, .JPG, etc. do NOT work. Some digital cams capitalize image names automatically, so you have to edit them before linking them into your wiki. -- Celine

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

5. 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, [[KaerBanor|Kaer Banor]] is not a link here.

Use nowiki tags if you want \
to include a backslash at the end of a line.
and:

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

You can also use <presub> which allows linking of pages within preformatted text. This makes uniform map making possible.

Stuff like this
Will always be
monospace but links
like ValMiran still work

6. Miscellaneous rules

  • To quote text without applying the wiki formatting rules, enclose it within a <nowiki> ... </nowiki> section. Within a nowiki section, only HTML-quoting of special characters (<>&) will occur - no other formatting rules will be applied.
  • A line which ends in a backslash character (\) will be joined with the next line before most formatting rules are applied. This can be useful for breaking up long sections of text in line-sensitive sections (like lists or indented text). If you actually want a backslash to appear at the end of a line in a preformatted section, put it in a nowiki section <nowiki>\</nowiki>
  • If raw-HTML sections are enabled (they are disabled by default), you can enter raw HTML code within an ... section. Note that no quoting is done, so you will need to use sequences like &lt; if you want to display a < character.
  • Most of the formatting rules are order-independent. On rare occasions, the order of processing may be important. The rules are processed in the following order: raw HTML sections, HTML quoting, nowiki tags, backslash line joining, preformatted sections, paragraphs, lists and indented text, horizontal lines, italic/bold text, URLs, and finally ordinary WikiName links. [No longer fully accurate for 0.88, needs updating.]
  • To redirect one wiki page to another, use the following syntax:
    #REDIRECT TargetPage
    #REDIRECT TargetPage/SubPage

7. HTML

  • Encoding the "<" less than, ">" greater than, and "&" ampersand characters is optional.
  • Characters such as <, © and ∞ may be encoded on pages as: "&lt;", "&copy;" and "&infin;" respectively.

8. Colors & Size

  • You can also specify colors with either the name of the color (for instance red) or #hexdecimal of that color. The easiest way to do this is to use the ^ tag.
  • In order to specify a size, you can use the {{ and }} tags. Examples are shown below:
    • {{red,200% Red is the new black!}} would show Red is the new black!.
    • ^#ff0000 Red is the new blue!^ would show Red is the new blue!.

Please note that you can also specify the first 3, or the full 6 #hex color code.

9. Comments

Comments are also able to be specified within the text of a wiki page. This is useful to remind editors to use a certain format, or leave comments next to wiki code to explain their uses. In order to use comments, simply print: <!-- comment here -->. A hidden comment is below this line. You can edit the page to see it.



  • You have no special abilities

  • This page is read-only | View other revisions | View recent changes | Preferences
    Last edited May 16, 2012 12:25 am by jibber (diff)

    Search: