none
[openafs-wiki.git] / TWiki / TextFormattingFAQ.mdwn
index b7ff9e2..2886fa6 100644 (file)
@@ -1,14 +1,13 @@
 <font>**Text Formatting FAQ**</font>
 
-- The most frequently asked questions about text formatting are answered here.
-  - [[TextFormattingRules]] has the complete system in a handy quick reference format.
+The most frequently asked questions about text formatting are answered. Also, [[TextFormattingRules]] contains the complete TWiki shorthand system on one quick reference page.
 
 <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 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="#Some words appear highlighted, w"> Some words appear highlighted, with a "?" link 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>
     <li><a href="#Text I enter gets wrapped around"> Text I enter gets wrapped around. How can I keep the formatting as it is?</a></li>
     <li><a href="#How do I create tables?"> How do I create tables?</a></li>
@@ -21,7 +20,7 @@
 >
 > ### <a name="How do I make a separator?"></a> How do I make a separator?
 >
-> You can make a horizontal separator by writing three or more dashes at the beginning of a line.
+> You can make a horizontal separator by entering three dashes at the beginning of a line: `---`.
 >
 > ----
 >
 >
 > If you want to display angle brackets, enter them as HTML codes instead of typing them in directly:
 >
-> - - `&lt;` = `<`
->   - `&gt;` = `>`
->   - Enter: `(a &gt; 0)` to get `(a > 0)`
+> - `&lt;` = `<`<br />`&gt;` = `>`
+>
+> - **_You enter:_** `(a &gt; 0)`
+>     **_Result:_** `(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 name="Some words appear highlighted, w"></a> Some words appear highlighted, with a "?" link at the end. How can I prevent that?
 >
-> 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.
+> 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 a new branch to the topic.
 >
-> 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>`:
+> To prevent auto-linking - say you want to enter a word like JavaScript (the proper spelling!) - prefix the [[WikiStyleWord]] with the special TWiki HTML tag `<nop>`:
 >
-> - `<nop>WikiWord` displays as WikiWord
+> - `<nop>WikiStyleWord` displays as WikiStyleWord
 >
 > ----
 >
 > ### <a name="How can I write fixed font text?"></a> How can I write fixed font text?
 >
-> Enclose text in "=" equal signs:
->
-> - `Proportional text, =fixed font text=, proportional again.` appears as... <br /> Proportional text, `fixed font text` , proportional again.
+> The quickest way is to enclose the text in equal signs:
 >
-> Alternatively you could also use preformatted text, see next question for details.
+> - **_You enter:_** `Proportional text, =fixed font=, proportional again.`
+>     **_Result:_** Proportional text, `fixed font`, proportional again.
 >
 > ----
 >
 > ### <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 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:
+> TWiki interprets text as HTML, so you can use the `preformatted` HTML text option to keep the new line of text as is. Enclose the text in &lt;pre&gt; &lt;/pre&gt;, or in TWiki's own &lt;verbatim&gt; &lt;/verbatim&gt; tags:
 >
 >     This text will keep its format as it is:
 >     <verbatim>
@@ -90,7 +89,7 @@
 > 2. Use HTML tables with &lt;table&gt;, &lt;tr&gt;, &lt;td&gt; tags.
 > 3. Use preformatted text with &lt;verbatim&gt; tags.
 >
-> **_1\. Use Wiki rule with "|" vertical bars_**
+> **1\. Use Wiki rule with "|" vertical bars**
 >
 > - Example text: <br />`| cell A1 | cell B1 | cell C1 |`<br />`| cell A2 | cell B2 | cell C2 |`
 > - Example output: <table border="1" cellpadding="0" cellspacing="0">
 >   </tr>
 > </table>
 >
-> **_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**
 >
-> This is a manual process using HTML commands. Here is an example. If you enter this:
+> This is a manual process using HTML commands.
+>
+> **_You enter:_**
 >
 >     <table border="1">
 >       <tr>
 >       </tr>
 >     </table>
 >
-> It is displayed as a table like this:
+> **_Result:_**
 >
 > <table border="1">
 >   <tr>
 >   </tr>
 > </table>
 >
-> **_3\. Use preformatted text with &lt;verbatim&gt; tags_**
+> **3\. Use preformatted text with &lt;verbatim&gt; tags**
 >
-> Text I enter gets wrapped around. How can I keep the formatting as it is? See [["Text enclosed..."|Main/WebHome#TextEnclosed]]
+> See [["Text enclosed..."|Main/WebHome#TextEnclosed]]
 >
 > ----
 >
 >
 > There are actually two ways of including inline images.
 >
-> **_1\. Using URL ending in .gif, .jpg, .jpeg, .png_**
+> **1\. Using URL ending in .gif, .jpg, .jpeg, .png**
 >
 > This is a simple and automatic way of including inline images. Simply write the URL of the image file, this will create the inline image for you. **Note:** The images must be accessible as a URL.
 >
-> - Example text: <br />` TWiki http://www.dementia.org/twiki//view/wikiHome.gif logo.`
-> - Example output: <br /> TWiki ![wikiHome.gif](http://www.dementia.org/twiki//view/wikiHome.gif) logo.
+> - **_You enter:_** ` TWiki http://www.dementia.org/twiki//view/wikiHome.gif logo.`<br />**_Result:_** TWiki ![wikiHome.gif](http://www.dementia.org/twiki//view/wikiHome.gif) logo.
 >
-> **_2\. Using &lt;img&gt; tag_**
+> **2\. Using &lt;img&gt; tag**
 >
 > This is a manual process where you have more control over the rendering of the image. Use the &lt;img&gt; tag of HTML to include GIF, JPG and PNG files. **Note:** The display of the topic is faster if you include the WIDTH and HEIGHT parameters that have the actual image size. <http://www.htmlhelp.com/reference/wilbur/special/img.html> has more on inline images.
 >
-> - Example text: <br />`TWiki <img src="http://www.dementia.org/twiki//view/wikiHome.gif" width="46" height="50" /> logo.`
-> - Example output: <br /> TWiki <img src="http://www.dementia.org/twiki//view/wikiHome.gif" width="46" height="50" /> logo.
+> - **_You enter:_** `TWiki <img src="http://www.dementia.org/twiki//view/wikiHome.gif" width="46" height="50" /> logo.`<br />**_Result:_**<br /> TWiki <img src="http://www.dementia.org/twiki//view/wikiHome.gif" width="46" height="50" /> logo.
 >
 > ----
 >
 > ### <a name="Can I write colored text?"></a> Can I write colored text?
 >
-> Place text you would like to specify a color inside &lt;font color="colorCode"&gt; and &lt;/font&gt; tags.
+> Sure. The quickest way is to use the &lt;font color="colorCode"&gt; and &lt;/font&gt; tags - they're HTML tags that work in any browser, (although they've been phased in the latest version).
+>
+> You can also use a `style` attribute: `style="color:#ff0000"`, placed in most HTML tags - `span` is an all-purpose choice: "&lt;span style="color:#ff0000"&gt;.
 >
-> "colorCode" is the hexadecimal RGB color code. The color is composed by specifying the red, green and blue components of the color in hexadecimal notation. For example, to specify white, the red, green and blue components are 255, 255, 255, so you would use ="#ffffff=". You can use [[StandardColors]] or common color codes:
+> "colorCode" is the _hexadecimal RGB color code_, which is simply Red, Green and Blue values in hex notation (base 16, 0-F). For pure red, the RGB components are 255-0-0 - full red (255), no green or blue. That's FF-0-0 in hex, or <code>"#ff000=" for Web page purposes. For a basic color selection (you can [[StandardColor|Main/StandardColors]] names instead of hex code in the =font</code> tag only):
 >
 > <table>
 >   <tr bgcolor="#e0e0e0">
 >   </tr>
 > </table>
 >
-> - Example text: <br />` <font color="#ff0000"> Red color </font> draws attention. `
-> - Example output: <br /><font> Red color </font> draws attention.
+> - **_You enter:_** ` <font color="#ff0000"> Red color </font> draws attention. `
+>     **_Result:_** <font> Red color </font> draws attention.
 >
 > ----
 
--- [[MikeMannix]] - 10 Sep 2001 <br /> -- [[PeterThoeny]] - 13 Sep 2001 <br />
+-- [[PeterThoeny]] - 13 Sep 2001 <br /> -- [[MikeMannix]] - 14 Sep 2001 <br />