diff options
Diffstat (limited to 'TWiki/TWikiShorthand.mdwn')
| -rw-r--r-- | TWiki/TWikiShorthand.mdwn | 302 |
1 files changed, 0 insertions, 302 deletions
diff --git a/TWiki/TWikiShorthand.mdwn b/TWiki/TWikiShorthand.mdwn deleted file mode 100644 index 1d7f2be2..00000000 --- a/TWiki/TWikiShorthand.mdwn +++ /dev/null @@ -1,302 +0,0 @@ -%TOC\{depth="4"\}% %STARTINCLUDE% - -# <a name="TWiki_Shorthand"> TWiki Shorthand </a> - -Working in TWiki is as easy as typing in text - exactly like email. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter [[WikiWords]]. And [[TWikiShorthand]] gives you all the power of HTML with a simple coding system that takes little time to learn. It's all layed out below - refer back to this table in a pop-up window from the **Edit** screen. - -<table bgcolor="#000000" border="0" cellpadding="3" cellspacing="1"> - <tr bgcolor="#ffffff"> - <td><strong>Formatting Command:</strong></td> - <td><strong>Example: You write:</strong></td> - <td><strong>You get:</strong></td> - </tr> - <tr bgcolor="#ffffff"> - <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 bgcolor="#ffffff"> - <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 [[TWikiVariables]]. </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 bgcolor="#ffffff"> - <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 bgcolor="#ffffff"> - <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 bgcolor="#ffffff"> - <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 bgcolor="#ffffff"> - <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 bgcolor="#ffffff"> - <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 bgcolor="#ffffff"> - <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 bgcolor="#ffffff"> - <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 HTML code to be 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() { - &lt;code here&gt; - } -} -&lt;/verbatim&gt; -</pre> </font></span></td> - <td valign="top"><pre> -class CatAnimal { - void purr() { - &lt;code here&gt; - } -} -</pre></td> - </tr> - <tr bgcolor="#ffffff"> - <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 bgcolor="#ffffff"> - <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 bgcolor="#ffffff"> - <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 bgcolor="#ffffff"> - <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 bgcolor="#ffffff"> - <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 bgcolor="#ffffff"> - <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 | -| multi span ||| -| A4 \<nop> - | 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> - </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 bgcolor="#ffffff"> - <td valign="top"><strong><nop>WikiWord Links:</nop></strong><br /><nop>CapitalizedWordsStuckTogether (or [[WikiWords]]) 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">[[WebNotify]]<p>[[Know/ReadmeFirst]]</p> - </td> - </tr> - <tr bgcolor="#ffffff"> - <td valign="top"><a name="SquareBrackets"></a> <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 [[TextFormattingFAQ]]. 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">[[WikiSyntax]]<p>[[MAINWEBTWikiUsers]]</p> - </td> - </tr> - <tr bgcolor="#ffffff"> - <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. [[WikiSyntax]]) 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">[[WikiSyntax]]<p><a href="http://gnu.org" target="_top">GNU</a></p> - </td> - </tr> - <tr bgcolor="#ffffff"> - <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 [[WikiWord]]. 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">[[WebHome]]<p> Jump </p> - <p><a name="MyAnchor"></a> To here </p> - </td> - </tr> - <tr bgcolor="#ffffff"> - <td valign="top"><strong>Prevent a Link:</strong><br /> Prevent a [[WikiWord]] 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> - </tr> -</table> - -## <a name="Using_HTML"> </a> Using HTML - -You can use just about any HTML tag without a problem, HOWEVER, it's recommended NOT to. Using [[TWikiShorthand]], you can do practically anything you'd normally do with HTML, and it keeps the text uncluttered and easy for people to browse edit. - -## <a name="Hyperlinks"> Hyperlinks </a> - -Being able to create links without any formatting required is a core TWiki feature, made possible with [[WikiWords]]. New TWiki linking rules are a simple extension of the syntax that provide a new set of flexible options. - -### <a name="Internal_Links"> Internal Links </a> - -* [[GoodStyle]] is a [[WikiWord]] that links to the GoodStyle topic located in the current %WIKITOOLNAME% web. - -* [[NotExistingYet]] is a topic waiting to be written. Create the topic by clicking on the **?**. (Try clicking, but then, **Cancel** - creating the topic would wreck this example!) - -### <a name="External_Links"> External Links </a> - -* `http://...`, `https://...`, `ftp://...` and `mailto:...@...` are linked automatically. - -* Email addresses like `name@domain.com` are linked automatically. - -* <code>[[Square bracket rules]]</code> let you easily create non-WikiWord links. - -## <a name="TWiki_Variables"> TWiki Variables </a> - -[[TWikiVariables]] are names that are enclosed in percent signs `%` that are expanded on the fly. Using the existing variables, and even creating your own, adds an amazing extra level of content to your posts. For example: - -* <code>%TOC%</code> : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example. - -* <code>%WEB%</code> : The current web, is **%WEB%**. - -* <code>%TOPIC%</code> : The current topic name, is **%TOPIC%**. - -* <code>%ATTACHURL%</code> : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as <code>**%ATTACHURL%/image.gif**</code> to show the URL of the file or the image in your text. - -* <code>%INCLUDE\{"SomeTopic"\}%</code> : Server side include, includes another topic. The current %WIKITOOLNAME% web is the default web. Example: <code>**%INCLUDE\{"%TWIKIWEB%.TWikiWebsTable"\}%**</code> - -* There are many more variables, see **[[TWikiVariables]]**. - -## <a name="Common_Editing_Errors"> Common Editing Errors </a> - -TWiki formatting rules are fairly simple to use and quick to type. However, there are some things to watch out for, taken from the [[TextFormattingFAQ]]: - -* **Q:** Text enclosed in angle brackets like `<filename>` is not displayed. How can I show it as it is? - * **A:** The `'<'` and `'>'` characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write `'<'` instead of `'<'`, and `'>'` instead of `'>'`. <br /> Example: Type `'prog <filename>'` to get `'prog <filename>'`. - -* **Q:** Why is the `'&'` character sometimes not displayed? - * **A:** The `'&'` character has a special meaning in HTML, it starts a so called character entity, i.e. `'©'` is the `©` copyright character. You need to escape `'&'` to see it as it is, so write `'&'` instead of `'&'`. <br /> Example: Type `'This & that'` to get `'This & that'`. - --- [[Main/MikeMannix]] - 02 Dec 2001 |