<?xml version="1.0" encoding="utf-8"?><!DOCTYPE article  PUBLIC '-//OASIS//DTD DocBook XML V4.4//EN'  'http://www.docbook.org/xml/4.4/docbookx.dtd'><article><articleinfo><title>HelpOnFormatting</title><revhistory><revision><revnumber>1</revnumber><date>2021-04-08 10:46:02</date><authorinitials>independence</authorinitials></revision></revhistory></articleinfo><para><ulink url="http://ipv6.blinkenshell.org/wiki/HelpOnFormatting/wiki/HelpForUsers#">HelpForUsers</ulink> &gt; <ulink url="http://ipv6.blinkenshell.org/wiki/HelpOnFormatting/wiki/HelpOnEditing#">HelpOnEditing</ulink> &gt; HelpOnFormatting </para><para>This page describes using the <ulink url="http://ipv6.blinkenshell.org/wiki/HelpOnFormatting/wiki/MoinMoin#">MoinMoin</ulink> wiki syntax (which is the default syntax for a <ulink url="http://ipv6.blinkenshell.org/wiki/HelpOnFormatting/wiki/MoinMoin#">MoinMoin</ulink> based wiki, but not the only one). For other parsers/syntaxes take a look at <ulink url="http://ipv6.blinkenshell.org/wiki/HelpOnFormatting/wiki/HelpOnParsers#">HelpOnParsers</ulink>. </para><section><title>General</title><itemizedlist><listitem><para>Use one or more blank lines to separate paragraphs. </para></listitem><listitem><para>Use <code>&lt;&lt;BR&gt;&gt;</code> <ulink url="http://ipv6.blinkenshell.org/wiki/HelpOnFormatting/wiki/HelpOnMacros#">macro</ulink> to insert linebreaks into paragraphs. </para></listitem></itemizedlist></section><section><title>Typeface</title><informaltable><tgroup cols="3"><colspec colname="col_0"/><colspec colname="col_1"/><colspec colname="col_2"/><tbody><row rowsep="1"><entry colsep="1" rowsep="1"><para><emphasis role="strong"> Name/Sample</emphasis> </para></entry><entry colsep="1" rowsep="1"><para> <emphasis role="strong"> Markup </emphasis>   </para></entry><entry colsep="1" rowsep="1"><para> <emphasis role="strong"> Notes </emphasis>          </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>  <emphasis>italic</emphasis>     </para></entry><entry colsep="1" rowsep="1"><para> <code>''italic''</code>       </para></entry><entry colsep="1" rowsep="1"><para> Double single quotes.  </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>  <emphasis role="strong">bold</emphasis>     </para></entry><entry colsep="1" rowsep="1"><para> <code>'''bold'''</code>       </para></entry><entry colsep="1" rowsep="1"><para> Triple single quotes.  </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>  <code>monospace</code>    </para></entry><entry colsep="1" rowsep="1"><para> <code>`monospace`</code>  </para></entry><entry colsep="1" rowsep="1"><para> Single backticks.  Wiki markup is ignored.   </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>  <code>code</code>     </para></entry><entry colsep="1" rowsep="1"><para> <code>{{{code}}}</code>       </para></entry><entry colsep="1" rowsep="1"><para> <link linkend="codeexample">Example.</link>  Wiki markup is ignored. </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>  <emphasis role="underline">underline</emphasis>  </para></entry><entry colsep="1" rowsep="1"><para> <code>__underline__</code>    </para></entry><entry colsep="1" rowsep="1"/></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>  <superscript>super</superscript>script  </para></entry><entry colsep="1" rowsep="1"><para> <code>^super^script</code>    </para></entry><entry colsep="1" rowsep="1"/></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>  <subscript>sub</subscript>script  </para></entry><entry colsep="1" rowsep="1"><para> <code>,,sub,,script</code>    </para></entry><entry colsep="1" rowsep="1"/></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>  <!--"~-smaller-~" is not applicable to DocBook-->smaller    </para></entry><entry colsep="1" rowsep="1"><para> <code>~-smaller-~</code>      </para></entry><entry colsep="1" rowsep="1"/></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>  <!--"~+bigger+~" is not applicable to DocBook-->larger     </para></entry><entry colsep="1" rowsep="1"><para> <code>~+larger+~</code>       </para></entry><entry colsep="1" rowsep="1"/></row><row rowsep="1"><entry colsep="1" rowsep="1"><para> <emphasis role="strikethrough">stroke</emphasis>    </para></entry><entry colsep="1" rowsep="1"><para> <code>--(stroke)--</code>     </para></entry><entry colsep="1" rowsep="1"/></row></tbody></tgroup></informaltable></section><section><title>Colorize text</title><para>Colorizing is enabled in tables without additional macros (see <ulink url="http://ipv6.blinkenshell.org/wiki/HelpOnFormatting/wiki/HelpOnTables#">HelpOnTables</ulink>).  </para></section><section><title>Colorize code (Syntax Highlighting)</title><para>There are several ways to highlight code: </para><orderedlist numeration="arabic"><listitem><para>Start a special code block containing the parser's name: <code>{{{#!parsername</code> </para></listitem><listitem><para>Embed a file attachment bearing a supported extension (such as <code>&quot;.py&quot;</code>) with <code>{{attachment:test.py}}</code> </para></listitem><listitem><para>Begin a page with the <ulink url="http://ipv6.blinkenshell.org/wiki/HelpOnFormatting/wiki/HelpOnProcessingInstructions#">format processing instruction</ulink>: <code>#format parsername</code> </para></listitem></orderedlist><para><link linkend="SyntaxHighlighting">Example.</link> </para><para>MoinMoin comes with a special parser called <ulink url="http://ipv6.blinkenshell.org/wiki/HelpOnFormatting/wiki/HelpOnParsers#The_highlight_parser">highlight</ulink> that is based on <ulink url="http://pygments.org/">Pygments</ulink> internally. </para><para>You can use it to highlight many sorts of programming source code, configuration files and other sorts of text files used on computers. </para><!--rule (<hr>) is not applicable to DocBook--></section><section><title>Examples</title><section><title>Mixing ''italic'' and '''bold'''</title><para><anchor id="italic_bold_example"/> </para><informaltable><tgroup cols="2"><colspec colname="col_0"/><colspec colname="col_1"/><tbody><row rowsep="1"><entry colsep="1" rowsep="1"><para> <emphasis role="strong">Markup</emphasis> </para></entry><entry colsep="1" rowsep="1"><para> <emphasis role="strong">Result</emphasis>                    </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para> <code>'''''Mix''' at the beginning''</code>   </para></entry><entry colsep="1" rowsep="1"><para>  <emphasis><emphasis role="strong">Mix</emphasis> at the beginning</emphasis>  </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para> <code>'''''Mix'' at the beginning'''</code>   </para></entry><entry colsep="1" rowsep="1"><para>  <emphasis role="strong"><emphasis>Mix</emphasis> at the beginning</emphasis>  </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para> <code>'''Mix at the ''end'''''</code>         </para></entry><entry colsep="1" rowsep="1"><para>  <emphasis role="strong">Mix at the <emphasis>end</emphasis></emphasis>        </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para> <code>''Mix at the '''end'''''</code>         </para></entry><entry colsep="1" rowsep="1"><para>  <emphasis>Mix at the <emphasis role="strong">end</emphasis></emphasis>        </para></entry></row></tbody></tgroup></informaltable></section><section><title>Superscript &amp; Subscript</title><screen><![CDATA[You might recall ''a''^2^ `+` ''b''^2^ `=` ''c''^2^ from your math lessons, unless your head is filled with H,,2,,O.]]></screen><para>Result: </para><para>You might recall <emphasis>a</emphasis><superscript>2</superscript> <code>+</code> <emphasis>b</emphasis><superscript>2</superscript> <code>=</code> <emphasis>c</emphasis><superscript>2</superscript> from your math lessons, unless your head is filled with H<subscript>2</subscript>O. </para><para><anchor id="codeexample"/> </para></section><section><title>Code</title><para>Markup: </para><screen><![CDATA[{{{
10 PRINT "Hello, world!"
20 GOTO 10
}}}]]></screen><para>Result: </para><screen><![CDATA[10 PRINT "Hello, world!"
20 GOTO 10]]></screen><section><title>Nesting curly braces</title><para>As pointed out on <ulink url="http://ipv6.blinkenshell.org/wiki/HelpOnFormatting/wiki/HelpOnParsers#">HelpOnParsers</ulink>, you can nest multiple levels of curly braces: </para><para>Markup: </para><screen><![CDATA[{{{{ 
This is a preformatted text block.
{{{ with curly braces inside }}}
}}}}]]></screen><para>Result: </para><screen><![CDATA[This is a preformatted text block.
{{{ with curly braces inside }}}]]></screen><para><anchor id="SyntaxHighlighting"/> </para></section><section><title>Colorized Code</title><para>Markup: </para><screen><![CDATA[{{{#!highlight python
from colors import palette
palette.colorize('python')
}}}]]></screen><para>Result: </para><programlisting format="linespecific" language="python" linenumbering="numbered" startinglinenumber="1"><token><![CDATA[from]]></token><![CDATA[ ]]><methodname><![CDATA[colors]]></methodname><![CDATA[ ]]><token><![CDATA[import]]></token><![CDATA[ ]]><methodname><![CDATA[palette]]></methodname>
<methodname><![CDATA[palette]]></methodname><![CDATA[.]]><methodname><![CDATA[colorize]]></methodname><![CDATA[(]]><phrase><![CDATA[']]></phrase><phrase><![CDATA[python]]></phrase><phrase><![CDATA[']]></phrase><![CDATA[)]]>
</programlisting></section></section></section></article>