Access Keys:
Skip to content (Access Key - 0)
All Documentation spaces

Documentation

This space

Macros

compared with
Current by Richard Meredith-Hardy
on 07 Apr, 2010 18:43.

Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (15)

View page history
*Macros* provide a the page editor with a rich set of page formatting and automation possibilities.

The full set of macros available to this wiki are in the [*notation guide*|http://wiki.fai.org/renderer/notationhelp.action]. guide*|wiki notation] in this space or as a [standalone page|http://wiki.fai.org/renderer/notationhelp.action].

h4. Simple formatting

Simple formatting is things like *bold* or _italic_ text, [hyperlinks|macros], bulleted and ordered lists, tables Etc. It's all in the [*notation guide*|http://wiki.fai.org/renderer/notationhelp.action]. guide*|wiki notation].

When you are editing a page you have two options, to do it in the *Rich text editor* or the *Wiki markup editor*. You can freely switch between the two as you are editing a page, and see final result of either in the *preview* page. Probably the easiest way to learn simple wiki formatting markup is to do it in the WYSIWYG Rich text editor and then switch to the Wiki markup editor to see what the Rich text editor has done.
h4. Formatting macros

Macros are surrounded by curly braces

A formatting macro could be something like a code box which displays example wiki markup and formats it in a nice box:
{code}{macro code goes here}{code}

{code}/{code/}This code box is created within two code statements like this/{code/}{code}
Formatting macro codes are usually in pairs surrounding the text you want to format. An info box displays example wiki markup and formats it in a nice box:

{code}{info:title=Be Careful}
This macro is useful for including helpful information in your wiki pages
{info} {code}

and looks like this in the rendered page

{info:title=Be Careful}
This macro is useful for including helpful information in your wiki pages
{info}
or you could make two columns in your page with this:

{code}{section:border=true}
{column:width=30%}
Column one text goes here
{column}
{column:width=70%}
Column two text goes here
{column}
{section}
{code}

which looks like this:

{section:border=true}
{column:width=30%}
Column one text goes here
{column}
{column:width=70%}
Column two text goes here
{column}
{section}

h4. Automation macros

Automation macros are also surrounded by curly braces

{code}{toc:style=disc|indent=20px}{code}

Provides a table of contents of the current page like this:

{toc:style=disc|indent=20px}

Adaptavist Theme Builder Powered by Atlassian Confluence