none
authorMikeMannix <MikeMannix>
Mon, 3 Dec 2001 04:11:51 +0000 (04:11 +0000)
committerMikeMannix <MikeMannix>
Mon, 3 Dec 2001 04:11:51 +0000 (04:11 +0000)
TWiki/TextFormattingRules.mdwn

index 6a45a50..ffce918 100644 (file)
@@ -2,7 +2,11 @@
   <ul>
     <li><a href="#TWiki Text Formatting"> TWiki Text Formatting</a><ul>
         <li><a href="#TWiki Editing Shorthand"> TWiki Editing Shorthand</a></li>
-        <li><a href="#Using HTML"> Using HTML</a></li>
+        <li><a href="#Using HTML"> Using HTML</a><ul>
+            <li><a href="#HTML and TWiki Usability"> HTML and TWiki Usability</a></li>
+            <li><a href="#TWiki HTML Rendering"> TWiki HTML Rendering</a></li>
+          </ul>
+        </li>
         <li><a href="#Hyperlinks"> Hyperlinks</a><ul>
             <li><a href="#Internal Links"> Internal Links</a></li>
             <li><a href="#External Links"> External Links</a></li>
@@ -269,11 +273,20 @@ Know.ReadmeFirst
 
 ## <a name="Using HTML"></a> Using HTML
 
-You can use just about any HTML tag without a problem - however, to keep in mind:
+You can use just about any HTML tag without a problem - however, there are a few usability and technical considerations to keep in mind.
+
+### <a name="HTML and TWiki Usability"></a> HTML and TWiki Usability
 
 - On collaboration pages, it's preferable NOT to use HTML, and to use [[TWiki shorthand|Main/WebHome#TWikiShorthand]] instead - this keeps the text uncluttered and easy to edit.
-  - **_NOTE:_** TWiki converts shorthand notation to XHTML 1.0 for display. To copy a fully marked-up page, simply view source in your browser and save the contents.
-  - **_NOTE:_** The standard installation TWiki is compatible across a wide range of browsers and computer platforms. If this is important to you, remember that using browser-specific tags or any other mark-up that doesn't degrade well will reduce compatibility.
+- %X% **NOTE:** TWiki is designed to work with a wide range of browsers and computer platforms, holding to HTML 3.2 compatibility in the standard installation - adding raw HTML, particularly browser-specific tags (or any other mark-up that doesn't degrade well) will reduce compatibility.
+
+### <a name="TWiki HTML Rendering"></a> TWiki HTML Rendering
+
+- TWiki converts shorthand notation to XHTML 1.0 for display. To copy a fully marked-up page, simply view source in your browser and save the contents.
+  - %T% If you need to save HTML frequently, you may want to check out TWiki:Plugins/GenHTMLAddon - it will "generate a directory containing rendered versions of a set of TWiki pages together with any attached files."
+- %X% **NOTE:** The opening and closing angle brackets - <code>**&lt;...&gt;**</code> - of an HTML tag **_must be on the same line_**, or the tag will be broken.
+  - This feature allows you to enter an unclosed angle bracket - as a greater than or less than symbol - and have it automatically rendered as if you had entered its HTML character, `&lt;`, ex: <code>**a &gt; b**</code>
+  - %T% If you're pasting in preformatted HTML text and notice problems, check the file in a text processor with no text wrap. Also, save without hard line breaks on text wrap, in your HTML editing program.
 
 ## <a name="Hyperlinks"></a> Hyperlinks