none

[openafs-wiki.git] / TWiki / TextFormattingFAQ.mdwn

<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.

<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="#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>
    <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 write colored text?"> Can I write colored text?</a></li>
  </ul>
</div>

> ----
>
> ### <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.
>
> ----
>
> ### <a name="How do I create a title or a hea"></a> How do I create a title or a heading?
>
> The most simple way is to enclose it in '\*' Asterisk characters or '\_' Underscore characters.
>
> **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
>
> ----
>
> <a name="TextEnclosed"></a>
>
> ### <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.
>
> There are two work arounds if you want to display angle brackets:
>
> - 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>`
>
> ----
>
> ### <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.
>
> 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.
>
> - Example text: <br />`WinAPI as it is, <nop>WinAPI with preceding NOP.`
> - Example output: <br />[[WinAPI]] as it is, WinAPI with preceding NOP.
>
> ----
>
> ### <a name="How can I write fixed font text?"></a> How can I write fixed font text?
>
> 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.
>
> 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.
>
>     This text will keep its format as it is:
>     <PRE>
>       Unit      Price Qty  Cost
>       -------  ------  ---  ------
>       aaa              12.00   3      36.00
>     </PRE>
>
> It is recommended to use preformatting for tables and source code.
>
> ----
>
> ### <a name="How do I create tables?"></a> How do I create tables?
>
> 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.
> 3. Use preformatted text with &lt;PRE&gt; tags.
>
> **\_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>
>     <td> cell A1 </td>
>     <td> cell B1 </td>
>     <td> cell C1 </td>
>   </tr>
>   <tr>
>     <td> cell A2 </td>
>     <td> cell B2 </td>
>     <td> cell C2 </td>
>   </tr>
> </table>
>
> **\_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:
>
>     <TABLE BORDER=1>
>       <TR>
>        <TH> Head A  </TH> <TH> Head B  </TH>
>       </TR><TR>
>        <TD> Cell A2 </TD> <TD> Cell B2 </TD>
>       </TR><TR>
>        <TD> Cell A3 </TD> <TD> Cell B3 </TD>
>       </TR>
>     </TABLE>
>
> It is displayed as a table like this:
>
> <table border="1">
>   <tr>
>     <th> Head A </th>
>     <th> Head B </th>
>   </tr>
>   <tr>
>     <td> Cell A2 </td>
>     <td> Cell B2 </td>
>   </tr>
>   <tr>
>     <td> Cell A3 </td>
>     <td> Cell B3 </td>
>   </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]]
>
> ----
>
> ### <a name="Can I include images and picture"></a> Can I include images and pictures?
>
> Yes, this is possible. The easiest way of including images is to attach a GIF or JPG file to a topic and then to include it with text `%ATTACHURL%/myImage.gif` . [[FileAttachment]] has more.
>
> There are actually two ways of including inline images.
>
> **\_1. Using URL ending in .gif, .jpg, .jpeg\_**
>
> 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.
>
> **\_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 JPEG and GIF 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.
>
> ----
>
> ### <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.
>
> "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:
>
> <table>
>   <tr bgcolor="#E0E0E0">
>     <td><font color="#000000"> <strong>Black:</strong> </font></td>
>     <td>"#000000" </td>
>     <td><font color="#008000"> <strong>Green:</strong> </font></td>
>     <td>"#008000" </td>
>     <td><font color="#C0C0C0"> <strong>Silver:</strong> </font></td>
>     <td>"#C0C0C0" </td>
>     <td><font color="#00FF00"> <strong>Lime:</strong> </font></td>
>     <td>"#00FF00" </td>
>   </tr>
>   <tr bgcolor="#C0C0C0">
>     <td><font color="#808080"> <strong>Gray:</strong> </font></td>
>     <td>"#808080" </td>
>     <td><font color="#808000"> <strong>Olive:</strong> </font></td>
>     <td>"#808000" </td>
>     <td><font color="#FFFFFF"> <strong>White:</strong> </font></td>
>     <td>"#FFFFFF" </td>
>     <td><font color="#FFFF00"> <strong>Yellow:</strong> </font></td>
>     <td>"#FFFF00" </td>
>   </tr>
>   <tr bgcolor="#E0E0E0">
>     <td><font color="#800000"> <strong>Maroon:</strong> </font></td>
>     <td>"#800000" </td>
>     <td><font color="#000080"> <strong>Navy:</strong> </font></td>
>     <td>"#000080" </td>
>     <td><font color="#FF0000"> <strong>Red:</strong> </font></td>
>     <td>"#FF0000" </td>
>     <td><font color="#0000FF"> <strong>Blue:</strong> </font></td>
>     <td>"#0000FF" </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>"#008080" </td>
>     <td><font color="#FF00FF"> <strong>Fuchsia:</strong> </font></td>
>     <td>"#FF00FF"</td>
>     <td><font color="#00FFFF"> <strong>Aqua:</strong> </font></td>
>     <td>"#00FFFF" </td>
>   </tr>
> </table>
>
> - Example text: <br />` <FONT COLOR="#FF0000"> Red color </FONT> draws attention. `
> - Example output: <br /><font> Red color </font> draws attention.
>
> ----

-- [[PeterThoeny]] - 18 Aug 2000