From DemotechResearch

PmWiki: TextFormattingRules

This page provides a more complete list of some of the markup sequences available in PmWiki. Note that it's easy to create and edit pages without using any of the markups below, but if you ever need them, they're here.

To experiment with the rules, please try editing the Design/WikiSandbox.


Paragraphs


Indented Paragraphs (Quotes)

Arrows (->) at the beginning of a paragraph can be used to produce an indented paragraph. More hyphens at the beginning (--->) produce larger indents.

 ->Four score and seven years ago our fathers placed upon this
 continent a new nation, conceived in liberty and dedicated to the
 proposition that all men are created equal.
Four score and seven years ago our fathers placed upon this continent a new nation, conceived in liberty and dedicated to the proposition that all men are created equal.

Bulleted Lists

Bullet lists are made by placing asterisks at the left margin. More asterisks increases the level of bullet:

 * First-level list item
 ** Second-level list item
 ** Another second-level item
 * A first-level item

Horizontal Line

Four or more dashes (----) at the beginning of a line produce a horizontal line.


Emphasis

See also WikiStyles for advanced text formatting options.


References


FreeLinks

A free link is a page name reference that doesn't follow the WikiWord convention.

Often, there is no natural WikiWord for naming a page. That's when {{free links}} (a page called free links) are useful. The {{text}} markup creates a link to a page called Text. The markup {{basic editing}} markup creates a link to a page called BasicEditing and displays as basic editing. Suffixes and plurals are also possible, thus {{wiki word}}s produces wiki words.

For more information please see the FreeLinks documentation.


Headings

Headings are made by placing a exclamation mark (!) at the left margin. More exclamation marks increases the level of heading. For example,

 ! Level 1 Heading

Level 1 Heading

 !! Level 2 Heading

Level 2 Heading

 !!! Level 3 Heading

Level 3 Heading


Escape sequence

Anything placed between [= and =] is not interpreted by PmWiki/PmWiki. This makes it possible to easily do WikiWords that are not links and turn off other special formatting interpretation. The [= and =] can span multiple input lines, allowing effects to be applied to multiple input lines. For example, space[= at the beginning of a line will cause the text up to the next =] to be monospace and uninterpreted by PmWiki/PmWiki (useful for program listings).


Numbered Lists

Numbered lists are made by placing number-signs (#) at the left margin.

 # Prepare the experiment
 ## Unwrap the pop-tart
 ## Insert the pop-tart into the toaster
 # Begin cooking the pop tart
 # Stand back
  1. Prepare the experiment
    1. Unwrap the pop-tart
    2. Insert the pop-tart into the toaster
  2. Begin cooking the pop tart
  3. Stand back

Definition Lists

Definition lists are made by placing colons at the left margin:

 :term:definition of term
 ::second-level item: definition of 2nd-level item
term
definition of term
second-level item
definition of 2nd-level item

Tables

Table are defined by enclosing cells with '||'. A cell with leading and trailing spaces is centered; a cell with leading spaces is right-aligned; all other cells are left-aligned. An empty cell will cause the previous cell to span multiple columns. (There is currently no mechanism for spanning multiple rows.) A line beginning with '||' specifies the table attributes for subsequent tables.

 
        ||align=center border=1 width=50%
        ||Left   || Center ||  Right||
        ||A      ||    B   ||      C||
        ||       || single || ||
        ||       || multi span ||||

LeftCenterRight
ABC
 single 
 multi span

For more information see SimpleTables, SimpleTables2 and AdvancedTables.



Comments

Text following a %comment% tag is not displayed, up until the end of the line or a subsequent %%.

 %comment% This is a hidden comment line that doesn't show.

<< Images | PmWiki.DocumentationIndex | Uploads >>

Retrieved from http://demotech.org/pmwiki/pmwiki.php?n=PmWiki.TextFormattingRules
Page last modified on September 27, 2006, at 07:51 PM