About Download Docs Changes

Markup2

Markup2

Hatta markup implements a large subset of the Wiki Creole 1.0 standard. [1] The Hatta variation is described on this page and summarized elsewhere.

Hint: The Edit button can be used to discover how markup was used to create any editable page.

Sections: Heading, Emphasis, Punctuation, Paragraph, Lists, Preformat, Syntax, Links, Images, Tables, Math, Comment,


Heading

Headings have one or more '=', beginning in column 1.

Hatta forces the level 1 heading to the page name. It can't be explicitly controlled (yet?).

= Huge Heading (html h1)
== Large Heading (html h2, nominal)
=== Medium Heading (html h3, sub-sub-level)
==== Small Heading (html h4, sub-sub-sub-level)
===== Tiny Heading (html h5, minimum level supported)

Huge Heading (html h1)

Large Heading (html h2, nominal)

Medium Heading (html h3, sub-sub-level)

Small Heading (html h4, sub-sub-sub-level)

Tiny Heading (html h5, minimum level supported)

Emphasis:

Horizontal rules have four or more '-', beginning in column 1.

Underline and strike through emphasis is not supported (yet?).

Plain text.

##Monospace markup##

//Italic markup//

**Bold markup**

**//Bold italic markup//**

//**Italic bold markup**//

----
Horizontal rule.

Plain text.

Monospace markup

Italic markup

Bold markup

Bold italic markup

Italic bold markup


Horizontal rule.


Punctuation

Markup Results Comment
Go...home Go…home …
Go--home Go–home –
Go---home Go—home —
Go----home Go—-home
Go~home Go home  
Go\~home Go~home "~"
Go~~home Go∼home ∼
Go(C)home Go©home ©
Go-->home Go→home →
Go<--home Go←home &larr;
Go(R)home Go®home &reg;
Go(TM)home Go™home &trade;
Go%%home Go‰home &permil;
Go``home Go“home &ldquo;
Go''home Go”home &rdquo;
Go,,home Go„home &bdquo;

Paragraph:

Adjoining lines are concatenated and
long lines are wrapped when rendered.
Adjoining sentences become paragraphs.

Adjoining lines are concatenated and long lines are wrapped when rendered. Adjoining sentences become paragraphs.

Force line breaks with\\two back slashes.

Force line breaks with
two back slashes.


Lists

List item lines begin with one or more '*', followed by white space and text for the item. Sub-lists are controlled by the number of '*', not indentation. Indents are optional before the initial '*', but not recommended. If used, two blanks per sub-level are recommended for consistency.

Multi-line list items aren't supported (yet?).

Bullet list:
* First item
* Second item
** Sub-item
*** Sub-sub-item
* Third item
  ** Sub-item (leading white space is ignored)
    *** Sub-sub-item (space improves readability)

Bullet list:

Numbered (ordered) lists have limited support, but only if Ben's patch is applied (as revealed by this example). Even with the patch, mixing unordered and ordered will scramble list rendering and worse, indentation of all subsequent text is shifted.

Ordered list:
# First item
# Second item
## Sub-item
### Sub-sub-item
# Third item
  ## Sub-item
    ### Sub-sub-item

Ordered list:

  1. First item
  2. Second item
    1. Sub-item
      1. Sub-sub-item
  3. Third item
    1. Sub-item
      1. Sub-sub-item

BROKEN (mixing ordered and unordered list items):

Mixed list 1:
* First item
* Second item
## Sub-item
*** Sub-sub-item
* Third item
  ** Sub-item
    *** Sub-sub-item

Mixed list 2:
# First item
# Second item
** Sub-item
### Sub-sub-item
# Third item
  ## Sub-item
    ### Sub-sub-item

Preformatted

    Lines that begin with white space
        are 'preformatted' (not joined),
    unless they are '* items' in lists.
    Lines that begin with white space
        are 'preformatted' (not joined),
    unless they are '* items' in lists.
> Joe: Block quote lines begin with one or more '>'.
>> Bob: When are they typically used?
>>> Joe: Conversation highlights mostly.

Joe: Block quote lines begin with one or more '>'.

Bob: When are they typically used?

Joe: Conversation highlights mostly.

Inline **text** within {{{triple braces}}} use //monospace// font.
All markup {{{**is** //ignored//}}} within the braces.

Inline text within triple braces use monospace font. All markup **is** //ignored// within the braces.

{{{
Blocks of text delimited by lines that begin and end
with triple braces are preformatted and monospace.

All markup **is** //ignored// within the block.
Note: this "} }}" is a kludge for "}}}".
} }}
Blocks of text delimited by lines that begin and end
with triple braces are preformatted and monospace.

All markup **is** //ignored// within the block.
Note: this "} }}" is a kludge for "}}}".
{{{#!text
Syntax highlighting can be requested with
the opening triple braces, i.e. "#!text".
Many languages and file formats are supported by
http://pygments.org/docs/lexers/#special-lexers
} }}


Syntax highlighting can be requested with
the opening triple braces, i.e. "#!text".
Many languages and file formats are supported by
http://pygments.org/docs/lexers/#special-lexers


{{{#!c
/* "Hello World" written in C */
#include <stdio.h>
int main(int argc, char[]* argv)
{ printf("Hello World\n"); return 0; }
} }}


/* "Hello World" written in C */
#include <stdio.h>
int main(int argc, char[]* argv)
{ printf("Hello World\n"); return 0; }

Links

Page names may be prefixed by a path, but only if Randy's docs tree patch is applied. Paths must be relative to the directory configured for 'docs'. They may not contain '..' components for security reasons.

Note: Putting symbolic links in Hatta's page directory may lead to unpredictable errors. Don't do that.

Link syntax:
* [[Markup2]]
* [[Markup2|Markup details]]
* [[Markup2#emphasis]]
* [[Markup2#emphasis|Markup emphasis]]
* [[path/filename.hat]]
* [[chapter_1/section_2#par3]]
* [[#test]]
* [[#test|On page link]]
* [[#5|[5] ]] Footnote reference
* http://sheep.art.pl
* [[http://sheep.art.pl]]
* [[http://sheep.art.pl|Sheep]]
* [[Home|{{development.png}}]]
* MarkupSummary (CamelCase enabled)

{{#5}} [5] Footnote anchor.

Link syntax:

[5] Footnote anchor.


Images

Three logo variations
{{development.png}}
{{development.png|Logo}}
[[http://hatta-wiki.org|{{development.png}}]]
rendered inline
----
Inline {{development.png}} logo.
----
**{{development.png}}** Left float logo using {{{**{{development.png}}**}}} (bold emphasis).
----
//{{development.png}}// Right float logo using {{{//{{development.png}}//}}} (italic emphasis).

Three logo variations development.png Logo development.png rendered inline.


development.png Left float logo using **{{development.png}}** (bold emphasis).


development.png Right float logo using //{{development.png}}// (italic emphasis).


Smiley images :) ;) :( :P :D can be inserted with :), ;), :(, :P and :D.


Tables

Don't use tables for layout!

Pending features (wish list?):

|Headers |=Column A|=Column B|=Column C|
|=Row 1  |Cell A1  |Cell B1  |Cell C1  |
|=Row 2  |Cell A2  |Cell B2  |
|=Row 3  |Cell A3  |Cell B3  |Cell C3  |
Headers Column AColumn BColumn C
Row 1 Cell A1 Cell B1 Cell C1
Row 2 Cell A2 Cell B2
Row 3 Cell A3 Cell B3 Cell C3
|=Line Hdr\\Break Hdr|=Column //A//|Italic //B//|=Column C|
|Row 1 |Bold **A1**|Italic //B1//|Cell C1|
|=Row 2|Line A2\\Break A2|  |Link [[#list|C2]]|
|=Row 3|{{{A3= Bar}}}    |Bold **B3**|
Line Hdr
Break Hdr
Column AItalic BColumn C
Row 1 Bold A1Italic B1Cell C1
Row 2Line A2
Break A2
Link C2
Row 3A3= Bar Bold B3

Math

See http://hatta-wiki.org/Math


Comment

Comments are not supported (yet?).


[1] Hatta support is weak or missing for a few features. The Usage and Recent Changes pages at http://hatta-wiki.org/ should be reviewed periodically, because more functionality is planned.