Copy Page

Select a page template to start from.

<p><b>Macros</b> provide the page editor with a rich set of page formatting and automation possibilities.</p>
<p user="true" style="display:none"/>
<p>The full set of macros available to this wiki are in the <a href="/display/faiWikiDocumentation/wiki+notation"
 title="wiki notation"linktype="raw" wikidestination="wiki notation" aliasspecified="true" ><b>notation guide</b></a> in this space or as a <span class="nobr"><a href="http://wiki.fai.org/renderer/notationhelp.action"
 class="external-link" rel="nofollow"linktype="raw" wikidestination="http://wiki.fai.org/renderer/notationhelp.action" aliasspecified="true" >standalone page<sup><img class="rendericon" src="/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span>.</p>
<p user="true" style="display:none"/>
<h4><a name="faiWikiDocumentation-Simpleformatting"></a>Simple formatting</h4>
<p user="true" style="display:none"/>
<p>Simple formatting is things like <b>bold</b> or <em>italic</em> text, <a href="/display/faiWikiDocumentation/Macros"
 title="Macros"linktype="raw" wikidestination="macros" aliasspecified="true" >hyperlinks</a>, bulleted and ordered lists, tables Etc. It's all in the <a href="/display/faiWikiDocumentation/wiki+notation"
 title="wiki notation"linktype="raw" wikidestination="wiki notation" aliasspecified="true" ><b>notation guide</b></a>.</p>
<p user="true" style="display:none"/>
<p>When you are editing a page you have two options, to do it in the <b>Rich text editor</b> or the <b>Wiki markup editor</b>. You can freely switch between the two as you are editing a page, and see final result of either in the <b>preview</b> 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.</p>
<p user="true" style="display:none"/>
<p>Complex objects like tables are often much easier to construct in the Rich text editor whereas it is often faster to construct simple objects like hyperlinks in the wiki markup editor.</p>
<p user="true" style="display:none"/>
<h4><a name="faiWikiDocumentation-Formattingmacros"></a>Formatting macros</h4>
<p user="true" style="display:none"/>
<p>Macros are surrounded by curly braces </p>
<p user="true" style="display:none"/>
<div class="wysiwyg-macro" macroname="code" macrostarttag="{code}" macrohasbody="true" wikihasnewlinebeforebody="false" wikihasnewlineafterbody="false" wikihasprecedingnewline="true" wikihastrailingnewline="true" ><div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">{macro code goes here}</pre>
</div></div></div><p user="true" style="display:none"/>
<p>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:</p>
<p user="true" style="display:none"/>
<div class="wysiwyg-macro" macroname="code" macrostarttag="{code}" macrohasbody="true" wikihasnewlinebeforebody="false" wikihasnewlineafterbody="false" wikihasprecedingnewline="true" wikihastrailingnewline="true" ><div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">{info:title=Be Careful}
This macro is useful <span class="code-keyword">for</span> including helpful information in your wiki pages
{info} </pre>
</div></div></div><p user="true" style="display:none"/>
<p>and looks like this in the rendered page</p>
<p user="true" style="display:none"/>
<div class="wysiwyg-macro" macroname="info" macrohasbody="true" wikihasprecedingnewline="true" wikihastrailingnewline="true" ><div class="wysiwyg-macro-tag wysiwyg-macro-starttag">{info:title=Be Careful}</div><br class="wysiwyg-macro-body-newline"/><div class="wysiwyg-macro-body"><p>This macro is useful for including helpful information in your wiki pages</p></div><br class="wysiwyg-macro-body-newline"/><div class="wysiwyg-macro-tag wysiwyg-macro-endtag">{info}</div></div><p>or you could make two columns in your page with this:</p>
<p user="true" style="display:none"/>
<div class="wysiwyg-macro" macroname="code" macrostarttag="{code}" macrohasbody="true" wikihasnewlinebeforebody="false" wikihasnewlineafterbody="true" wikihasprecedingnewline="true" wikihastrailingnewline="true" ><div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">{section:border=<span class="code-keyword">true</span>}
{column:width=30%}
Column one text goes here
{column}
{column:width=70%}
Column two text goes here
{column}
{section}
</pre>
</div></div></div><p user="true" style="display:none"/>
<p>which looks like this:</p>
<p user="true" style="display:none"/>
<div class="wysiwyg-macro" macroname="section" macrohasbody="true" wikihasprecedingnewline="true" wikihastrailingnewline="true" ><div class="wysiwyg-macro-tag wysiwyg-macro-starttag">{section:border=true}</div><br class="wysiwyg-macro-body-newline"/><div class="wysiwyg-macro-body"><div class="wysiwyg-macro" macroname="column" macrohasbody="true" wikihasprecedingnewline="false" wikihastrailingnewline="true" ><div class="wysiwyg-macro-tag wysiwyg-macro-starttag">{column:width=30%}</div><br class="wysiwyg-macro-body-newline"/><div class="wysiwyg-macro-body"><p>Column one text goes here</p></div><br class="wysiwyg-macro-body-newline"/><div class="wysiwyg-macro-tag wysiwyg-macro-endtag">{column}</div></div><p class="atl_conf_pad"> </p>
<div class="wysiwyg-macro" macroname="column" macrohasbody="true" wikihasprecedingnewline="true" wikihastrailingnewline="false" ><div class="wysiwyg-macro-tag wysiwyg-macro-starttag">{column:width=70%}</div><br class="wysiwyg-macro-body-newline"/><div class="wysiwyg-macro-body"><p>Column two text goes here</p></div><br class="wysiwyg-macro-body-newline"/><div class="wysiwyg-macro-tag wysiwyg-macro-endtag">{column}</div></div><p class="atl_conf_pad"> </p></div><br class="wysiwyg-macro-body-newline"/><div class="wysiwyg-macro-tag wysiwyg-macro-endtag">{section}</div></div><p user="true" style="display:none"/>
<h4><a name="faiWikiDocumentation-Automationmacros"></a>Automation macros</h4>
<p user="true" style="display:none"/>
<p>Automation macros are also surrounded by curly braces</p>
<p user="true" style="display:none"/>
<div class="wysiwyg-macro" macroname="code" macrostarttag="{code}" macrohasbody="true" wikihasnewlinebeforebody="false" wikihasnewlineafterbody="false" wikihasprecedingnewline="true" wikihastrailingnewline="true" ><div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">{toc:style=disc|indent=20px}</pre>
</div></div></div><p user="true" style="display:none"/>
<p>Provides a table of contents of the current page like this:</p>
<p user="true" style="display:none"/>
<div class="wysiwyg-macro" macroname="toc" macrohasbody="false" wikihasprecedingnewline="true" wikihastrailingnewline="true" ><div class="wysiwyg-macro-tag wysiwyg-macro-starttag">{toc:style=disc|indent=20px}</div></div><p class="atl_conf_pad"> </p>

*Macros* provide 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*|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*|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.

Complex objects like tables are often much easier to construct in the Rich text editor whereas it is often faster to construct simple objects like hyperlinks in the wiki markup editor.

h4. Formatting macros

Macros are surrounded by curly braces

{code}{macro code goes here}{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}

Location: FAI wiki documentation Edit

Labels: Edit

Examples

Description

Help Tips