Difference: TextFormattingFAQ (8 vs. 9)

Revision 92001-09-14 - PeterThoeny

 Text Formatting FAQ
Changed:
<
<
  • The most frequently asked questions about text formatting are answered here.
>
>
The most frequently asked questions about text formatting are answered. Also, TextFormattingRules contains the complete TWiki shorthand system on one quick reference page.
Deleted:
<
<
 


How do I make a separator?

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

How do I create a heading?

You can create six sizes of headings - <h1>...<h6> 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 %TOC% wherever you like on a page (see TWikiVariables for more %TOC% options).


Text enclosed in angle brackets like <filename> is not displayed. How can I show it as it is?

TWiki interprets text as HTML. The '<' and '>' 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.

If you want to display angle brackets, enter them as HTML codes instead of typing them in directly:

Changed:
<
<
    • &lt; = <
    • &gt; = >
>
>
  • &lt; = <
    &gt; = >
Deleted:
<
<
    • Enter: (a &gt; 0) to get (a > 0)
 
Added:
>
>
  • You enter: (a &gt; 0)

    Result: (a > 0)

 
Changed:
<
<

Some words (like WinAPI) have an unwanted question mark at the end. How can I prevent that?

>
>

Some words appear highlighted, with a "?" link at the end. How can I prevent that?

 
Changed:
<
<
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.
 
Changed:
<
<
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>:
 
Changed:
<
<
  • <nop>WikiWord displays as WikiWord
>
>
  • <nop>WikiStyleWord displays as WikiStyleWord
 

How can I write fixed font text?

Changed:
<
<
Enclose text in "=" equal signs:
>
>
The quickest way is to enclose the text in equal signs:
 
Changed:
<
<
  • Proportional text, =fixed font text=, proportional again. appears as...
    Proportional text, fixed font text , proportional again.
>
>
  • You enter: Proportional text, =fixed font=, proportional again.

    Result: Proportional text, fixed font, proportional again.

 
Deleted:
<
<
Alternatively you could also use preformatted text, see next question for details.
 

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

Changed:
<
<
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 <pre> </pre> or <verbatim> </verbatim> 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 <pre> </pre>, or in TWiki's own <verbatim> </verbatim> tags:
 
This text will keep its format as it is:
<verbatim>
  Unit	  Price	Qty  Cost
  -------  ------  ---  ------
  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.


How do I create tables?

There are three possibilities:

  1. Use Wiki rule with "|" vertical bars.
  2. Use HTML tables with <table>, <tr>, <td> tags.
  3. Use preformatted text with <verbatim> tags.
Changed:
<
<
1. Use Wiki rule with "|" vertical bars
>
>
1. Use Wiki rule with "|" vertical bars
 
  • Example text:
    | cell A1 | cell B1 | cell C1 |
    | cell A2 | cell B2 | cell C2 |
  • Example output:
    cell A1 cell B1 cell C1
    cell A2 cell B2 cell C2
Changed:
<
<
2. Use HTML tables with <table>, <tr>, <td> tags
>
>
2. Use HTML tables with <table>, <tr>, <td> tags
 
Changed:
<
<
This is a manual process using HTML commands. Here is an example. If you enter this:
>
>
This is a manual process using HTML commands.
 
Added:
>
>
You enter:
 
<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>
Changed:
<
<
It is displayed as a table like this:
>
>
Result:
 
Head A Head B
Cell A2 Cell B2
Cell A3 Cell B3
Changed:
<
<
3. Use preformatted text with <verbatim> tags
>
>
3. Use preformatted text with <verbatim> tags
 
Changed:
<
<
Text I enter gets wrapped around. How can I keep the formatting as it is? See "Text enclosed..."
>
>
See "Text enclosed..."
 

Can I include images and pictures?

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.

There are actually two ways of including inline images.

Changed:
<
<
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.
Changed:
<
<
  • Example text:
    TWiki https://wiki.ivoa.net/internal/wikiHome.gif logo.
  • Example output:
    TWiki wikiHome.gif logo.
>
>
  • You enter: TWiki https://wiki.ivoa.net/internal/wikiHome.gif logo.
    Result: TWiki wikiHome.gif logo.
 
Changed:
<
<
2. Using <img> tag
>
>
2. Using <img> tag
  This is a manual process where you have more control over the rendering of the image. Use the <img> 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.
Changed:
<
<
  • Example text:
    TWiki <img src="https://wiki.ivoa.net/internal/wikiHome.gif" width="46" height="50" /> logo.
  • Example output:
    TWiki logo.
>
>
  • You enter: TWiki <img src="https://wiki.ivoa.net/internal/wikiHome.gif" width="46" height="50" /> logo.
    Result:
    TWiki logo.
 

Can I write colored text?

Changed:
<
<
Place text you would like to specify a color inside <font color="colorCode"> and </font> tags.
>
>
Sure. The quickest way is to use the <font color="colorCode"> and </font> tags - they're HTML tags that work in any browser, (although they've been phased in the latest version).
 
Changed:
<
<
"colorCode" is the hexadecimal RGB color code. The color is composed
>
>
You can also use a style attribute: style="color:#ff0000", placed in most HTML tags - span is an all-purpose choice: "<span style="color:#ff0000">.
Deleted:
<
<
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:
 
Added:
>
>
"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 "#ff000=" for Web page purposes. For a basic color selection (you can StandardColor names instead of hex code in the =font tag only):
 
Black: "#000000" Green: "#008000" Silver: "#c0c0c0" Lime: "#00ff00"
Gray: "#808080" Olive: "#808000" White: "#ffffff" Yellow: "#ffff00"
Maroon: "#800000" Navy: "#000080" Red: "#ff0000" Blue: "#0000ff"
Purple: ="#800080"= Teal: "#008080" Fuchsia: "#ff00ff" Aqua: "#00ffff"
Changed:
<
<
  • Example text:
    <font color="#ff0000"> Red color </font> draws attention.
  • Example output:
    Red color draws attention.
>
>
  • You enter: <font color="#ff0000"> Red color </font> draws attention.

    Result: Red color draws attention.

 
Changed:
<
<
-- MikeMannix - 10 Sep 2001
-- PeterThoeny - 13 Sep 2001
>
>
-- PeterThoeny - 13 Sep 2001
-- MikeMannix - 14 Sep 2001
 
 
This site is powered by the TWiki collaboration platform Powered by Perl This site is powered by the TWiki collaboration platformCopyright © 1999-2024 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.