(r15)TextFormattingFAQ < TWiki

View topic | ~~Edit~~ | ~~WYSIWYGAttach~~Printable
r15 - 22 Aug 2003 - 05:19:29 - PeterThoeny^?You are here: TWiki >
TWiki Web > TextFormattingFAQ
---++!! Text Formatting FAQ

The most frequently asked questions about text formatting are answered. Also, TextFormattingRules contains the complete TWiki shorthand system on one quick reference page.

%TOC%

<blockquote>
---
---+++ How do I make a separator?

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 />
=--------------=

--------------
---+++ How do I create a heading?

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?=.
   * You can insert a nested table of contents, generated from headings, by placing =%<nop>TOC%= wherever you like on a page (see %TWIKIWEB%.TWikiVariables for more =%<nop>TOC%= options).

-----
#TextEnclosed
---+++ 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, 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:
   * =&amp;lt;= = =&lt;= <br />
     =&amp;gt;= = =&gt;=

   * __You enter:__ =(a &amp;gt; 0)= <p /> 
     __Result:__ =(a &gt; 0)=

---
---+++ 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 a new branch to the topic.  

To prevent auto-linking - say you want to enter a word like <nop>JavaScript (the proper spelling!) - prefix the WikiStyleWord with the special TWiki HTML tag =&lt;nop&gt;=: 

   * =&lt;nop&gt;WikiStyleWord= displays as <nop>WikiStyleWord

---
---+++ How can I write fixed font text?

The quickest way is to enclose the text in equal signs:

   * __You enter:__ =Proportional text, <nop>=fixed font=<nop>, proportional again.= <p />
     __Result:__ Proportional text, =fixed font=, proportional again.

---
#VerbatimText
---+++ Text I enter gets wrapped around. How can I keep the formatting as it is?

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:
<pre>
This text will keep its format as it is:
&lt;verbatim&gt;
  Unit     Price   Qty  Cost
  -------  ------  ---  ------
  aaa       12.00    3   36.00
&lt;/verbatim&gt;
</pre>

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.

---
---+++ 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;verbatim&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: 
     | cell A1 | cell B1 | cell C1 |
     | cell A2 | cell B2 | cell C2 |

*2. Use HTML tables with &lt;table&gt;, &lt;tr&gt;, &lt;td&gt; tags*

This is a manual process using HTML commands. 

__You enter:__

<pre>
&lt;table border="1"&gt;
  &lt;tr&gt;
    &lt;th&gt; Head A  &lt;/th&gt; &lt;th&gt; Head B  &lt;/th&gt;
  &lt;/tr&gt;&lt;tr&gt;
    &lt;td&gt; Cell A2 &lt;/td&gt; &lt;td&gt; Cell B2 &lt;/td&gt;
  &lt;/tr&gt;&lt;tr&gt;
    &lt;td&gt; Cell A3 &lt;/td&gt; &lt;td&gt; Cell B3 &lt;/td&gt;
  &lt;/tr&gt;
&lt;/table&gt;
</pre>

__Result:__

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

*3. Use preformatted text with &lt;verbatim&gt; tags*

See [[#VerbatimText]["Text I enter gets wrapped around..."]] 

---
---+++ Can I include images on a page?

Yes. The easiest way is to [[FileAttachment][attach]] a GIF, JPG or PNG file to a topic and then to place it with: =%<nop>ATTACHURL%/myImage.gif=. This works only for the page that the image is attached to.

To place an image on any page, ther are two ways of including inline images.

*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 [[#ImgUpload][accessible]] as a URL.

   * __You enter:__ <code> TWiki <nop>%PUBURL%/%TWIKIWEB%/TWikiLogos/twikilogo88x31.gif logo.</code> <br />
     __Result:__ TWiki %PUBURL%/%TWIKIWEB%/TWikiLogos/twikilogo88x31.gif logo.

#ImgUpload
You can upload images directly to your server with FTP access. You can also [[FileAttachment][attach]] image files to a topic - you could even create a dedicated image topic, like =ImageLibrary= - and then link to the images directly:
   * Attach =pic.gif= to =Someweb.SomeTopic= <br />
     Display with =<no>%PUBURL%/Someweb/<nop>SomeTopic/pic.gif=

*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:__ <code>TWiki &lt;img src="%PUBURL%/%TWIKIWEB%/TWikiLogos/twikilogo88x31.gif" width="88" height="31" border="0" alt="logo" /&gt; logo.</code><br />
     __Result:__ <br /> TWiki <img src="%PUBURL%/%TWIKIWEB%/TWikiLogos/twikilogo88x31.gif" width="88" height="31" border="0" alt="logo" /> logo.

-----
---+++ Can I write colored text?

TWikiPreferences defines some commonly used colors: *%YELLOW% %<nop>YELLOW%%ENDCOLOR%, %RED% %<nop>RED%%ENDCOLOR%, %PINK% %<nop>PINK%%ENDCOLOR%, %PURPLE% %<nop>PURPLE%%ENDCOLOR%, %TEAL% %<nop>TEAL%%ENDCOLOR%, %NAVY% %<nop>NAVY%%ENDCOLOR%, %BLUE% %<nop>BLUE%%ENDCOLOR%, %AQUA% %<nop>AQUA%%ENDCOLOR%, %LIME% %<nop>LIME%%ENDCOLOR%, %GREEN% %<nop>GREEN%%ENDCOLOR%, %OLIVE% %<nop>OLIVE%%ENDCOLOR%, %MAROON% %<nop>MAROON%%ENDCOLOR%, %BLACK% %<nop>BLACK%%ENDCOLOR%, %GRAY% %<nop>GRAY%%ENDCOLOR%, %SILVER% %<nop>SILVER%%ENDCOLOR%* and *%<nop>ENDCOLOR%*.

   * __You enter:__ =%<nop>RED% red text %<nop>ENDCOLOR% and %<nop>GREEN% green text %<nop>ENDCOLOR%= <p /> 
     __Result:__ %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%

__Note:__ =%&lt;color&gt;%= text must end with =%<nop>ENDCOLOR%= . If you want to switch from one color to another one you first need to end the active color with =%<nop>ENDCOLOR%=, e.g. write =%<nop>RED% some text %<nop>ENDCOLOR% %<nop>GREEN% more text %<nop>ENDCOLOR%=.

If you need more colors you can use HTML, like =&lt;font color="#ff0000"&gt; red text &lt;/font&gt;=. 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: =&lt;span style="color:#ff0000"&gt;CoLoR&lt;/span&gt;=. Only old (like 3.x IE &amp; NS) browsers have a problem with =style=.

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.

-----
</blockquote>

-- PeterThoeny - 21 Feb 2002 <br />
-- MikeMannix - 14 Sep 2001 <br />
TWiki
TWiki Web
Webs
Main
TWiki
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TextFormattingFAQ