</tr>
<tr>
<td><code>%GMTIME%</code></td>
- <td> GM time, is <b>29 Jun 2010 - 15:28</b></td>
+ <td> GM time, is <b>29 Jun 2010 - 15:29</b></td>
</tr>
<tr>
<td><code>%GMTIME{"format"}%</code></td>
<td> 2 digit year </td>
<td> 99 </td>
</tr>
- </table> Variables can be shortened to 3 characters. Example: <br /><code>%GMTIME{"$day $month, $year - $hour:$min:$sec"}%</code> is <br /><b>29 Jun, 2010 - 15:28:27</b></td>
+ </table> Variables can be shortened to 3 characters. Example: <br /><code>%GMTIME{"$day $month, $year - $hour:$min:$sec"}%</code> is <br /><b>29 Jun, 2010 - 15:29:26</b></td>
</tr>
<tr>
<td><code>%SERVERTIME%</code></td>
- <td> Server time, is <b>29 Jun 2010 - 11:28</b></td>
+ <td> Server time, is <b>29 Jun 2010 - 11:29</b></td>
</tr>
<tr>
<td><code>%SERVERTIME{"format"}%</code></td>
- <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:28</b></td>
+ <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:29</b></td>
</tr>
<tr>
<td><code>%HTTP_HOST%</code></td>
- You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.
-> <span><font>**HOW-TO: Create a custom logo variable**</font></span>
+> **Example: Create a custom logo variable**
>
> <br />
>
-> To place a logo anywhere in a web by typing
->
-> <code>**%MYLOGO%**</code>
->
-> , simply define the variable on the web's
->
-> [[WebPreferences]]
->
-> page. In this case, you also have to upload
->
-> <code>**logo.gif**</code>
->
-> to the same directory.:
->
-> - - <code>**Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif**</code>
+> - To place a logo anywhere in a web by typing <code>**%MYLOGO%**</code>, simply define the variable on the web's [[WebPreferences]] page. You also have to upload `logo.gif` - this can be done by [[attaching a file|Main/FileAttachment]] to `LogoTopic` (any topic name you choose):
+> - <code>**Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif**</code>
-- [[MikeMannix]] - 30 Aug 2001 <br />
</ul>
</li>
<li><a href="#TWiki Variables"> TWiki Variables</a></li>
- <li><a href="#"Gotchas" when Editing Text"> "Gotchas" when Editing Text</a></li>
+ <li><a href="#Common Editing Errors"> Common Editing Errors</a></li>
<li><a href="#TWiki Plugins"> TWiki Plugins</a></li>
</ul>
</li>
Working in TWiki is as easy as typing in text - exactly like email. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter [[WikiWords]]. And TWiki shorthand gives you all the power of HTML with a simple coding system that takes no time to learn. It's all layed out below - refer back to this page in a pop-up window from the **Edit** screen.
+<a name="TWikiShorthand"></a>
+
## <a name="TWiki Editing Shorthand"></a> TWiki Editing Shorthand
<table bgcolor="#000000" border="0" cellpadding="3" cellspacing="1">
</td>
</tr>
<tr bgcolor="#ffffff">
- <td valign="top"><strong>Forced Links:</strong><br /> You can create a forced internal link by enclosing words in double square brackets. <br /><strong><em>Note:</em></strong> Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; i.e. <code>[[text formatting FAQ]]</code> links to topic [[Main/TextFormattingFAQ]]. You can also refer to a different web and use anchors. </td>
+ <td valign="top">#SquareBrackets <strong>Forced Links:</strong><br /> You can create a forced internal link by enclosing words in double square brackets. <br /><strong><em>Note:</em></strong> Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; i.e. <code>[[text formatting FAQ]]</code> links to topic [[Main/TextFormattingFAQ]]. You can also refer to a different web and use anchors. </td>
<td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
[[wiki syntax]]
## <a name="Using HTML"></a> Using HTML
-Most HTML tags will work, but it's almost always preferable not to use HTML, so that the markup remains easy for everyone to edit.
+You can use just about any HTML tag without a problem - however, to keep in mind:
+
+- On collaboration pages, it's preferable NOT to use HTML, and to use [[TWiki shorthand|Main/WebHome#TWikiShorthand]] instead - this keeps the text uncluttered and easy to edit.
+ - **_NOTE:_** TWiki converts shorthand notation to XHTML 1.0 for display. To copy a fully marked-up page, simply view source in your browser and save the contents.
+ - **_NOTE:_** The standard installation TWiki is compatible across a wide range of browsers and computer platforms. If this is important to you, remember that using browser-specific tags or any other mark-up that doesn't degrade well will reduce compatibility.
## <a name="Hyperlinks"></a> Hyperlinks
-Being able to create links without any formatting required is a core TWiki feature, made possible using [[WikiNames]]. With the latest version of TWiki linking rules, a simple extension of the syntax provides an new set of flexible linking options.
+Being able to create links without any formatting required is a core TWiki feature, made possible with [[WikiWords]]. New TWiki linking rules are a simple extension of the syntax that provide a new set of flexible options.
### <a name="Internal Links"></a> Internal Links
- [[GoodStyle]] is a [[WikiWord]] that links to the GoodStyle topic located in the current %WIKITOOLNAME% 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!)
+
+- [[NotExistingYet]] is a topic waiting to be written. Create the topic by clicking on the **?**. (Try clicking, but then, **Cancel** - creating the topic would wreck this example!)
### <a name="External Links"></a> External Links
- `http://...`, `https://...`, `ftp://...` and `mailto:...@...` are linked automatically.
+
- Email addresses like `name@domain.com` are linked automatically.
+- `[[Square bracket rules]]` let you easily create [[non-WikiWord links|Main/WebHome#SquareBrackets]].
+
## <a name="TWiki Variables"></a> TWiki Variables
-Variables are names that are enclosed in percent signs; they get expanded on the fly.
+Variables are names that are enclosed in percent signs `%` that are expanded on the fly.
+
+- `%TOC%` : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.
+
+- `%WEB%` : The current web, is **%WEB%**.
+
+- `%TOPIC%` : The current topic name, is **%TOPIC%**.
-- `%TOC%` : The table of content, is based on headings in a topic.
-- `%WEB%` : The current web, is **%WEB%** .
-- `%TOPIC%` : The current topic name, is **%TOPIC%** .
- `%ATTACHURL%` : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as <code>**%ATTACHURL%/image.gif**</code> to show the URL of the file or the image in your text.
+
- `%INCLUDE{"SomeTopic"}%` : Server side include, includes another topic. The current %WIKITOOLNAME% web is the default web. Example: <code>**%INCLUDE\{"TWiki.TWikiWebsTable"\}%**</code>
-- There are many more variables, see [[TWikiVariables]].
-## <a name=""Gotchas" when Editing Text"></a> "Gotchas" when Editing Text
+- There are many more variables, see **[[TWikiVariables]]**.
-The formatting rules are fairly simple to use and fast to type. However, there are some things to watch out for:
+## <a name="Common Editing Errors"></a> Common Editing Errors
+
+TWiki formatting rules are fairly simple to use and quick to type. However, there are some things to watch out for, taken from the [[TextFormattingFAQ]]:
- **Q:** Text enclosed in angle brackets like `<filename>` is not displayed. How can I show it as it is?
- **A:** The `'<'` and `'>'` characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write `'<'` instead of `'<'`, and `'>'` instead of `'>'`. <br /> Example: Type `'prog <filename>'` to get `'prog <filename>'`.
- **Q:** Why is the `'&'` character sometimes not displayed?
- **A:** The `'&'` character has a special meaning in HTML, it starts a so called character entity, i.e. `'©'` is the `©` copyright character. You need to escape `'&'` to see it as it is, so write `'&'` instead of `'&'`. <br /> Example: Type `'This & that'` to get `'This & that'`.
-- See more [[TextFormattingFAQs]]
-
## <a name="TWiki Plugins"></a> TWiki Plugins
-Plugins provide additional text formatting rules and can extend the functionality of %WIKITOOLNAME% into many other areas. Available Plugins are located in the [[Plugins|Main/TWiki:Plugins]] web. Currently enabled plugins on this site are:
+Plugins provide additional text formatting capabilities and can extend the functionality of %WIKITOOLNAME% into many other areas. For example, one optional Plugin lets you create a basic spreadsheet in a similar way to tables. Available Plugins are located in the [[Plugins|Main/TWiki:Plugins]] web on TWiki.org. Currently enabled plugins on here:
- [[SpreadSheetPlugin]] <span>(any TWiki, 10197)</span>:
- [[CommentPlugin]] <span>(Dakar, 11359)</span>: Allows users to quickly post comments to a page without an edit/preview/save cycle
git://git.openafs.org / openafs-wiki.git / commitdiff