Aether reference manual

home | blog



Aether uses a simple markup language. Square brackets are used to tag parts of the text. For example:

What a [italic lovely] day for sitting indoors
reading [link slashdot [url http://slashdot.org]]. 

produces

What a lovely day for sitting indoors reading slashdot.

A tag may do as little as change the font, or as much as insert an entire blog into the text. If you know Python, you may add tags of your own.

The available tags are listed below.

[blog]

Insert a blog.

Optional parameters:
  author - Your name.
  email - Your email address.
  tagline - A short description of the blog.

  length - Number of entries to display on this page (default is 10).

  tail-length - Number of headings for older entries to display
                (default is 20).

  location - Path to blog entries (defaults to current page, which is
             what you want unless you're doing something weird).
  
  no-interface - (flag) no [new] box, atom feed, or older entries link
            (allows more than one blog per page, for example a
             separate blog in a sidebar. Suggest also setting up a
             distinct page for the sidebar to provide atom feed,
             archives, etc)

  keyword - Only show blog entries with this keyword.
            (note: keyword implies [no-interface], currently)

Also provides an Atom XML feed, which should be detected automatically
by news aggregators.

You will be able to create new blog entries using the [new ___]
item at the bottom of the page.

Examples:
   [title Joe blog]
   [blog
     [author Joe]
     [email joe@joe.joe]
     [tagline The life and times of Joe.]
   ]

[bold]

Bold text.

Example:
   Well, that was [bold startling]!

[bottom]

Specify text for the bottom of page. Options as per [left]. 
    
I suggest using [bottom] for copyright notices and disclaimers.

[bullet]

Bullet point.

Example:
   [bullet New nation]
   [bullet Civil war]
   [bullet Dedicate field]
   [bullet Dedicated to unfinished work]
   [bullet New birth of freedom]
   [bullet Government not perish]

[div]

Generic markup tag:
A div of text with different CSS style.

Example:
   [div I'm floating! [style float: right]]

[heading]

Heading.

Example:
   [heading Introduction]

[html]

Insert some HTML tags.
    
Example:
  [html <b>hello</b> ]

[image]

Insert an image.

Parameters as per [link].

[indent]

Indent text.

Example:
   Douglas Adams once wrote:
   
   [indent Anyone who is capable of getting themselves made President 
   should on no account be allowed to do the job.]

[italic]

Italic text.

Example:
   A [italic non-linear causal predictor] was used.

[keyword]

Associate a keyword with a page.

It is possible to create a blog that displays only blog entries
with certain keywords (see [blog]).

Example:
    [title My exciting holiday]
    [keyword hamster] [keyword bandages]

[left]

Specify text for left of page. 
    
By default, replaces any previously specified text,
use the flags [prepend] or [append] to override this.

I suggest using [left] as a menu bar for navigating your site.

Examples:
   [left Menu bar...]

   [left [append] See also in this site...]

   [left [prepend] Table of contents...]

[line]

Display text on separate line.

Example:
   One must consider:

   [line 1. What?]
   [line 2. Where?]
   [line 3. Why?]

[link]

Insert a link.
    
Examples:
   [link somepage]    
   (or [link [page somepage]] )
       - link to page called somepage

   [link This is the page. [page somepage]]    
       - link with text different to page name

   [link [file myfile.pdf]]
       - link to file attached to this page

   [link [page otherpage] [file otherfile.pdf]]
       - link to file attached to another page

   [link [url http://some.url.org]]
   (or [link http://some.url.org] )
       - link to a url

[mono]

Monospaced text. All formatting will be preserved.
    
Example:
   Here is some code to mark up [mono italic] text:
   
   [mono
      def markup_italic(text, meta):
          return u'<i>'+text+u'</i>'
   ]

[right]

Specify text for right of page. Options as per [left]. 
    
I suggest using [right] for footnotes and links to
related external links of your site.

[rule]

Draw a horizontal line.

Example:
   [rule]

[sans]

Sans-serif text.

Example:
   [sans [link Home [page home]]]

[search-form]

Insert a simple search form.
    
Example:
    [bottom [search-form]]

[small]

Smaller font size.

Example:
   [right [small It's an interesting fact that in... ]]

[span]

Generic markup tag:
A span of text with different CSS style.

Example:
   [span I'm huge! [style font-size: 300%]]

[style]

Add to the HTML style sheet.

Example:
    [style
      body { background: #88f }
    ]

[subheading]

Sub-heading.

Example:
   [subheading Implementation details]

[summary]

Mark a range of text as a summary or abstract. When used in a blog
entry, only the summary will appear on the main blog page. This tag
does not affect the appearance of the actual page.

Example:
   [summary Python is a remarkable language.]

   It has a number of useful features.

[title]

Specify the title of the page.

Example:
   [title Home]

[toc]

Table of contents.

List all [heading]s.

[top]

Specify text for top of page. Options as per [left].



[æ]