summaryrefslogtreecommitdiff
path: root/TWiki/TextFormattingFAQ.mdwn
blob: 84d731bd1a5f9cd4e2ca9e226bf9abcc46b8ee39 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
**Text Formatting FAQ**

This topic has answers to frequently asked questions about text formatting. [[TextFormattingRules]] has more on formatting rules in general. It also has links to HTML documentation.

* [Q:](#sepa) How do I make a separator?
* [Q:](#head) How do I create a title or a heading?
* [Q:](#brac) Text enclosed in angle brackets like <filename> is not displayed. How can I show it as it is?
* [Q:](#ques) Some words (like [[WinAPI]]) have an unwanted question mark at the end. How can I prevent that?
* [Q:](#fixe) How can I write fixed font text?
* [Q:](#wrap) Text I enter gets wrapped around. How can I keep the formatting as it is?
* [Q:](#tabl) How do I create tables?
* [Q:](#imag) Can I include images and pictures?
* [Q:](#colo) Can I write colored text?

----

<a name="sepa">Q:</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="head">Q:</a> **How do I create a title or a heading?**

The most simple way is to enclose it in '\*' Asterisk characters or '\_' Underscore charcters.

**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="brac">Q:</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="ques">Q:</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 [[WikiTopic]] name in [[WikiNotation]], but the actual topic _WinAPI_ does not exist.

If you do not intend to create a topic for a valid TWiki topic name, 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 /><code>WinAPI as it is, &lt;NOP&gt;WinAPI with preceeding NOP.</code>
* Example output: <br />[[WinAPI]] as it is, WinAPI with preceeding NOP.

----

<a name="fixe">Q:</a> **How can I write fixed font text?**

Enclose text in &lt;CODE&gt; and &lt;/CODE&gt; HTML tags.

* Example text: <br />`Proportional text, <CODE> fixed font text, </CODE> 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="wrap">Q:</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="tabl">Q:</a> **How do I create tables?**

There are two possibilities:

1. Use preformatted text with &lt;PRE&gt; tags.
2. Use HTML tables with &lt;TABLE&gt;, &lt;TR&gt;, &lt;TD&gt; tags.

**\_1. Use preformatted text with &lt;PRE&gt; tags\_**

See [Q:](#wrap) Text I enter gets wrapped around. How can I keep the formatting as it is?

**\_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>

----

<a name="imag">Q:</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 <code>%ATTACHURL%/myImage.gif</code> . [[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 /><code> TWiki %PUBURL%/wikiHome.gif logo.</code>
* Example output: <br /> TWiki %PUBURL%/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="../../../pub/wikiHome.gif" WIDTH=46 HEIGHT=50> logo.`
* Example output: <br /> TWiki <img src="../../../pub/wikiHome.gif" width="46" height="50" /> logo.

----

<a name="colo">Q:</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". Common color codes are:

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

----

-- [[Main/PeterThoeny]] - 26 Oct 1998