Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
TWiki Editing ShorthandThese instructions are for contributors who prefer to use the Raw Edit over the default WYSIWYG editor. | ||||||||
Line: 47 to 47 | ||||||||
Headings: Three or more dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a top level heading, two pluses a second level heading, etc. The maximum heading depth is 6. | ||||||||
Changed: | ||||||||
< < | You can create a table of contents with the %TOC% variable.
If you want to exclude a heading from the TOC, put !! after the ---+ .
Empty headings are allowed and won't appear in the table of contents. | |||||||
> > |
| |||||||
| ||||||||
Line: 136 to 136 | ||||||||
Changed: | ||||||||
< < | You can follow the closing bold, italic, or other (* _ __ = == ) indicator
with normal punctuation, such as commas and full stops.
Make sure there is no space between the text and the indicators. All words enclosed by the indicators need to be on the same line. | |||||||
> > |
| |||||||
| ||||||||
Line: 174 to 173 | ||||||||
Bulleted List: Multiple of three spaces, an asterisk, and another space. | ||||||||
Changed: | ||||||||
< < | For all the list types, you can break a list item over several lines by indenting lines after the first one by at least 3 spaces. | |||||||
> > |
| |||||||
| ||||||||
Line: 201 to 200 | ||||||||
Icon List: Multiple of three spaces, an asterisk, text icon:name and another space. | ||||||||
Changed: | ||||||||
< < | Use the name of any TWikiDocGraphics icon. | |||||||
> > |
| |||||||
| ||||||||
Line: 285 to 284 | ||||||||
Table: Each row of the table is a line containing of one or more cells. Each cell starts and ends with a vertical bar '|'. Any spaces at the beginning of a line are ignored.
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Line: 294 to 293 | ||||||||
| ||||||||
Changed: | ||||||||
< < | The TablePlugin provides the |^| multiple-span row functionality, |>> ... <<| multi-line syntax, and additional rendering features | |||||||
> > |
| |||||||
| ||||||||
Line: 335 to 334 | ||||||||
WikiWord Links: CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically if preceded by whitespace or parenthesis. | ||||||||
Changed: | ||||||||
< < | If you want to link to a topic in a different web write Otherweb.TopicName .
To link to a topic in a subweb write Otherweb.Subweb.TopicName .
The link label excludes the name of the web, e.g. only the topic name is shown. As an exception, the name of the web is shown for the WebHome topic. Dots '.' are used to separate webs and subwebs from topic names and therefore cannot be used in topic names. | |||||||
> > |
| |||||||
Line: 350 to 350 | ||||||||
Sandbox TopicName | ||||||||
Added: | ||||||||
> > | EscapedWikiWord | |||||||
Line: 360 to 362 | ||||||||
Sandbox TopicName | ||||||||
Added: | ||||||||
> > | EscapedWikiWord | |||||||
Line: 414 to 418 | ||||||||
Forced Links: Use double square brackets to create forced links: Write [[link]] or [[link][label]] to force a link. Use the former for singleton words and if automatic linking is disabled. Use the latter one to specify a link label other than the link. For the link, you can use internal link references (e.g. WikiWords) and URLs (e.g. http://TWiki.org/). | ||||||||
Changed: | ||||||||
< < | URL parameters can follow a WikiWord Anchor names can be added to create a link to a specific place in a document. To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point. The topic title instead of the topic name is shown for [[WikiWord]] links if the SHOWTOPICTITLELINK preferences setting is enabled. | |||||||
> > |
| |||||||
| ||||||||
Line: 462 to 466 | ||||||||
Topic Title Links: Use double square brackets and a plus sign to create links with topic title: Write [[+TopicName]] or [[+Web.TopicName]] to show the topic title instead of the topic name. The topic title is defined by the form field named "Title", the topic preferences setting named TITLE, or the topic name if neither exists. | ||||||||
Changed: | ||||||||
< < | An alternative syntax is [[TopicName][$topictitle]] or [[Web.TopicName][$topictitle]] . | |||||||
> > |
| |||||||
| ||||||||
Line: 482 to 486 | ||||||||
Added: | ||||||||
> > |
| |||||||
Changed: | ||||||||
< < | SunOS | |||||||
> > | RedHat | |||||||
Changed: | ||||||||
< < | SunOS | |||||||
> > | RedHat | |||||||
Line: 498 to 524 | ||||||||
Disable Links: You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags. | ||||||||
Changed: | ||||||||
< < | It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting. | |||||||
> > |
| |||||||
| ||||||||
Line: 545 to 571 | ||||||||
| ||||||||
Added: | ||||||||
> > | @escaped | |||||||
| ||||||||
Added: | ||||||||
> > | @escaped | |||||||
Line: 556 to 586 | ||||||||
Verbatim Text: Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags. | ||||||||
Changed: | ||||||||
< < | The verbatim tag disables HTML code. Use <pre> and </pre> tags instead if you want the HTML code within the tags to be interpreted.
Preferences variables (* Set NAME = value) are set within verbatim tags. | |||||||
> > |
| |||||||
| ||||||||
Line: 585 to 615 | ||||||||
TWiki generates HTML code from TWiki shorthand.
Experts surround anything that must be output literally in the HTML code, without the application of
TWiki shorthand rules, with <literal>..</literal> tags. | ||||||||
Changed: | ||||||||
< < | Any HTML within literal tags must be well formed i.e. all tags must be properly closed before the end of the literal block. TWiki Variables are expanded within literal blocks. | |||||||
> > |
| |||||||
|