none
authorMikeMannix <MikeMannix>
Mon, 10 Sep 2001 07:20:37 +0000 (07:20 +0000)
committerMikeMannix <MikeMannix>
Mon, 10 Sep 2001 07:20:37 +0000 (07:20 +0000)
TWiki/TextFormattingFAQ.mdwn

index 13f6711..bdfb9fb 100644 (file)
@@ -6,10 +6,7 @@
 <div>
   <ul>
     <li><a href="#How do I make a separator?"> How do I make a separator?</a></li>
-    <li><a href="#How do I create a title or a hea"> How do I create a title or a heading?</a><ul>
-        <li><a href="#This is an HTML heading">This is an HTML heading</a></li>
-      </ul>
-    </li>
+    <li><a href="#How do I create a heading?"> How do I create a heading?</a></li>
     <li><a href="#Text enclosed in angle brackets"> Text enclosed in angle brackets like &lt;filename&gt; is not displayed. How can I show it as it is?</a></li>
     <li><a href="#Some words (like _WinAPI) have a"> Some words (like WinAPI) have an unwanted question mark at the end. How can I prevent that?</a></li>
     <li><a href="#How can I write fixed font text?"> How can I write fixed font text?</a></li>
 >
 > ### <a name="How do I make a separator?"></a> How do I make a separator?
 >
-> You can make a horizontal separator by writing 4 or more dashes at the beginning of a line.
+> You can make a horizontal separator by writing three or more dashes at the beginning of a line.
 >
 > ----
 >
-> ### <a name="How do I create a title or a hea"></a> How do I create a title or a heading?
+> ### <a name="How do I create a heading?"></a> How do I create a heading?
 >
-> The most simple way is to enclose it in '\*' Asterisk characters or '\_' Underscore characters.
+> You can create six sizes of headings - &lt;H1&gt;...&lt;H6&gt; in HTML - by typing, from the beginning of a line, three dashes (-), from one to six plus signs (+), a space, and your heading text. The FAQ questions on this page are created with: `---+++ Have a question?`.
 >
-> **This is an example header enclosed in Asterisk characters**
->
-> _This is an example header enclosed in Underscore characters_
->
-> You could use also HTML tags for headings, e.g. `<H4>This is an HTML heading</H4>` will show up as:
->
-> #### <a name="This is an HTML heading"></a> This is an HTML heading
+> - You can insert a nested table of contents, generated from headings, by placing `%TOC%` wherever you like on a page (see [[TWikiVariables]] for more `%TOC%` options).
 >
 > ----
 >
 >
 > ### <a name="Text enclosed in angle brackets"></a><a name="Text enclosed in angle brackets "></a> Text enclosed in angle brackets like &lt;filename&gt; is not displayed. How can I show it as it is?
 >
-> TWiki interprets text as HTML. The '&lt;' and '&gt;' characters are used to define HTML commands. Any valid text within angle brackets gets interpreted by the browser as an HTML command. Invalid text is ignored, that's why it doesn't show up.
+> TWiki interprets text as HTML. The '&lt;' and '&gt;' characters are used to define HTML commands. Text contained in angle brackets is interpreted by the browser if it's a valid HTML instruction, or ignored if it isn't - either way, the brackets and its contents are not displayed.
 >
-> There are two work arounds if you want to display angle brackets:
+> If you want to display angle brackets, enter them as HTML codes instead of typing them in directly:
 >
-> - Do an escape sequence in HTML:
->   - Write `&lt;` instead of `<`
->   - Write `&gt;` instead of `>`
->   - Example: Write `(a &gt; 0)` instead of `(a > 0)`
-> - Replace angle brackets with curly brackets.
->   - Example: Write `{is-writable}` instead of `<is-writable>`
+> - - `&lt;` = `<`
+>   - `&gt;` = `>`
+>   - Enter: `(a &gt; 0)` to get `(a > 0)`
 >
 > ----
 >
 > ### <a name="Some words (like _WinAPI) have a"></a> Some words (like [[WinAPI]]) have an unwanted question mark at the end. How can I prevent that?
 >
-> A question mark after a word is a link to a not yet existing topic. For example, [[WinAPI]] is a valid [[WikiName]], but the actual topic _WinAPI_ does not exist.
+> A question mark after a word is a link to a topic that doesn't yet exist - click it to create the new page. This is a TWiki feature - typing a [[MeaningfulTitle]] in a comment is an invitation for someone else to add to the topic.
 >
-> If you do not intend to create a topic for a valid [[WikiWord]], you can prevent it being linked by putting an HTML tag in front of it. I usually use &lt;nop&gt;. This is a non existing HTML tag, so a browser just ignores it.
+> To prevent auto-linking - you may simply want to enter a word like JavaScript (the proper spelling!) - prefix it with the special TWiki HTML tag `<nop>`:
 >
-> - Example text: <br />`WinAPI as it is, <nop>WinAPI with preceding NOP.`
-> - Example output: <br />[[WinAPI]] as it is, WinAPI with preceding NOP.
+> - `<nop>WikiWord` displays as WikiWord
 >
 > ----
 >
 > ### <a name="How can I write fixed font text?"></a> How can I write fixed font text?
 >
-> Enclose text in "=" equal signs.
+> Enclose text in "=" equal signs:
 >
-> - Example text: <br />`Proportional text, =fixed font text= , proportional again.`
-> - Example output: <br /> Proportional text, `fixed font text` , proportional again.
+> - `Proportional text, =fixed font text=, proportional again.` appears as... <br /> Proportional text, `fixed font text` , proportional again.
 >
 > Alternatively you could also use preformatted text, see next question for details.
 >
 >
 > ### <a name="Text I enter gets wrapped around"></a> Text I enter gets wrapped around. How can I keep the formatting as it is?
 >
-> TWiki interprets text as HTML. It is possible to use preformatted text to work around this. Use the preformatted HTML tags to keep the new line of text as it is. Do so by enclosing the text with &lt;PRE&gt; and &lt;/PRE&gt; tags, e.g.
+> TWiki interprets text as HTML. It is possible to use preformatted text to workaround this. Use the preformatted HTML tags to keep the new line of text as it is. Do so by enclosing text in either &lt;pre&gt; &lt;/pre&gt; or &lt;verbatim&gt; &lt;verbatim&gt; tags:
 >
 >     This text will keep its format as it is:
->     <PRE>
+>     <pre>
 >       Unit     Price Qty  Cost
 >       -------  ------  ---  ------
 >       aaa             12.00   3      36.00
->     </PRE>
+>     </pre>
 >
-> It is recommended to use preformatting for tables and source code.
+> The `pre` tag is standard HTML; `verbatim` is a special TWiki tag that also forces text to fixed font mode, and also prevents other tags and TWiki shortcuts from being expanded.
 >
 > ----
 >
 > There are three possibilities:
 >
 > 1. Use Wiki rule with "|" vertical bars.
-> 2. Use HTML tables with &lt;TABLE&gt;, &lt;TR&gt;, &lt;TD&gt; tags.
+> 2. Use HTML tables with &lt;table&gt;, &lt;tr&gt;, &lt;td&gt; tags.
 > 3. Use preformatted text with &lt;PRE&gt; tags.
 >
 > **\_1. Use Wiki rule with "|" vertical bars\_**
 >   </tr>
 > </table>
 >
-> You can copy the example from &lt;TABLE&gt; to &lt;/TABLE&gt; and change it to your needs.
->
-> More information about HTML tables can be found at <http://www.htmlhelp.com/reference/wilbur/table/table.html>
->
 > **\_3. Use preformatted text with &lt;PRE&gt; tags\_**
 >
 > Text I enter gets wrapped around. How can I keep the formatting as it is? See [["Text enclosed..."|Main/WebHome#TextEnclosed]]
 >
 > ----
 
--- [[PeterThoeny]] - 18 Aug 2000
+-- [[MikeMannix]] - 10 Sep 2001 <br />