# <a name="Frequently Asked Questions About"></a> Frequently Asked Questions About %WIKITOOLNAME%
-This is a real FAQ and a demo application - one way to implement a knowledge base solution.
+This is a real FAQ, and also a demo of one easily implemented knowledge base solution.
# <a name="TWiki Installation Error"></a> TWiki Installation Error
Incorrect format of search template (missing sections? There should be 4 %SPLIT% tags)
-**_Note:_** The most up to date list of this FAQ is at TWiki:TWiki/TWikiFAQ.
+**_NOTE:_** The most recent version of this FAQ is at TWiki:TWiki/TWikiFAQ.
## <a name="Submit a new FAQ"></a> Submit a new FAQ
-<form action="http://www.dementia.org/twiki//edit/%WEB%/"> New FAQ topic: (Use a name in [[TWiki/WikiNotation]]) <br /><input name="topic" size="32" type="text" /> <input name="onlywikiname" type="hidden" value="on" /> <input name="templatetopic" type="hidden" value="TWikiFaqTemplate" /> <input type="submit" value="Create Topic" /><br /><strong><em>Note:</em></strong> New FAQ topics are based on the [[Main/TWikiFaqTemplate]]</form>
+<form action="http://www.dementia.org/twiki//edit/%WEB%/"> New FAQ topic: (Use a name in [[TWiki/WikiNotation]]) <br /><input name="topic" size="32" type="text" /> <input name="onlywikiname" type="hidden" value="on" /> <input name="templatetopic" type="hidden" value="TWikiFaqTemplate" /> <input type="submit" value="Create Topic" /><br /><strong><em>NOTE:</em></strong> New FAQ topics are based on the [[Main/TWikiFaqTemplate]]</form>
-## <a name="Read more"></a> Read more
+## <a name="More sources..."></a> More sources...
-Other places where you can find an answer to your question:
+Other places where you can find answers to your questions:
-- [[TWikiDocumentation]]: All you need to know to install and configure %WIKITOOLNAME%.
-- [[TWikiTutorial]]: Get a jump start on TWiki.
-- [[GoodStyle]]: Things to consider when changing text.
-- [[WikiSyntax]], [[TextFormattingRules]]: Easy to learn rules when editing text.
-- [[TextFormattingFAQ]]: Answers to frequently asked questions about text formatting.
-- If you can't find an answer you can ask a question in the TWiki.Support web at TWiki:Support.
+- [[TWikiDocumentation]]: All you need to know to install and configure %WIKITOOLNAME%
+- [[TWikiTutorial]]: Get a jump start on using TWiki
+- [[GoodStyle]]: Things to consider when changing text
+- [[WikiSyntax]], [[TextFormattingRules]]: A quick one-two guide to TWiki shorthand basics
+- [[TextFormattingFAQ]]: Answers to frequently asked questions about text styling in TWiki
+- If you can't find an answer, ask a question - post it in the TWiki:Support web
--- [[PeterThoeny]] - 26 Nov 2000 <br />
+-- [[PeterThoeny]] - 26 Nov 2000 <br /> -- [[MikeMannix]] - 13 Sep 2001 <br />
<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 <filename> 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>
>
> ### <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.
+> You can make a horizontal separator by entering three dashes at the beginning of a line: `---`.
>
> ----
>
>
> If you want to display angle brackets, enter them as HTML codes instead of typing them in directly:
>
-> - - `<` = `<`
-> - `>` = `>`
-> - Enter: `(a > 0)` to get `(a > 0)`
+> - `<` = `<`<br />`>` = `>`
+>
+> - **_You enter:_** `(a > 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 <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>
> 2. Use HTML tables with <table>, <tr>, <td> tags.
> 3. Use preformatted text with <verbatim> 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 <table>, <tr>, <td> tags_**
+> **2\. Use HTML tables with <table>, <tr>, <td> tags**
>
-> This is a manual process using HTML commands. Here is an example. If you enter this:
+> This is a manual process using HTML commands.
+>
+> **_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 <verbatim> tags_**
+> **3\. Use preformatted text with <verbatim> 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]]
>
> ----
>
>
> There are actually 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.
>
-> - Example text: <br />` TWiki http://www.dementia.org/twiki//view/wikiHome.gif logo.`
-> - Example output: <br /> TWiki  logo.
+> - **_You enter:_** ` TWiki http://www.dementia.org/twiki//view/wikiHome.gif logo.`<br />**_Result:_** TWiki  logo.
>
-> **_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.
>
-> - 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.
+> - **_You enter:_** `TWiki <img src="http://www.dementia.org/twiki//view/wikiHome.gif" width="46" height="50" /> logo.`<br />**_Result:_**<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 <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).
+>
+> 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">.
>
-> "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:
+> "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 <code>"#ff000=" for Web page purposes. For a basic color selection (you can [[StandardColor|Main/StandardColors]] names instead of hex code in the =font</code> tag only):
>
> <table>
> <tr bgcolor="#e0e0e0">
> </tr>
> </table>
>
-> - Example text: <br />` <font color="#ff0000"> Red color </font> draws attention. `
-> - Example output: <br /><font> Red color </font> draws attention.
+> - **_You enter:_** ` <font color="#ff0000"> Red color </font> draws attention. `
+> **_Result:_** <font> Red color </font> draws attention.
>
> ----
--- [[MikeMannix]] - 10 Sep 2001 <br /> -- [[PeterThoeny]] - 13 Sep 2001 <br />
+-- [[PeterThoeny]] - 13 Sep 2001 <br /> -- [[MikeMannix]] - 14 Sep 2001 <br />
-## <a name="TWiki Language by the Line"></a> TWiki Language by the Line
+# <a name="TWiki Shorthand, Quickly"></a> TWiki Shorthand, Quickly
+
+If you can enter text, send an email, your ready for TWiki. Use some simple, intuitive TWiki shorthand, and you have even more control - instantly!
- Separate each **paragraph** with a blank line.
-- To display a word or phrase in **bold type**, surround it by asterisks: `*bold type*`
+- To display a word or phrase in **bold type**, put it in asterisks: `*bold type*`.
-- To display a word or phrase in _italic_, surround it by underscores: `_italic_`
+- To display a word or phrase in _italic_, put it in underscores: `_italic_`.
-- To display a word or phrase in **_bold italic_**, surround it by double underscores: `__bold italic__`
+- To display a word or phrase in **_bold italic_**, put it in _double_ underscores: `__bold italic__`.
-- **To link** to another Wiki topic, type the [[WikiWord]] for that topic. To link to a Wiki topic in another web, type the name of the web, a dot, and the WikiWord for that topic: <code>**Test.WebHome**</code>.
+- To link to another Wiki topic, type the [[WikiWord]] for that topic. To link to a Wiki topic in another web, type the name of the web, and a dot, first: `Test.WebHome`.
-- If you add a [[WikiWord]] for a topic that doesn't exist, you'll see a question mark after it, prompting you (or someone else) to edit the new topic: [[FreshTopic]]. Once edited, enter the new WikiName and it will appear as a link to the that page.
+- If you enter a [[WikiWord]] for a topic that doesn't exist, it'll appear highlighted, with question mark at the end, prompting you (or someone else) to start off the new topic by clicking the **?** - [[FreshTopic]] (click the **?**, but don't save, to preserve the example!).
-- When entering WikiName links, include the home web name as a prefix, ex: all TWiki member pages are in the Main web, so enter <code>**Main.YourName**</code>.
+- When entering WikiName signatures - like, admin - include the Main as a prefix, since all TWiki member pages are in the Main web: `Main.YourName`.
-- For an external link, just type the URL, starting with <code>**http://**</code>.
+- For an external link, type the full URL: `http://twiki.org`.
-- To prevent a WikiName from becoming a link, type `<nop>` first, <code>**<nop>NoLinkPlease**</code>.
+- To prevent a WikiWord from becoming a link, type `<nop>` first, <code>**<nop>NoLinkPlease**</code>.
-- To indent with a **bullet**, enter space-space-space-asterisk-space.
- - Use a multiple of 3 spaces to start **nested bullets**.
+- To indent with a bullet, enter `[space][space][space][asterisk][space]`.
+ - Use multiples of 3 spaces to start **nested bullets**.
+ - Thats 3-6-9-...
-1. Start items in a **numbered list** with space-space-space-1-space.
-2. The "1" (or **any number**) will be replaced by the correct number in order.
+1. Start items in a **numbered list** with `[space][space][space][1][space]`.
+2. The "1" (or **any number**) will be replaced by the correct number, in order.
- Always start **counting** for bullets and such from the beginning of a new line.
-- To include an **image**, type its URL. You also can Attach an image to the page and display it with text `%ATTACHURL%/yourimagefilename.jpg` .
+- To include an image, type its URL. You also can Attach an image to the page and display it with text <br />=%ATTACHURL%/yourimagefilename.jpg=.
-- To display a word or phrase in `MONOSPACED TYPE`, surround it by '=' characters. Use two for bold: <code>**bold mono**</code> .
+- To display a word or phrase in `MONOSPACED TYPE`, put it in equal signs: `=like this=`. <br />Use `==two==` for bold: <code>**bold mono**</code>.
Surround code excerpts, filenames, and other
unformatted text with <pre> or </pre>
- <verbatim> and </verbatim> tags.
+ or the special TWiki use <verbatim> and
+ </verbatim> tags.
-- Use three or more consecutive **hyphens** for a horizontal rule: `---`
+- Use three (or more) consecutive **hyphens** expands into a horizontal rule: `---`
-- To see the markup for any page, click on **Raw text** on the lower toolbar.
+----
- See [[TextFormattingRules]] for more....
+
+-- [[MikeMannix]] - 14 Sep 2001 <br />
git://git.openafs.org / openafs-wiki.git / commitdiff