Difference: TWikiEditingShorthand (10 vs. 11)

Revision 112018-07-14 - TWikiContributor

Line: 1 to 1
 

TWiki Editing Shorthand

These 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:
<
<
TIP You can create a table of contents with the %TOC% variable.
TIP If you want to exclude a heading from the TOC, put !! after the ---+.
ALERT! Empty headings are allowed and won't appear in the table of contents.
>
>
  • 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.
 
---++ Sushi
Line: 136 to 136
 
Changed:
<
<
TIP You can follow the closing bold, italic, or other (* _ __ = ==) indicator with normal punctuation, such as commas and full stops.
ALERT! Make sure there is no space between the text and the indicators.
ALERT! All words enclosed by the indicators need to be on the same line.
>
>
  • 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.
 
_This works_,
Line: 174 to 173
  Bulleted List:
Multiple of three spaces, an asterisk, and another space.
Changed:
<
<

HELP 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.
>
>
  • 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.
 
   * level 1
Line: 201 to 200
  Icon List:
Multiple of three spaces, an asterisk, text icon:name and another space.
Changed:
<
<

HELP Use the name of any TWikiDocGraphics icon.
>
>
 
   * icon:tip Icon list
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.
  • | *bold* | header cell with text in asterisks
Changed:
<
<
  • |   center-aligned   | cell with at least two, and equal number of spaces on either side
  • |      right-aligned | cell with more spaces on the left
>
>
  • |   center-aligned   | cell with two or more spaces on both sides. The number of spaces may be different between sides
  • |      right-aligned | cell with two or more spaces on the left and one or zero space on the right
 
  • | 2 colspan || and multi-span columns with multiple |'s right next to each other
  • |^| cell with caret indicating follow-up row of multi-span rows
  • |>> ... <<| cell enclosed in double-square brackets can span multiple lines - useful for bullets and nested tables
Line: 294 to 293
 
  • Contents of table cells wrap automatically as determined by the browser
  • Use %VBAR% or &#124; to add | characters in tables.
  • Use %CARET% or &#94; to add ^ characters in tables.
Changed:
<
<
TIP The TablePlugin provides the |^| multiple-span row functionality, |>> ... <<| multi-line syntax, and additional rendering features
>
>
  • The TablePlugin provides the |^| multiple-span row functionality, |>> ... <<| multi-line syntax, and additional rendering features
 
| *L* | *C* | *R* |
Line: 335 to 334
  WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically if preceded by whitespace or parenthesis.
Changed:
<
<

TIP If you want to link to a topic in a different web write Otherweb.TopicName.
TIP To link to a topic in a subweb write Otherweb.Subweb.TopicName.
HELP 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.
ALERT! Dots '.' are used to separate webs and subwebs from topic names and therefore cannot be used in topic names.
>
>
  • 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.
  • Links can be prevented with an ! exclamation point prefix.
  It's generally a good idea to use the TWikiVariables %SYSTEMWEB% and %USERSWEB% instead of TWiki and Main.
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:
<
<

TIP URL parameters can follow a WikiWord
TIP Anchor names can be added to create a link to a specific place in a document.
TIP To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point.
TIP The topic title instead of the topic name is shown for [[WikiWord]] links if the SHOWTOPICTITLELINK preferences setting is enabled.
>
>
  • 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.
 
[[WikiWord]]
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:
<
<

TIP An alternative syntax is [[TopicName][$topictitle]] or [[Web.TopicName][$topictitle]].
>
>
  • An alternative syntax is [[TopicName][$topictitle]] or [[Web.TopicName][$topictitle]].
 
[[+BugN1234]]
Line: 482 to 486
 
Added:
>
>
Refer to Topic or Attachment Name in Double Square Brackets:
$name in the link label in the double square brackets notation refers to the topic name or the attachment file name.

$name is used for consistency with QuerySearch, in which name refers to the topic name and the attachment file name, respectively.

[[%SYSTEMWEB%.WikiWord\
#TheSyntax][$name]]

[[%PUBURL%/%WEB%/WabiSabi\
/wabisabi.gif][$name]]

WikiWord

wabisabi.gif

 Prevent a Link:
Prevent a WikiWord from being linked by prepending it with an exclamation point.
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:
<
<

HELP It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting.
>
>
  • It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting.
 
 <noautolink>
Line: 545 to 571
 
@twiki
Added:
>
>
@escaped
 

@twiki

Added:
>
>
@escaped
 
Line: 556 to 586
  Verbatim Text:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Changed:
<
<

TIP The verbatim tag disables HTML code. Use <pre> and </pre> tags instead if you want the HTML code within the tags to be interpreted.
ALERT! Preferences variables (* Set NAME = value) are set within verbatim tags.
>
>
  • 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.
 
<verbatim></verbatim>
<nop>
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:
<
<

ALERT! Any HTML within literal tags must be well formed i.e. all tags must be properly closed before the end of the literal block.
IDEA! TWiki Variables are expanded within literal blocks.
>
>
  • 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.
 
<literal>

 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding URCS? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiEditingShorthand.