Markup
 Home 

MemoWiki lets you ‘mark up’ text using a series of fairly simple notations which are based on those used for Wikipedia », together with some extensions for ‘proper’ quotes, some common symbols, dashes, accents, open lists, and so on. The markup is either structural or inline.

Structural markup is indicated by the first character of a line being non-alphanumeric, and describes structural elements of the page, such as paragraphs, lists, and sections.

Inline markup can be used anywhere there is text content, and causes changes of font, inserts special characters or symbols, or indicates a link (to another page, a reference, a file, or to a World Wide Web page).


Structural markup, as used in Wikipedia (must start a line):

   empty line       Paragraph
   == title ==      Major heading (no tags or links in title)
   === title ===    Sub-heading
   ==== title ====  Sub-sub-heading
   ----             Horizontal rule
    text            (at least one blank at start) monospaced 'code' line
   *                unordered list item
   **               (nested)
   #                ordered list item
   ###              (nested)
   ; term : item    definition list term/item; : may start new line
   #** *;# etc.     (nested mixed lists)
                    these compact lists are ended by a blank line
   :, ::, etc.      indented paragraph (except after ; term)

   {| params        table start (params optional)
   ! content        bold cell (th)
   | content        normal cell (td)
   | cell1 || cell2 multiple cells on same line (use !! for bold)
   | params | cell  cell with parameters (also OK for same-line cells)
   |- params        new row (params optional); optional for first row
   |+ caption       caption (must start table)
   |+ params|cap    caption with parameters
   |}               end table

Inline markup, as used in Wikipedia (only recognised outside code lines):

   "phrase"         double-quoted phrase
   'phrase'         quoted phrase
   ''phrase''       italic phrase
   '''phrase'''     bold phrase
   '''''phrase''''' bold italic phrase
   ~~~              authname
   ~~~~             authname + date/time
   ~~~~~            date/time
   [URL | content]  <a href="URL">content</a>
                    If no content then content=URL
                    Notes:
                      1. If first word contains a / or an embedded . then
                         it is assumed to be a URL/file (fully qualified
                         or relative) and the | is optional
                         (Wikipedia- and Speleogroup-compatible)
                      2. 'content' is optional, is used for rendering
                         instead of the URL
                      3. no embedded <tags> in the content, but Wiki
                         shorthand is OK
                      4. see below for intra-MemoWiki links.

   [[name|content]] Wikipedia article reference, with optional |content

   <nowiki> ...     pass through without Wiki processing; HTML markup
    ... </nowiki>   (including tags and HTML's &symbols;) will be processed

Square-bracket notations are described in detail on the Links page.

Below here are additional markups supported by MemoWiki (MFC additions):

Structural markup (must start a line):

   / text           break
   // text          (nested/indented)

   > text           overhanging break
   >> text          (nested/indented)

   ) text           comment (line is ignored)
   )) text          ephemeral comment (will be removed when next edited)

   Open lists (which may be mixed with compact lists). First item (which
   may be empty) has + following the list indicator (single or nested);
   the list is then not terminated by an empty line, but instead is
   terminated by a matching indicator with + with no item text (or by a
   shorter list indicator, as usual).
   Example:

     *+ This is the first item.

        Second paragraph of the first item.

     *  Second item.
     *+ <!-- end of list marker; not an item. -->

   A list may also have a '-' modifier on its first item; this requests
   a compact list (useful on definition lists).

Inline markup (only recognised outside code lines):

   ---              em dash
   --               en dash
   _                required space (&nbsp;)
   ~_               underscore
   ~~               ~ tilde
   ~? ~!            inverted question mark, inverted exclamation mark
   ~'               apostrophe (only needed for leading apostrophe)
   ~=, ~*, ~/, ~-   approximately equal, multiply, divide, minus
   ~+               dagger
   ->               right arrow
   <-               left arrow
   <->              double arrow
   it's             embedded ' becomes apostrophe
   ""phrase""       typewriter font phrase
   """phrase"""     sans serif font phrase
   foo^phrase       foo<sup>phrase</sup> (must end in blank, which is
                      removed unless followed by alphanumeric)
   foo^^phrase      foo<sub>phrase</sub> (same rules)
   [name | content] link to a page or reference
   [@ mark|content] Mark: <a name="mark">content</a>
   [# mark|content] Link to mark: <a href="#mark">content</a>
                    (the blank after @ or # is optional)

Again, the [...] notations are described in detail on the Links page.

Special symbols, including &aaa; entities provided by wiki2html (rather than processed by the browser):

   &lsq; &rsq;      [ ]
   &etc; etc.       ''etc.''
   &cf;  cf.        ''cf.''
   &eg;  e.g.       ''e.g.''
   &ie;  i.e.       ''i.e.''
   &qv;  q.v.       ''q.v.''
   &vs;  vs.        ''vs.''
   &min;            ' prime
   &sec;            " prime
   &u;              &micro;

Accents

   ~c!              Accented character, where:
                    c=upper or lowercase letter valid for accents
                    !=accent to apply, one of:
                      '      `      ^     :    ~
                    [acute, grave, circ, uml, tilde]

Text within code lines (lines starting with a blank) is untouched, except that &, <, and > characters are protected.

HTML markup may be used at will, but is not processed in any way or checked. You must ensure the HTML is correct and complete; if you are not comfortable with HTML, use only MemoWiki markup.

MemoWiki markup is implemented by the wiki2html Rexx » program.


Markup was last edited on 2007-11-26  
Project: MemoWiki