none
[openafs-wiki.git] / TWiki / TextFormattingFAQ.mdwn
index b7ff9e2..33c3d38 100644 (file)
@@ -1,18 +1,17 @@
 <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>
-    <li><a href="#Can I include images and picture"> Can I include images and pictures?</a></li>
+    <li><a href="#Can I include images on a page?"> Can I include images on a page?</a></li>
     <li><a href="#Can I write colored text?"> Can I write colored text?</a></li>
   </ul>
 </div>
@@ -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.
+> Create a separator - a horizontal rule - by entering three dashes at the beginning of a blank line: `---`. You can enter more than three if you like, for a more visible separator in edit mode: <br />`--------------`
 >
 > ----
 >
 >
 > ### <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. 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.
+> TWiki interprets text as HTML, and the '&lt;' and '&gt;' characters define where HTML commands start and end. Text _inside_ angle brackets is treated as HTML, and ignored if it doesn't actually do anything - either way, the brackets and its contents are not displayed.
 >
 > 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 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; tag:
 >
 >     This text will keep its format as it is:
 >     <verbatim>
@@ -78,7 +77,7 @@
 >       aaa             12.00   3      36.00
 >     </verbatim>
 >
-> 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.
+> The `pre` tag is standard HTML; `verbatim` is a special TWiki tag that forces text to fixed font mode, and also prevents other tags and TWiki shortcuts from being expanded.
 >
 > ----
 >
@@ -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.
 >
-> This is a manual process using HTML commands. Here is an example. If you enter this:
+> **_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]]
 >
 > ----
 >
-> ### <a name="Can I include images and picture"></a> Can I include images and pictures?
+> ### <a name="Can I include images on a page?"></a> Can I include images on a page?
 >
-> Yes, this is possible. The easiest way of including images is to attach a GIF, JPG or PNG file to a topic and then to include it with text `%ATTACHURL%/myImage.gif` . [[FileAttachment]] has more.
+> Yes. The easiest way is to [[attach|Main/FileAttachment]] a GIF, JPG or PNG file to a topic and then to place it with: `%ATTACHURL%/myImage.gif`. This works only for the page that the image is attached to.
 >
-> There are actually two ways of including inline images.
+> To place an image on any page, ther are 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.
+> 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|Main/WebHome#ImgUpload]] 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_**
+> <a name="ImgUpload"></a> You can upload images directly to your server with FTP access. You can also [[attach|Main/FileAttachment]] image files to a topic - you could even create a dedicated image topic, like `ImageLibrary` - and then link to the images directly:
 >
-> 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.
+> - Attach `pic.gif` to `Someweb.SomeTopic`<br /> Display with <code>http://www.dementia.org/twiki//view/Someweb/SomeTopic/pic.gif</code>
 >
-> - 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.
+> **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.
+>
+> - **_You enter:_** `TWiki <img src="http://www.dementia.org/twiki//view/wikiHome.gif" width="46" height="50" border="0" alt="logo" /> logo.`<br />**_Result:_**<br /> TWiki <img src="http://www.dementia.org/twiki//view/wikiHome.gif" width="46" height="50" alt="logo" /> 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.
+> [[TWikiPreferences]] defines some commonly used colors: **%YELLOW% %YELLOW%%ENDCOLOR%, %RED% %RED%%ENDCOLOR%, %PINK% %PINK%%ENDCOLOR%, %PURPLE% %PURPLE%%ENDCOLOR%, %TEAL% %TEAL%%ENDCOLOR%, %NAVY% %NAVY%%ENDCOLOR%, %BLUE% %BLUE%%ENDCOLOR%, %AQUA% %AQUA%%ENDCOLOR%, %LIME% %LIME%%ENDCOLOR%, %GREEN% %GREEN%%ENDCOLOR%, %OLIVE% %OLIVE%%ENDCOLOR%, %MAROON% %MAROON%%ENDCOLOR%, %BLACK% %BLACK%%ENDCOLOR%, %GRAY% %GRAY%%ENDCOLOR%, %SILVER% %SILVER%%ENDCOLOR%** and **%ENDCOLOR%**.
 >
-> "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:
+> - **_You enter:_** `%RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%`
+>     **_Result:_** %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%
 >
-> <table>
->   <tr bgcolor="#e0e0e0">
->     <td><font color="#000000"> <strong>Black:</strong> </font></td>
->     <td><code>"#000000"</code></td>
->     <td><font color="#008000"> <strong>Green:</strong> </font></td>
->     <td><code>"#008000"</code></td>
->     <td><font color="#c0c0c0"> <strong>Silver:</strong> </font></td>
->     <td><code>"#c0c0c0"</code></td>
->     <td><font color="#00ff00"> <strong>Lime:</strong> </font></td>
->     <td><code>"#00ff00"</code></td>
->   </tr>
->   <tr bgcolor="#c0c0c0">
->     <td><font color="#808080"> <strong>Gray:</strong> </font></td>
->     <td><code>"#808080"</code></td>
->     <td><font color="#808000"> <strong>Olive:</strong> </font></td>
->     <td><code>"#808000"</code></td>
->     <td><font color="#ffffff"> <strong>White:</strong> </font></td>
->     <td><code>"#ffffff"</code></td>
->     <td><font color="#ffff00"> <strong>Yellow:</strong> </font></td>
->     <td><code>"#ffff00"</code></td>
->   </tr>
->   <tr bgcolor="#e0e0e0">
->     <td><font color="#800000"> <strong>Maroon:</strong> </font></td>
->     <td><code>"#800000"</code></td>
->     <td><font color="#000080"> <strong>Navy:</strong> </font></td>
->     <td><code>"#000080"</code></td>
->     <td><font color="#ff0000"> <strong>Red:</strong> </font></td>
->     <td><code>"#ff0000"</code></td>
->     <td><font color="#0000ff"> <strong>Blue:</strong> </font></td>
->     <td><code>"#0000ff"</code></td>
->   </tr>
->   <tr bgcolor="#c0c0c0">
->     <td><font color="#800080"> <strong>Purple:</strong> </font></td>
->     <td>="#800080"= </td>
->     <td><font color="#008080"> <strong>Teal:</strong> </font></td>
->     <td><code>"#008080"</code></td>
->     <td><font color="#ff00ff"> <strong>Fuchsia:</strong> </font></td>
->     <td><code>"#ff00ff"</code></td>
->     <td><font color="#00ffff"> <strong>Aqua:</strong> </font></td>
->     <td><code>"#00ffff"</code></td>
->   </tr>
-> </table>
+> **_Note:_** `%<color>%` text must end with `%ENDCOLOR%` . If you want to switch from one color to another one you first need to end the active color with `%ENDCOLOR%`, e.g. write `%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%`.
+>
+> If you need more colors you can use HTML, like `<font color="#ff0000"> red text </font>`. You can also use the up-to-date `style` attribute - ex: `style="color:#ff0000"` - placed in most HTML tags. `span` is an all-purpose choice: `<span style="color:#ff0000">CoLoR</span>`. Only old (like 3.x IE &amp; NS) browsers have a problem with `style`.
 >
-> - Example text: <br />` <font color="#ff0000"> Red color </font> draws attention. `
-> - Example output: <br /><font> Red color </font> draws attention.
+> The code 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 `"#ff000"` for Web page purposes. [[StandardColors]] lists basic colors.
 >
 > ----
 
--- [[MikeMannix]] - 10 Sep 2001 <br /> -- [[PeterThoeny]] - 13 Sep 2001 <br />
+-- [[PeterThoeny]] - 21 Feb 2002 <br /> -- [[MikeMannix]] - 14 Sep 2001 <br />