WiXi Markup Guide

This page will slowly become the home of the markup reference, as I find time to write it.

Headers

All pages must begin with a header:
== Welcome to My Page

Hello World.
The basic header begins with == and continues until the end of the line. For sub-headers, any number of = can be appended, e.g:
== Title

=== Sub-section

==== sub-sub-section

==== sub-sub-section

=== Sub-section

Table of Contents

A table of contents can be generated automatically out of the headers on a page by using the \toc directive. E.g:
== MyPage

\toc

Welcome to my page!

Links

Local

To link to another page on the site, use the arrow-star syntax:
Elephants are an example of a mammal->*.
Gives: Elephants are an example of a mammal, where the word mammal links to the page mammal.html. Multiple-word links can be created by enclosing the words in braces:
Elephants are {really cool}->*
Gives: Elephants are really cool, and will link to the page really_cool.html. TODO: Underline may not be included yet.

External

For more general links, replace the star with the destination:
Google->http://www.google.com/, is a search engine.
Gives: Google, is a search engine.

Lists

makes it easy to create unordered and ordered lists of either single or double spacing.

Unordered

In real-estate, what matters is:

* Location.
* Location.
* Location.
Gives: In real-estate, what matters is:
Double spaced lists can be made by putting an extra newline after each point, and long lines can be wrapped and indented to become part of the list. E.g:
* It's pretty.

* \WiXi, thanks to Adam Megacz's WIX, has a formal grammar, meaning that
  its behaviour is fully specified and it is easy to extend.

* The grammar is presentation neutral, meaning it is easy to write renderers
  for all sorts of crazy formats. Expect a PDF renderer soon.
Gives:

Ordered

Ordered lists are exactly link unordered lists, only you use numbers instead of stars.
1. First One
2. Now Two
3. This is three
Gives:
  1. First One
  2. Now Two
  3. This is three
You don't have to get your numbering perfect, will work out what you mean:
1. First
1. Inserted later, too lazy to renumber
2. Second
3. Third
Gives:
  1. First
  2. Inserted later, too lazy to renumber
  3. Second
  4. Third
In fact, to save confusion you may just want to always use the number 1 when making lists:
1. First
1. Second
1. Third
Gives:
  1. First
  2. Second
  3. Third