+<div>
+ <ul>
+ <li><a href="#TWiki Text Formatting"> TWiki Text Formatting</a><ul>
+ <li><a href="#TWiki Editing Shorthand"> TWiki Editing Shorthand</a></li>
+ <li><a href="#Using HTML"> Using HTML</a><ul>
+ <li><a href="#HTML and TWiki Usability"> HTML and TWiki Usability</a></li>
+ <li><a href="#TWiki HTML Rendering"> TWiki HTML Rendering</a></li>
+ </ul>
+ </li>
+ <li><a href="#Hyperlinks"> Hyperlinks</a><ul>
+ <li><a href="#Internal Links"> Internal Links</a></li>
+ <li><a href="#External Links"> External Links</a></li>
+ </ul>
+ </li>
+ <li><a href="#TWiki Variables"> TWiki Variables</a></li>
+ <li><a href="#TWikiPlugin Formatting Extension"> TWikiPlugin Formatting Extensions</a></li>
+ <li><a href="#Common Editing Errors"> Common Editing Errors</a></li>
+ </ul>
+ </li>
+ </ul>
+</div>
+
+# <a name="TWiki Text Formatting"></a> TWiki Text Formatting
+
+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">
+ <tr bgcolor="#ffffff">
+ <td><strong>Formatting Command:</strong></td>
+ <td><strong>Example: You write:</strong></td>
+ <td><strong>You get:</strong></td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>Paragraphs:</strong><br /> Blank lines will create new paragraphs. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+1st paragraph
+
+2nd paragraph
+</pre> </font></span></td>
+ <td valign="top"> 1st paragraph <p> 2nd paragraph </p>
+ </td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>Headings:</strong><br /> At least three dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a level 1 heading (most important), two pluses a level 2 heading; the maximum is level 6. <strong><em>Note:</em></strong> A Table of Content can be created automatically with the <code>%TOC%</code> variable, see [[Main/TWikiVariables]]. Any heading text after <code>!!</code> is excluded from the TOC; for example, write <code>---+!! text</code> if you do not want to list a header in the TOC. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+---++ Sushi
+
+---+++ Maguro
+</pre> </font></span></td>
+ <td valign="top">
+ <h2>Sushi</h2>
+ <p>
+ </p>
+ <h3>Maguro</h3>
+ </td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>Bold Text:</strong><br /> Words get <strong>bold</strong> by enclosing them in <code>*</code> asterisks. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+*Bold*
+</pre> </font></span></td>
+ <td valign="top"><strong>Bold</strong></td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>Italic Text:</strong><br /> Words get <em>italic</em> by enclosing them in <code>_</code> underscores. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+_Italic_
+</pre> </font></span></td>
+ <td valign="top"><em>Italic</em></td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>Bold Italic:</strong><br /> Words get <em>_bold italic</em> by enclosing them in <code>_</code> double-underscores. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+__Bold italic__
+</pre> </font></span></td>
+ <td valign="top"><strong><em>Bold italic</em></strong></td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>Fixed Font:</strong><br /> Words get shown in <code>fixed font</code> by enclosing them in <code>=</code> equal signs. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+=Fixed font=
+</pre> </font></span></td>
+ <td valign="top"><code>Fixed font</code></td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>Bold Fixed Font:</strong><br /> Words get shown in <code><b>bold fixed font</b></code> by enclosing them in <code><b></b></code> double equal signs. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+==Bold fixed==
+</pre> </font></span></td>
+ <td valign="top"><code><b>Bold fixed</b></code></td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong><em>Note:</em></strong> Make sure to "stick" the <code>* _ = ==</code> signs to the words, e.g. take away spaces. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+_This works_,
+_this not _
+</pre> </font></span></td>
+ <td valign="top"><em>This works</em>, _this not _ </td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>Verbatim Mode:</strong><br /> Surround code excerpts and other formatted text with <code><verbatim></code> and <code></verbatim></code> tags. <br /><strong><em>Note:</em></strong> Use <code><pre></code> and <code></pre></code> tags instead if you want that HTML code is interpreted. <br /><strong><em>Note:</em></strong> Each tag must be on a line by itself. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+<verbatim>
+class CatAnimal {
+ void purr() {
+ <code here>
+ }
+}
+</verbatim>
+</pre> </font></span></td>
+ <td valign="top"><pre>
+class CatAnimal {
+ void purr() {
+ <code here>
+ }
+}
+</pre></td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>Separator:</strong><br /> At least three dashes at the beginning of a line. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+-------
+</pre> </font></span></td>
+ <td valign="top">
+ <hr />
+ </td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>List Item:</strong><br /> Three spaces and an asterisk. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+ * bullet item
+</pre> </font></span></td>
+ <td valign="top">
+ <ul>
+ <li> bullet item </li>
+ </ul>
+ </td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>Nested List Item:</strong><br /> Six, nine, ... spaces and an asterisk. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+ * nested stuff
+</pre> </font></span></td>
+ <td valign="top">
+ <ul>
+ <li>
+ <ul>
+ <li> nested stuff </li>
+ </ul>
+ </li>
+ </ul>
+ </td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>Ordered List:</strong><br /> Three spaces and a number. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+ 1 Sushi
+ 1 Dim Sum
+</pre> </font></span></td>
+ <td valign="top">
+ <ol>
+ <li> Sushi </li>
+ <li> Dim Sum </li>
+ </ol>
+ </td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>Definition List:</strong><br /> Three spaces, the term, a colon, a space, followed by the definition. <br /><strong><em>Note:</em></strong> Terms with spaces are not supported. In case you do have a term with more then one word, separate the words with dashes or with the <code>&nbsp;</code> non-breaking-space entity. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+ Sushi: Japan
+ Dim&nbsp;Sum: S.F.
+</pre> </font></span></td>
+ <td valign="top">
+ <dl>
+ <dt> Sushi</dt>
+ <dd> Japan </dd>
+ <dt> Dim Sum</dt>
+ <dd> S.F. </dd>
+ </dl>
+ </td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>Table:</strong><br /> Optional spaces followed by the cells enclosed in vertical bars. <br /><strong><em>Note:</em></strong> <code>| *bold* |</code> cells are rendered as table headers. <br /><strong><em>Note:</em></strong> <code>| spaced |</code> cells are rendered center aligned. <br /><strong><em>Note:</em></strong> <code>| spaced |</code> cells are rendered right aligned. <br /><strong><em>Note:</em></strong> <code>| 2 colspan ||</code> cells are rendered as multi-span columns. <br /><strong><em>Note:</em></strong> In case you have a long row and you want it to be more readable when you edit the table you can split the row into lines that end with a <code>'\'</code> backslash character. <br />
+ </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+| *L* | *C* | *R* |
+| A2 | 2 | 2 |
+| A3 | 3 | 3 |
+| multi span |||
+| A4 \ | next \ | next |
+</pre> </font></span></td>
+ <td valign="top">
+ <table border="1" cellpadding="0" cellspacing="0">
+ <tr>
+ <th bgcolor="#99CCCC"><strong> L </strong></th>
+ <th bgcolor="#99CCCC"><strong> C </strong></th>
+ <th bgcolor="#99CCCC"><strong> R </strong></th>
+ </tr>
+ <tr>
+ <td> A2 </td>
+ <td align="center"> 2 </td>
+ <td align="right"> 2 </td>
+ </tr>
+ <tr>
+ <td> A3 </td>
+ <td align="center"> 3 </td>
+ <td align="right"> 3 </td>
+ </tr>
+ <tr>
+ <td colspan="3"> multi span </td>
+ </tr>
+ <tr>
+ <td> A4 </td>
+ <td> next </td>
+ <td> next </td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>WikiWord Links:</strong><br /> CapitalizedWordsStuckTogether (or [[Main/WikiWords]]) will produce a link automatically. <br /><strong><em>Note:</em></strong> In case you want to link to a topic in a different %WIKITOOLNAME% web write <code>Webname.TopicName</code>. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+WebNotify
+
+Know.ReadmeFirst
+</pre> </font></span></td>
+ <td valign="top">[[Main/WebNotify]]<p>[[Know/ReadmeFirst]]</p>
+ </td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><a name="SquareBrackets"></a> <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]]
+
+[[Main.TWiki users]]
+</pre> </font></span></td>
+ <td valign="top">[[Main/WikiSyntax]]<p>[[Main/TWikiUsers]]</p>
+ </td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>Specific Links:</strong><br /> Create a link where you can specify the link text and the link reference separately, using nested square brackets like <code>[[reference][text]]</code>. Internal link references (i.e. [[Main/WikiSyntax]]) and external link references (i.e. <a href="http://TWiki.org/" target="_top">http://TWiki.org/</a>) are supported. The same <strong><em>Forced Links</em></strong> rules apply for internal link references. Anchor names can be added as well, like <code>[[WebHome#MyAnchor][go home]]</code> and <code>[[http://www.yahoo.com/#somewhere][Yahoo!]]</code>. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+[[WikiSyntax][syntax]]
+
+[[http://gnu.org][GNU]]
+</pre> </font></span></td>
+ <td valign="top">[[Main/WikiSyntax]]<p><a href="http://gnu.org" target="_top">GNU</a></p>
+ </td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>Easier External Links:</strong><br /> An easier syntax for external links is now available: <code>[[externalURL text]]</code> - just hit the spacebar to separate the link URL from the descriptive text, e.g. <code>[[http://gnu.org/ GNU]]</code>. This also supports anchors, e.g. <code>[[http://www.yahoo.com/#somewhere Yahoo!]]</code>. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+[[http://gnu.org GNU]]
+</pre> </font></span></td>
+ <td valign="top"><a href="http://gnu.org" target="_top">GNU</a></td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>Anchors:</strong><br /> You can define a link reference inside a %WIKITOOLNAME% topic (called an anchor name) and link to that. To <strong><em>define</em></strong> an anchor write <code>#AnchorName</code> at the beginning of a line. The anchor name must be a [[Main/WikiWord]]. To <strong><em>link to</em></strong> an anchor name use the <code>[[MyTopic#MyAnchor]]</code> syntax. You can omit the topic name if you want to link within the same topic. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+[[WebHome#NotThere]]
+
+[[#MyAnchor][Jump]]
+
+#MyAnchor To here
+</pre> </font></span></td>
+ <td valign="top">[[Main/WebHome#NotThere]]<p>[[Main/WebHome#MyAnchor]]</p>
+ <p><a name="MyAnchor"></a> To here </p>
+ </td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>Prevent a Link:</strong> %BR% Prevent a [[Main/WikiWord]] from being linked by prepending it with the <code><nop></code> tag. </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+<nop>SunOS
+</pre> </font></span></td>
+ <td valign="top"> SunOS </td>
+ </tr>
+ <tr bgcolor="#ffffff">
+ <td valign="top"><strong>Disable Links:</strong> %BR% You can disable automatic linking of [[Main/WikiWords]] by surrounding text with <code><noautolink></code> and <code></noautolink></code> tags. %BR% <strong><em>Note:</em></strong> Each tag must be on a line by itself.%BR% <strong><em>Note:</em></strong> This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing <code></noautolink></code> tag (known issue of the [[Main/TablePlugin]]). </td>
+ <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
+ <noautolink>
+ RedHat &
+ SuSE
+ </noautolink>
+</pre> </font></span></td>
+ <td valign="top"> RedHat & SuSE </td>
+ </tr>
+</table>
+
+## <a name="Using HTML"></a> Using HTML
+
+You can use just about any HTML tag without a problem - however, there are a few usability and technical considerations to keep in mind.
+
+### <a name="HTML and TWiki Usability"></a> HTML and TWiki Usability
+
+- 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.
+- %X% **NOTE:** TWiki is designed to work with a wide range of browsers and computer platforms, holding to HTML 3.2 compatibility in the standard installation - adding raw HTML, particularly browser-specific tags (or any other mark-up that doesn't degrade well) will reduce compatibility.
+
+### <a name="TWiki HTML Rendering"></a> TWiki HTML Rendering
+
+- 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.
+ - %T% If you need to save HTML frequently, you may want to check out TWiki:Plugins/GenHTMLAddon - it will "generate a directory containing rendered versions of a set of TWiki pages together with any attached files."
+- %X% **NOTE:** The opening and closing angle brackets - <code>**<...>**</code> - of an HTML tag **_must be on the same line_**, or the tag will be broken.
+ - This feature allows you to enter an unclosed angle bracket - as a greater than or less than symbol - and have it automatically rendered as if you had entered its HTML character, `<`, ex: <code>**a > b**</code>
+ - %T% If you're pasting in preformatted HTML text and notice problems, check the file in a text processor with no text wrap. Also, save without hard line breaks on text wrap, in your HTML editing program.
+
+## <a name="Hyperlinks"></a> Hyperlinks
+
+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. 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]].
+ - You can also write `[[http://yahoo.com Yahoo home page]]` as an easier way of doing external links with descriptive text for the link, such as [Yahoo home page](http://yahoo.com).
+
+## <a name="TWiki Variables"></a> TWiki Variables
+
+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%**.
+
+- `%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.SiteMap"\}%**</code>
+
+- There are many more variables, see **[[TWikiVariables]]**.
+
+- [[TWikiPreferences]] defines site-wide variables like colors. For example, write: <code><span><font> %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors</font></span></code> to get: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors.
+
+## <a name="TWikiPlugin Formatting Extension"></a><a name="_TWikiPlugin Formatting Extensio"></a> TWikiPlugin Formatting Extensions
+
+Plugins provide additional text formatting capabilities and can extend the functionality of %WIKITOOLNAME% into many other areas. For example, the optional [SpreadSheetPlugin](http://twiki.org/cgi-bin/view/Plugins/SpreadSheetPlugin) lets you create a spreadsheet with the same basic notation used in TWiki tables.
+
+Available Plugins are located in the [Plugins](http://twiki.org/cgi-bin/view/Plugins) web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by `%PLUGINDESCRIPTIONS%`:
+
+- [[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
+- [[EditTablePlugin]] <span>(any TWiki, 11646)</span>:
+- [[InterwikiPlugin]] <span>(Dakar, $Rev: 11935$)</span>:
+- [[PreferencesPlugin]] <span>(Dakar, 9839)</span>:
+- [[SlideShowPlugin]] <span>(Any TWiki, $Rev: 12847$)</span>:
+- [[SmiliesPlugin]] <span>(Dakar, 8154)</span>:
+- [[TablePlugin]] <span>(1.020, 12339)</span>:
+- [[TwistyPlugin]] <span>(1.2.0, $Rev: 12154$)</span>:
+
+Check on current Plugin status and settings for this site in [[TWikiPreferences]].
+
+## <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'`.
+
+-- [[MikeMannix]] - 02 Dec 2001 <br /> -- [[PeterThoeny]] - 02 May 2002
git://git.openafs.org / openafs-wiki.git / blobdiff