[Home] Kranich Industriemesstechnik
TextFormattingRules

Our Mission

Products
Services
Solutions
References
News

Search:
Index
RecentChanges

Contact
Partners
Links
Support

Impressum

 

 

Wiki Text Formatting Rules

Taken from [UseModWiki] as this site is based on this [Wiki]

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

Tips | Hints

The following text is an overview of the UseModWiki text formatting rules. For examples without all the explanatory text, see the TextFormattingExamples. 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:
  • 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

Additional Text Formatting Rules:

/WikiTextFormatting?
/WikiLists?
/WikiHeadings?
/WikiImages?
/WikiLines?
/WikiTables?
TableFormatting?

Page, URL, and InterWiki? 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, WikiName and TextFormattingExamples are samples of page links.

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.

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.usemod.com/cgi-bin/mb.pl?SandBox -- http://www.usemod.com/cgi-bin/mb.pl?SandBox

Named URL link: [Sandbox] -- [http://www.usemod.com/cgi-bin/mb.pl?SandBox Sandbox]

I don't know whether this is intentional, but you can create an image which links to a url using [url image_url] e.g.

This feature is intentional, and it was added for the 1.0 release of UseModWiki. I simply hadn't updated the documentation yet.

URLS Using Anchors?

 [Buried Treasure]  -- [http://www.usemod.com/cgi-bin/mb.pl?SandBox#anchor Buried Treasure]

To set an anchor:

  • -- [#anchor]

On-Site URLS

To make on-site links you must respecify the protocol e.g.:

Problem is local; this #anchor syntax works for me without any issues. --CParker?

Full relative urls do not seem to work.

InterWiki?

InterWiki? link: UseMod?:InterWiki? -- UseMod:InterWiki

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 UseModWikis). In nearly all cases, trailing punctuation is ignored, so you can safely make links like http://www.usemod.com/, without the trailing comma being part of the link. You can also use FreeLinks?.

Lists:

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.

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.

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:

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

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. See http://www.w3.org/TR/html4/sgml/entities.html. [UseMod?:DougConley? dcon]

See also
WikiBugs/TextFormatting?
MeatBall?:TextFormattingRules
WikiMarkupLanguage?

HELP

How can I create a comment in UseModWiki? I want to place a comment in a Wiki, not shown on the generated HTML page.

There is no way to add invisible comments in UseModWiki. (Some other wikis allow HTML-style comments, but not UseModWiki.) -- CliffordAdams?
Not strictly true - if you allow raw html ($RawHtml? =1; NB security risk) you can then put -- Rob Stone
Futher to that i've made a simple change adding one line (~ line 1690 immediately before the <tt> (MeatBall) line
s/\<\!--(.*?)--\>/<\!-- $1 -->/gis; #RFS
this seems to work fine for coments - Is there an issue i am missing ?-- Rob Stone

A company has a name ending in a plus sign, such as "foo+". How can I make that into a link? If I use the doubled brackets [[foo+]], it doesn't come out right.

If a link has a '[' and ']' character, how do I link it to wiki? e.g. www.anywebpage.com/[test].doc

un-escaped '[' and ']' characters are not valid in URIs [RFC2396 2.4.3]. Maybe %encoding them (%5b and %5d) in the URL would work?

I have just got UseMod? working on my Windows 2K machine, with Apache, but the InterWiki? feature doesn't seem to work. For example, when I type

 UseMod:InterWiki 
, it assumes I want to create two new pages, called UseMod and InterWiki respectively. How do I enable the InterWiki? functionality?

Have you added an Intermap file to your data directory, as discussed in InterWikiDocumentation??

Referencing an uploaded file with a camel-case-name produces defunct link. Is there a workaround?

  • See WikiBugs/CamelCaseImageUploadCausesProblemsWithDisplay?

Has anyone considered removing the underscore '_' character from the page name. So that these: '[Many Times Before]?' '[Many Times Before]?' and ManyTimesBefore? would all go to the same page?

Also, is the behavior of free links with spaces intentional (it diplays an outer set of brackets)?


To remove underscore characters from page names, modify the function FreeToNormal? (on or about line 3057). My version follows. It not only removes underlines as suggested (as that appeals to me), but always capitalizes the first character (as the current code has a slight bug in it that resolves [[ many times before]] to [[many_Times_Before]] rather than [[Many_Times_Before]]. By simply moving the ucfirst call to after the check for leading spaces, this is resolved.
                               -- DarochDad?

sub FreeToNormal {
  my ($id) = @_;

  $id =~ s/ /_/g;
  if (index($id, '_') > -1) {  # Quick check for any space/underscores
    $id =~ s/__+/_/g;
    $id =~ s/^_//;
    $id =~ s/_$//;
    if ($UseSubpage) {
      $id =~ s|_/|/|g;
      $id =~ s|/_|/|g;
    }
  }
  $id = ucfirst($id)  if ($UpperFirst || $FreeUpper); #moved -- DarochDad
  if ($FreeUpper) {
    # Note that letters after ' are *not* capitalized
    if ($id =~ m|[-_.,\(\)/][a-z]|) {    # Quick check for non-canonical case
      $id =~ s|([-_.,\(\)/])([a-z])|$1 . uc($2)|ge;
    }
  }
  $id =~ s/_//g; # Remove _ characters -- DarochDad
  return $id;
}

HomePage | RecentChanges |
| View other revisions | Printer Friendly
(c) 2005 Kranich IMT, Christian Kranich - Wiki vsn 1.0.14 Last edited July 1, 2005 23:30 (diff)