diff options
Diffstat (limited to 'TWiki/TextFormattingRules.mdwn')
| -rw-r--r-- | TWiki/TextFormattingRules.mdwn | 338 |
1 files changed, 172 insertions, 166 deletions
diff --git a/TWiki/TextFormattingRules.mdwn b/TWiki/TextFormattingRules.mdwn index 906d5e4a..bc65758a 100644 --- a/TWiki/TextFormattingRules.mdwn +++ b/TWiki/TextFormattingRules.mdwn @@ -2,82 +2,85 @@ ## <a name="Editing"> Editing </a> -<table bgcolor="#ffffff" border="1" cellpadding="3" cellspacing="1"> +<table bgcolor="#000000" border="0" cellpadding="0" cellspacing="1"> <tr> - <td><strong>Formatting Command:</strong></td> - <td><strong>Example: You write:</strong></td> - <td><strong>You get:</strong></td> - </tr> - <tr> - <td valign="top"><strong>Paragraphs:</strong><br /> Blank lines will create new paragraphs. </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td> + <table bgcolor="#ffffff" border="0" cellpadding="3" cellspacing="0"> + <tr> + <td><strong>Formatting Command:</strong></td> + <td><strong>Example: You write:</strong></td> + <td><strong>You get:</strong></td> + </tr> + <tr> + <td valign="top"><strong>Paragraphs:</strong><br /> Blank lines will create new paragraphs. </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> 1st paragraph 2nd paragraph </pre> </font></span></td> - <td valign="top"> 1st paragraph <p> 2nd paragraph </p> - </td> - </tr> - <tr> - <td valign="top"><strong>Headings:</strong><br /> At least three dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a level 1 heading (most important), two pluses a level 2 heading; the maximum is level 6. <strong><em>Note:</em></strong> A Table of Content can be created automatically with the <code>%<nop>TOC%</nop></code> variable, see <span style="background:"><font color="">TWiki Variables</font></span><a href="http://LOCATION/TWikiVariables">?</a>. </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td valign="top"> 1st paragraph <p> 2nd paragraph </p> + </td> + </tr> + <tr> + <td valign="top"><strong>Headings:</strong><br /> At least three dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a level 1 heading (most important), two pluses a level 2 heading; the maximum is level 6. <strong><em>Note:</em></strong> A Table of Content can be created automatically with the <code>%<nop>TOC%</nop></code> variable, see <span style="background:"><font color="">TWiki Variables</font></span><a href="http://LOCATION/TWikiVariables">?</a>. </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> <nop>---++ Sushi <nop>---+++ Maguro </nop></nop></pre> </font></span></td> - <td valign="top"> - <h2>Sushi</h2> - <p> - </p> - <h3>Maguro</h3> - </td> - </tr> - <tr> - <td valign="top"><strong>Bold Text:</strong><br /> Words get <strong>bold</strong> by enclosing them in <code>*</code> asterisks. </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td valign="top"> + <h2>Sushi</h2> + <p> + </p> + <h3>Maguro</h3> + </td> + </tr> + <tr> + <td valign="top"><strong>Bold Text:</strong><br /> Words get <strong>bold</strong> by enclosing them in <code>*</code> asterisks. </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> *Bold* </pre> </font></span></td> - <td valign="top"><strong>Bold</strong></td> - </tr> - <tr> - <td valign="top"><strong>Italic Text:</strong><br /> Words get <em>italic</em> by enclosing them in <code>_</code> underscores. </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td valign="top"><strong>Bold</strong></td> + </tr> + <tr> + <td valign="top"><strong>Italic Text:</strong><br /> Words get <em>italic</em> by enclosing them in <code>_</code> underscores. </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> _Italic_ </pre> </font></span></td> - <td valign="top"><em>Italic</em></td> - </tr> - <tr> - <td valign="top"><strong>Bold Italic:</strong><br /> Words get <em>_bold italic</em> by enclosing them in <code>_</code> double-underscores. </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td valign="top"><em>Italic</em></td> + </tr> + <tr> + <td valign="top"><strong>Bold Italic:</strong><br /> Words get <em>_bold italic</em> by enclosing them in <code>_</code> double-underscores. </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> __Bold italic__ </pre> </font></span></td> - <td valign="top"><strong><em>Bold italic</em></strong></td> - </tr> - <tr> - <td valign="top"><strong>Fixed Font:</strong><br /> Words get shown in <code>fixed font</code> by enclosing them in <code><nop>=<nop></nop></nop></code> equal signs. </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td valign="top"><strong><em>Bold italic</em></strong></td> + </tr> + <tr> + <td valign="top"><strong>Fixed Font:</strong><br /> Words get shown in <code>fixed font</code> by enclosing them in <code><nop>=<nop></nop></nop></code> equal signs. </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> =Fixed font= </pre> </font></span></td> - <td valign="top"><code>Fixed font</code></td> - </tr> - <tr> - <td valign="top"><strong>Bold Fixed Font:</strong><br /> Words get shown in <code><b>bold fixed font</b></code> by enclosing them in <code><b><nop></nop></b></code> double equal signs. </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td valign="top"><code>Fixed font</code></td> + </tr> + <tr> + <td valign="top"><strong>Bold Fixed Font:</strong><br /> Words get shown in <code><b>bold fixed font</b></code> by enclosing them in <code><b><nop></nop></b></code> double equal signs. </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> ==Bold fixed== </pre> </font></span></td> - <td valign="top"><code><b>Bold fixed</b></code></td> - </tr> - <tr> - <td valign="top"><strong><em>Note:</em></strong> Make sure to "stick" the <code>* _ = <nop>==<nop></nop></nop></code> signs to the words, e.g. take away spaces. </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td valign="top"><code><b>Bold fixed</b></code></td> + </tr> + <tr> + <td valign="top"><strong><em>Note:</em></strong> Make sure to "stick" the <code>* _ = <nop>==<nop></nop></nop></code> signs to the words, e.g. take away spaces. </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> _This works_, _this not _ </pre> </font></span></td> - <td valign="top"><em>This works</em>, _this not _ </td> - </tr> - <tr> - <td valign="top"><strong>Verbatim Mode:</strong><br /> Surround code excerpts and other formatted text with <code>&lt;verbatim&gt;</code> and <code>&lt;/verbatim&gt;</code> tags. <br /><strong><em>Note:</em></strong> Use <code>&lt;pre&gt;</code> and <code>&lt;/pre&gt;</code> tags instead if you want that HTML code is interpreted. <br /><strong><em>Note:</em></strong> Each tag must be on a line by itself. </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td valign="top"><em>This works</em>, _this not _ </td> + </tr> + <tr> + <td valign="top"><strong>Verbatim Mode:</strong><br /> Surround code excerpts and other formatted text with <code>&lt;verbatim&gt;</code> and <code>&lt;/verbatim&gt;</code> tags. <br /><strong><em>Note:</em></strong> Use <code>&lt;pre&gt;</code> and <code>&lt;/pre&gt;</code> tags instead if you want that HTML code is interpreted. <br /><strong><em>Note:</em></strong> Each tag must be on a line by itself. </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> &lt;verbatim&gt; class CatAnimal { void purr() { @@ -86,81 +89,81 @@ class CatAnimal { } &lt;/verbatim&gt; </pre> </font></span></td> - <td valign="top"><pre> + <td valign="top"><pre> class CatAnimal { void purr() { &lt;code here&gt; } } </pre></td> - </tr> - <tr> - <td valign="top"><strong>Separator:</strong><br /> At least three dashes at the beginning of a line. </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + </tr> + <tr> + <td valign="top"><strong>Separator:</strong><br /> At least three dashes at the beginning of a line. </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> ------- </pre> </font></span></td> - <td valign="top"> - <hr /> - </td> - </tr> - <tr> - <td valign="top"><strong>List Item:</strong><br /> Three spaces and an asterisk. </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td valign="top"> + <hr /> + </td> + </tr> + <tr> + <td valign="top"><strong>List Item:</strong><br /> Three spaces and an asterisk. </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> * bullet item </pre> </font></span></td> - <td valign="top"> - <ul> - <li> bullet item </li> - </ul> - </td> - </tr> - <tr> - <td valign="top"><strong>Nested List Item:</strong><br /> Six, nine, ... spaces and an asterisk. </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td valign="top"> + <ul> + <li> bullet item </li> + </ul> + </td> + </tr> + <tr> + <td valign="top"><strong>Nested List Item:</strong><br /> Six, nine, ... spaces and an asterisk. </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> * nested stuff </pre> </font></span></td> - <td valign="top"> - <ul> - <li> - <ul> - <li> nested stuff </li> - </ul> - </li> - </ul> - </td> - </tr> - <tr> - <td valign="top"><strong>Ordered List:</strong><br /> Three spaces and a number. </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td valign="top"> + <ul> + <li> + <ul> + <li> nested stuff </li> + </ul> + </li> + </ul> + </td> + </tr> + <tr> + <td valign="top"><strong>Ordered List:</strong><br /> Three spaces and a number. </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> 1 Sushi 1 Dim Sum </pre> </font></span></td> - <td valign="top"> - <ol> - <li> Sushi </li> - <li> Dim Sum </li> - </ol> - </td> - </tr> - <tr> - <td valign="top"><strong>Definition List:</strong><br /> Three spaces, the term, a colon, a space, followed by the definition. <br /><strong><em>Note:</em></strong> Terms with spaces are not supported. In case you do have a term with more then one word, separate the words with dashes or with the <code>&amp;nbsp;</code> non-breaking-space entity. </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td valign="top"> + <ol> + <li> Sushi </li> + <li> Dim Sum </li> + </ol> + </td> + </tr> + <tr> + <td valign="top"><strong>Definition List:</strong><br /> Three spaces, the term, a colon, a space, followed by the definition. <br /><strong><em>Note:</em></strong> Terms with spaces are not supported. In case you do have a term with more then one word, separate the words with dashes or with the <code>&amp;nbsp;</code> non-breaking-space entity. </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> Sushi: Japan Dim&amp;nbsp;Sum: S.F. </pre> </font></span></td> - <td valign="top"> - <dl> - <dt> Sushi</dt> - <dd> Japan </dd> - <dt> Dim Sum</dt> - <dd> S.F. </dd> - </dl> - </td> - </tr> - <tr> - <td valign="top"><strong>Table:</strong><br /> Optional spaces followed by the cells enclosed in vertical bars. <br /><strong><em>Note:</em></strong> <code>| <nop>*bold*<nop> |</nop></nop></code> cells are rendered as table headers. <br /><strong><em>Note:</em></strong> <code>| spaced |</code> cells are rendered center aligned. <br /><strong><em>Note:</em></strong> <code>| spaced |</code> cells are rendered right aligned. <br /><strong><em>Note:</em></strong> <code>| 2 colspan ||</code> cells are rendered as multi-span columns. <br /><strong><em>Note:</em></strong> In case you have a long row and you want it to be more readable when you edit the table you can split the row into lines that end with a <code>'\'</code> backslash character. <br /> - </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td valign="top"> + <dl> + <dt> Sushi</dt> + <dd> Japan </dd> + <dt> Dim Sum</dt> + <dd> S.F. </dd> + </dl> + </td> + </tr> + <tr> + <td valign="top"><strong>Table:</strong><br /> Optional spaces followed by the cells enclosed in vertical bars. <br /><strong><em>Note:</em></strong> <code>| <nop>*bold*<nop> |</nop></nop></code> cells are rendered as table headers. <br /><strong><em>Note:</em></strong> <code>| spaced |</code> cells are rendered center aligned. <br /><strong><em>Note:</em></strong> <code>| spaced |</code> cells are rendered right aligned. <br /><strong><em>Note:</em></strong> <code>| 2 colspan ||</code> cells are rendered as multi-span columns. <br /><strong><em>Note:</em></strong> In case you have a long row and you want it to be more readable when you edit the table you can split the row into lines that end with a <code>'\'</code> backslash character. <br /> + </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> | *L* | *C* | *R* | | A2 | 2 | 2 | | A3 | 3 | 3 | @@ -169,83 +172,86 @@ class CatAnimal { | next \<nop> | next | </nop></nop></pre> </font></span></td> - <td valign="top"> - <table border="1" cellpadding="1" cellspacing="0"> - <tr> - <th bgcolor="#99CCCC"><strong>L</strong></th> - <th bgcolor="#99CCCC"><strong>C</strong></th> - <th bgcolor="#99CCCC"><strong>R</strong></th> - </tr> - <tr> - <td> A2 </td> - <td align="center"> 2 </td> - <td align="right"> 2 </td> + <td valign="top"> + <table border="1" cellpadding="1" cellspacing="0"> + <tr> + <th bgcolor="#99CCCC"><strong>L</strong></th> + <th bgcolor="#99CCCC"><strong>C</strong></th> + <th bgcolor="#99CCCC"><strong>R</strong></th> + </tr> + <tr> + <td> A2 </td> + <td align="center"> 2 </td> + <td align="right"> 2 </td> + </tr> + <tr> + <td> A3 </td> + <td align="center"> 3 </td> + <td align="right"> 3 </td> + </tr> + <tr> + <td colspan="3"> multi span </td> + </tr> + <tr> + <td> A4 </td> + <td> next </td> + <td> next </td> + </tr> + </table> + </td> </tr> <tr> - <td> A3 </td> - <td align="center"> 3 </td> - <td align="right"> 3 </td> - </tr> - <tr> - <td colspan="3"> multi span </td> - </tr> - <tr> - <td> A4 </td> - <td> next </td> - <td> next </td> - </tr> - </table> - </td> - </tr> - <tr> - <td valign="top"><strong><nop>WikiWord Links:</nop></strong><br /><nop>CapitalizedWordsStuckTogether (or <span style="background:"><font color="">Wiki Words</font></span><a href="http://LOCATION/WikiWords">?</a>) will produce a link automatically. <br /><strong><em>Note:</em></strong> In case you want to link to a topic in a different %WIKITOOLNAME% web write <code>Webname.TopicName</code>. </nop></td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td valign="top"><strong><nop>WikiWord Links:</nop></strong><br /><nop>CapitalizedWordsStuckTogether (or <span style="background:"><font color="">Wiki Words</font></span><a href="http://LOCATION/WikiWords">?</a>) will produce a link automatically. <br /><strong><em>Note:</em></strong> In case you want to link to a topic in a different %WIKITOOLNAME% web write <code>Webname.TopicName</code>. </nop></td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> WebNotify Know.ReadmeFirst </pre> </font></span></td> - <td valign="top"><span style="background:"><font color="">Web Notify</font></span><a href="http://LOCATION/WebNotify">?</a><p><span style="background:"><font color="">Readme First</font></span><a href="http://LOCATIONKnow/ReadmeFirst">?</a></p> - </td> - </tr> - <tr> - <td valign="top"><strong>Forced Links:</strong><br /> You can create a forced internal link by enclosing words in double square brackets. <br /><strong><em>Note:</em></strong> Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; i.e. <code>[<nop>[text formatting FAQ]]</nop></code> links to topic <span style="background:"><font color="">Text Formatting FAQ</font></span><a href="http://LOCATION/TextFormattingFAQ">?</a>. You can also refer to a different web and use anchors. </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td valign="top"><span style="background:"><font color="">Web Notify</font></span><a href="http://LOCATION/WebNotify">?</a><p><span style="background:"><font color="">Readme First</font></span><a href="http://LOCATIONKnow/ReadmeFirst">?</a></p> + </td> + </tr> + <tr> + <td valign="top"><strong>Forced Links:</strong><br /> You can create a forced internal link by enclosing words in double square brackets. <br /><strong><em>Note:</em></strong> Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; i.e. <code>[<nop>[text formatting FAQ]]</nop></code> links to topic <span style="background:"><font color="">Text Formatting FAQ</font></span><a href="http://LOCATION/TextFormattingFAQ">?</a>. You can also refer to a different web and use anchors. </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> [[wiki syntax]] [[%MAINWEB%.TWiki users]] </pre> </font></span></td> - <td valign="top"><span style="background:"><font color="">wiki syntax</font></span><a href="http://LOCATION/WikiSyntax">?</a><p><span style="background:"><font color="">%MAINWEB%.TWiki users</font></span><a href="http://LOCATION/MAINWEBTWikiUsers">?</a></p> - </td> - </tr> - <tr> - <td valign="top"><strong>Specific Links:</strong><br /> Create a link where you can specify the link text and the link reference separately, using nested square brackets like <code>[<nop>[reference][text]]</nop></code>. Internal link references (i.e. <span style="background:"><font color="">Wiki Syntax</font></span><a href="http://LOCATION/WikiSyntax">?</a>) and external link references (i.e. <a href="http://TWiki.org/)" target="_top">http://TWiki.org/)</a> are supported. The same <strong><em>Forced Links</em></strong> rules apply for internal link references. Anchor names can be added as well, like <code>[<nop>[WebHome#MyAnchor][go home]]</nop></code> and <code>[<nop>[http://www.yahoo.com/#somewhere][Yahoo!]]</nop></code>. </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td valign="top"><span style="background:"><font color="">wiki syntax</font></span><a href="http://LOCATION/WikiSyntax">?</a><p><span style="background:"><font color="">%MAINWEB%.TWiki users</font></span><a href="http://LOCATION/MAINWEBTWikiUsers">?</a></p> + </td> + </tr> + <tr> + <td valign="top"><strong>Specific Links:</strong><br /> Create a link where you can specify the link text and the link reference separately, using nested square brackets like <code>[<nop>[reference][text]]</nop></code>. Internal link references (i.e. <span style="background:"><font color="">Wiki Syntax</font></span><a href="http://LOCATION/WikiSyntax">?</a>) and external link references (i.e. <a href="http://TWiki.org/)" target="_top">http://TWiki.org/)</a> are supported. The same <strong><em>Forced Links</em></strong> rules apply for internal link references. Anchor names can be added as well, like <code>[<nop>[WebHome#MyAnchor][go home]]</nop></code> and <code>[<nop>[http://www.yahoo.com/#somewhere][Yahoo!]]</nop></code>. </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> [[WikiSyntax][syntax]] [[http://gnu.org][GNU]] </pre> </font></span></td> - <td valign="top"><span style="background:"><font color="">syntax</font></span><a href="http://LOCATION/WikiSyntax">?</a><p><a href="http://gnu.org" target="_top">GNU</a></p> - </td> - </tr> - <tr> - <td valign="top"><strong>Anchors:</strong><br /> You can define a link reference inside a %WIKITOOLNAME% topic (called an anchor name) and link to that. To <strong><em>define</em></strong> an anchor write <code>#AnchorName</code> at the beginning of a line. The anchor name must be a <span style="background:"><font color="">Wiki Word</font></span><a href="http://LOCATION/WikiWord">?</a>. To <strong><em>link to</em></strong> an anchor name use the <code>[<nop>[MyTopic#MyAnchor]]</nop></code> syntax. You can omit the topic name if you want to link within the same topic. </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td valign="top"><span style="background:"><font color="">syntax</font></span><a href="http://LOCATION/WikiSyntax">?</a><p><a href="http://gnu.org" target="_top">GNU</a></p> + </td> + </tr> + <tr> + <td valign="top"><strong>Anchors:</strong><br /> You can define a link reference inside a %WIKITOOLNAME% topic (called an anchor name) and link to that. To <strong><em>define</em></strong> an anchor write <code>#AnchorName</code> at the beginning of a line. The anchor name must be a <span style="background:"><font color="">Wiki Word</font></span><a href="http://LOCATION/WikiWord">?</a>. To <strong><em>link to</em></strong> an anchor name use the <code>[<nop>[MyTopic#MyAnchor]]</nop></code> syntax. You can omit the topic name if you want to link within the same topic. </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> [[WebHome#NotThere]] [[#MyAnchor][Jump]] #MyAnchor To here </pre> </font></span></td> - <td valign="top"><span style="background:"><font color="">Web Home#Not There</font></span><a href="http://LOCATION/WebHome">?</a><p> Jump </p> - <p><a name="MyAnchor"></a> To here </p> - </td> - </tr> - <tr> - <td valign="top"><strong>Prevent a Link:</strong><br /> Prevent a <span style="background:"><font color="">Wiki Word</font></span><a href="http://LOCATION/WikiWord">?</a> from being linked by prepending it with the <code>&lt;nop&gt;</code> tag. </td> - <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> + <td valign="top"><span style="background:"><font color="">Web Home#Not There</font></span><a href="http://LOCATION/WebHome">?</a><p> Jump </p> + <p><a name="MyAnchor"></a> To here </p> + </td> + </tr> + <tr> + <td valign="top"><strong>Prevent a Link:</strong><br /> Prevent a <span style="background:"><font color="">Wiki Word</font></span><a href="http://LOCATION/WikiWord">?</a> from being linked by prepending it with the <code>&lt;nop&gt;</code> tag. </td> + <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre> &lt;nop&gt;SunOS </pre> </font></span></td> - <td valign="top"><nop>SunOS </nop></td> + <td valign="top"><nop>SunOS </nop></td> + </tr> + </table> + </td> </tr> </table> |