diff options
Diffstat (limited to 'TWiki')
| -rw-r--r-- | TWiki/TextFormattingRules.mdwn | 36 |
1 files changed, 6 insertions, 30 deletions
diff --git a/TWiki/TextFormattingRules.mdwn b/TWiki/TextFormattingRules.mdwn index 08ebf049..1abdca91 100644 --- a/TWiki/TextFormattingRules.mdwn +++ b/TWiki/TextFormattingRules.mdwn @@ -1,6 +1,6 @@ %TOC\{depth="4"\}% %STARTINCLUDE% -# <a name="Appendix_C_Text_Formatting_Rules"> Appendix C: Text Formatting Rules </a> +# <a name="TWiki_Text_Formatting"> TWiki Text Formatting </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 TWiki shorthand gives you all the power of HTML with a simple coding system that takes no time to learn. It's all layed out below - refer back to this page in a pop-up window from the **Edit** screen. @@ -214,7 +214,7 @@ Know.ReadmeFirst </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 <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">#SquareBrackets <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]] @@ -281,38 +281,14 @@ Being able to create links without any formatting required is a core TWiki featu * <code>[[Square bracket rules]]</code> let you easily create non-WikiWord links. -## <a name="TWiki_Variables"> TWiki Variables </a> +## <a name="TWikiPlugin_Formatting_Extension"> TWikiPlugin Formatting Extensions </a> -Variables are names that are enclosed in percent signs `%` that are expanded on the fly. +Plugins provide additional text formatting capabilities and can extend the functionality of %WIKITOOLNAME% into many other areas. For example, the optional [SpreadSheetPlugin](http://twiki.org/cgi-bin/view/Plugins/SpreadSheetPlugin) lets you create a spreadsheet with the same basic notation used in TWiki tables. -* <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, ex: `'©'` 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'`. - -## <a name="TWiki_Plugins"> TWiki Plugins </a> - -Plugins provide additional text formatting capabilities and can extend the functionality of %WIKITOOLNAME% into many other areas. For example, one optional Plugin lets you create a basic spreadsheet in a similar way to tables. Available Plugins are located in the [[TWikiPlugins]] web on TWiki.org. Currently enabled plugins on here: +Available Plugins are located in the [Plugins](http://twiki.org/cgi-bin/view/Plugins) web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by <code>%PLUGINDESCRIPTIONS%</code>: %PLUGINDESCRIPTIONS% Check on current Plugin status and settings for this site in [[TWikiPreferences]]. --- [[MikeMannix]] - 02 Oct 2001 <br /> +-- [[Main/MikeMannix]] - 02 Dec 2001 |