summaryrefslogtreecommitdiff
path: root/TWiki/TextFormattingRules.mdwn
diff options
context:
space:
mode:
authorPeter Thoeny <web-hurd@gnu.org>2001-02-01 01:34:06 +0000
committerPeter Thoeny <web-hurd@gnu.org>2001-02-01 01:34:06 +0000
commitb6ebbda1268d081e825a76d6fe97ace42596a381 (patch)
tree1c7c474aefc96314e6c5889afc569a3ed4c92214 /TWiki/TextFormattingRules.mdwn
parent0b33e75183979f1ff563a49fe318ead2c83e1719 (diff)
none
Diffstat (limited to 'TWiki/TextFormattingRules.mdwn')
-rw-r--r--TWiki/TextFormattingRules.mdwn218
1 files changed, 196 insertions, 22 deletions
diff --git a/TWiki/TextFormattingRules.mdwn b/TWiki/TextFormattingRules.mdwn
index 76ee93e9..12c1667d 100644
--- a/TWiki/TextFormattingRules.mdwn
+++ b/TWiki/TextFormattingRules.mdwn
@@ -16,28 +16,202 @@ The %WIKITOOLNAME% web has the following types of **_internal links:_**
**EDITING**
-* CapitalizedWordsStuckTogether (or [[WikiWords]]) will produce a link automatically. In case you want to link to a topic in a different %WIKITOOLNAME% web write `Web.TopicName`, i.e. write `Know.ReadmeFirst` to link to [[Know/ReadmeFirst]] located in the Know web.
-* You can create a forced internal link by enclosing words in double square brackets, i.e. write <code>[[text formatting FAQ]]</code> to get [[TextFormattingFAQ]] that links to topic [[TextFormattingFAQ]]. Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces. You can also refer to a different web, i.e. <code>[[%MAINWEB%.TWiki users]]</code> points to %MAINWEB%.TWikiUsers in the %MAINWEB% web.
-* Blank lines will create new paragraphs.
-* Words get **bold** by enclosing them in **\*** asterisks
-* Words get _italic_ by enclosing them in **\_** underscores
-* Words get **_bold italic_** by enclosing them in **\_\_** double-underscores
-* Words get shown in `fixed font` by enclosing them in **=** equal signs
-* Words get shown in <code>**bold fixed font**</code> by enclosing them in **==** double equal signs
-* Note for **bold** , _italic_ , **_bold italic_** and `fixed font` text:
- * Make sure to "stick" the `* _ =` signs to the characters, e.g.
- * _This works_
- * \_This does not get italic because there is a space between the last word and the underline character \_
- * Example text to enter:
- * Writing \*bold text\* , \_italic text\_ and =fixed== monospaced text
- * Example text gets rendered as:
- * Writing **bold text** , _italic text_ and `fixed=` monospaced text
-* Separator: at least four dashes at the beginning of a line: &lt;--------&gt;
-* List Item: 3 spaces and an asterisk: &lt;   \*&gt;
-* Nested Item: 6 spaces and an asterisk: &lt;      \*&gt;
-* Ordered List: 3 spaces and a number: &lt;   1&gt;
-* Definition: 3 spaces, the term, a colon, followed by the definition: &lt;   term: definition&gt; <br /> Note that 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 non-breaking-space entity, i.e. write `Character&nbsp;Set:` to get `Character Set:`.
-* Table: Optional spaces followed by the cells enclosed in vertical bars: &lt;   | cell 1 | cell 2 | cell 3 | ... |&gt;
+<table border="3" cellpadding="2" cellspacing="2">
+ <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>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>
+ _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>
+ __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>
+ =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>
+ ==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>
+ _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>&amp;lt;verbatim&amp;gt;</code> and <code>&amp;lt;/verbatim&amp;gt;</code> tags. <br /><strong><em>Note:</em></strong> Use <code>&amp;lt;pre&amp;gt;</code> and <code>&amp;lt;/pre&amp;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>
+&amp;lt;verbatim&amp;gt;
+class CatAnimal {
+ void purr() {
+ &amp;lt;code here&amp;gt;
+ }
+}
+&amp;lt;/verbatim&amp;gt;
+</pre> </font></span></td>
+ <td valign="top"><pre>
+class CatAnimal {
+ void purr() {
+ &amp;lt;code here&amp;gt;
+ }
+}
+</pre></td>
+ </tr>
+ <tr>
+ <td valign="top"><strong>Separator:</strong><br /> At least four 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>
+ * 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>
+ * 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>
+ 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, 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;amp;nbsp;</code> non-breaking-space entity. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+ Sushi: Japan
+ Dim&amp;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. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+| A1 | B1 | C1 |
+| A2 | B2 | C2 |
+</pre> </font></span></td>
+ <td valign="top">
+ <table border="1" cellpadding="1" cellspacing="0">
+ <tr>
+ <td> A1 </td>
+ <td> B1 </td>
+ <td> C1 </td>
+ </tr>
+ <tr>
+ <td> A2 </td>
+ <td> B2 </td>
+ <td> C2 </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>
+ 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>, <span style="background:"><font color="">Readme First</font></span><a href="http://LOCATIONKnow/ReadmeFirst">?</a></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. </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>, <span style="background:"><font color="">%MAINWEB%.TWiki users</font></span><a href="http://LOCATION/MAINWEBTWikiUsers">?</a></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>&amp;lt;nop&amp;gt;</code> tag. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+ &amp;lt;nop&amp;gt;SunOS
+</pre> </font></span></td>
+ <td valign="top"><nop>SunOS </nop></td>
+ </tr>
+ <tr>
+ <td valign="top"><strong>Disable Links:</strong><br /> You can disable automatic linking of <span style="background:"><font color="">Wiki Words</font></span><a href="http://LOCATION/WikiWords">?</a> by surround text with <code>&amp;lt;noautolink&amp;gt;</code> and <code>&amp;lt;/noautolink&amp;gt;</code> tags. <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>
+ &amp;lt;noautolink&amp;gt;
+ RedHat &amp;amp;
+ SuSE
+ &amp;lt;/noautolink&amp;gt;
+</pre> </font></span></td>
+ <td valign="top"><noautolink> RedHat &amp;amp; SuSE </noautolink></td>
+ </tr>
+</table>
**HTML**