diff options
-rw-r--r-- | TWiki/TextFormattingRules.mdwn | 48 |
1 files changed, 33 insertions, 15 deletions
diff --git a/TWiki/TextFormattingRules.mdwn b/TWiki/TextFormattingRules.mdwn index a66c871b..02a39ade 100644 --- a/TWiki/TextFormattingRules.mdwn +++ b/TWiki/TextFormattingRules.mdwn @@ -1,20 +1,22 @@ It is easy to collaborate; just type your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically, as long as you follow these simple Text Formatting Rules. [[TextFormattingFAQ]] has answers to frequently asked questions about text formatting. -## <a name="LINKS"> </a> LINKS +%TOC\{depth="2"\}% + +## <a name="Links"> Links </a> The Collaborative Work Area is a bunch of related links that are editable through your web browser. -The %WIKITOOLNAME% web has the following types of **_internal links:_** +### <a name="_WIKITOOLNAME_Internal_Links"> %WIKITOOLNAME% 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. You could create that topic by clicking on the question mark. (Do not create that topic; you would wreck this example!) -### <a name="External_links_"> External links: </a> +### <a name="External_Links"> External Links </a> * `http://...`, `https://...`, `ftp://...` and `mailto:...@...` are linked automatically. * Email addresses like `name@domain.com` are linked automatically. -## <a name="EDITING"> </a> EDITING +## <a name="Editing"> Editing </a> <table border="3" cellpadding="2" cellspacing="2"> <tr> @@ -35,13 +37,16 @@ The %WIKITOOLNAME% web has the following types of **_internal links:_** <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> ----++ Sushi +<nop>---++ Sushi ----+++ Maguro -</pre> </font></span></td> - <td valign="top"><nop><h2><a name="Sushi"> Sushi </a></h2> - <p><nop></nop></p> - <h3><a name="Maguro"> Maguro </a></h3></nop></td> +<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> @@ -260,24 +265,37 @@ Know.ReadmeFirst </tr> </table> -## <a name="HTML"> </a> HTML +## <a name="Using_HTML"> </a> Using HTML Most HTML tags will work, but it's almost always preferable not to use HTML, so that the markup remains easy for everyone to edit. -* Overview of all HTML elements at <http://www.htmlhelp.com/reference/wilbur/overview.html> -* HTML 3.2 Reference Specification at <http://www.w3.org/TR/REC-html32.html> +* HTML 4.01 Reference Specification: <http://www.w3.org/TR/html4/> +* Quick reference of all HTML elements: <http://werbach.com/barebones/barebones.html> -## <a name="WIKI_VARIABLES"> </a> WIKI VARIABLES +## <a name="TWiki_Variables"> TWiki Variables </a> Variables are names that are enclosed in percent signs; they get expanded on the fly. +* <code>%TOC%</code> : The table of content, is based on headings in a topic. * <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="_WIKITOOLNAME_PLUGINS"> </a> %WIKITOOLNAME% PLUGINS +## <a name="_Gotchas_when_Editing_Text"> "Gotchas" when Editing Text </a> + +The formatting rules are fairly simple to use and fast to type. However, there are some things to watch out for: + +* **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'`. + +* See more [[TextFormattingFAQs]] + +## <a name="_WIKITOOLNAME_Plugins"> %WIKITOOLNAME% Plugins </a> %WIKITOOLNAME% Plugins offer additional text formatting rules. Plugins currently installed are: |