none
authorPeterThoeny <PeterThoeny>
Mon, 9 Aug 1999 06:38:25 +0000 (06:38 +0000)
committerPeterThoeny <PeterThoeny>
Mon, 9 Aug 1999 06:38:25 +0000 (06:38 +0000)
TWiki/TWikiHistory.mdwn
TWiki/TextFormattingFAQ.mdwn
TWiki/TextFormattingRules.mdwn

index 9ca3c77..5820657 100644 (file)
 - [[PeterThoeny]] - 21 Jul 1999: Flag `$doRemovePortNumber` in wikicfg.pm to optionally remove the port number from the TWiki URL. Example: `www.some.domain:1234/twiki` gets `www.some.domain/twiki` .
 - [[PeterThoeny]] - 22 Jul 1999: Flags `$doLogTopic*` in wikicfg.pm to selectively log topic view, edit, save, rdiff, attach, search and changes to monthly log file.
 - [[PeterThoeny]] - 03 Aug 1999: Online registration of new user using web form in [[TWikiRegistration]]. Authentication of users.
+- [[PeterThoeny]] - 08 Aug 1999: New text formatting rule for creating tables. Text gets rendered as a table if enclosed in "|" vertical bars. Example line as it is written and how it shows up: <br />`| This | is | a table | with | cells |`<table border="1" cellpadding="0" cellspacing="0">
+  <tr>
+    <td> This </td>
+    <td> is </td>
+    <td> a table </td>
+    <td> with </td>
+    <td> cells </td>
+  </tr>
+</table>
 
 **Related Topics**
 
@@ -47,4 +56,4 @@
 - [[TWikiPlannedFeatures]] has a list of planned features.
 - [[TWikiEnhancementRequests]] is the place where you can add your enhancement requests.
 
--- [[PeterThoeny]] - 03 Aug 1999 <br />
+-- [[PeterThoeny]] - 08 Aug 1999 <br />
index e69de29..383c6ab 100644 (file)
@@ -0,0 +1,230 @@
+**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 &lt;filename&gt; 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 />`WinAPI as it is, <NOP>WinAPI with preceeding NOP.`
+- 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 "=" 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="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 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\_**
+
+See [Q:](#wrap) Text I enter gets wrapped around. How can I keep the formatting as it is?
+
+----
+
+<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 `%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="../../../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.
+
+----
+
+-- [[PeterThoeny]] - 08 Aug 1999
index e69de29..2adbf16 100644 (file)
@@ -0,0 +1,47 @@
+It is easy to collaborate, just type your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically as long as you follow these simple Text Formatting Rules. [[TextFormattingFAQ]] has answers to frequently asked questions about text formatting.
+
+**LINKS**
+
+The Collaborative Work Area is a bunch of related links that are editable through your web browser.
+
+The TWiki web has the following types of internal links:
+
+- [[GoodStyle]] is a topic that is part of the current TWiki web.
+- [[NotExistingYet]] is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic, you would wreck this example!)
+- [[ReadmeFirst]] is a topic in a different TWiki web. (You write it as _Web.TopicName_ , but it will show up as _TopicName_ )
+
+External links:
+
+- `http://...`, `https://...`, `ftp://...` and `mailto:...@...` are linked automatically.
+- Email addresses like <code> <name@domain.com> </code> are linked automatically.
+
+**EDITING**
+
+- [[CapitalizedWordsStickedTogether]] will produce a link automatically.
+- Blank lines will create new paragraphs.
+- Words get **bold** by enclosing them in **\*** asterisks
+- Words get _italic_ by enclosing them in **\_** underscores
+- Words get **_bold italic_** by enclosing them in **\_\_** double-underscores
+- Words get shown in `fixed font` by enclosing them in = equal signs
+- Note for **bold** , _italic_ , **_bold italic_** and `fixed font` text:
+  - Make sure to "stick" the `* _ =` signs to the characters, e.g.
+    - _This works_
+    - \_This does not get italic because there is a space between the last word and the underline character \_
+  - Example text to enter:
+    - Writing \*bold text\* , \_italic text\_ and =fixed== monospaced text
+  - Example text gets rendered as:
+    - Writing **bold text** , _italic text_ and `fixed=` monospaced text
+- Separator: -------- (at the beginning of a line)
+- List Item: &lt;3spaces&gt;\*
+- Nested Item: &lt;6spaces&gt;\*
+- Ordered List: &lt;3spaces&gt;&lt;number&gt;.
+- Definition: &lt;3spaces&gt;&lt;term&gt;:&lt;definition&gt;.
+- Table: &lt;optional spaces&gt;| cell 1 | cell 2 | cell 3 | ... |
+
+**EXTRAS**
+
+- Most HTML tags will work.
+  - Overview of all HTML elements at <http://www.htmlhelp.com/reference/wilbur/overview.html>
+  - HTML 3.2 Reference Specification at <http://www.w3.org/TR/REC-html32.html>
+
+**WIKI VARIABLES**