Difference: TWikiEditingShorthand (7 vs. 8)

Revision 82013-03-19 - 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: 166 to 166
 
Bulleted List:
Changed:
<
<		Multiple of three spaces, an asterisk, and another space.
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.
>
>		Multiple of three spaces, an asterisk, and another space.
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.
 
   * level 1
Line: 191 to 191
 
Added:
>
>		Icon List:
Multiple of three spaces, an asterisk, text icon:name and another space.
HELP Use the name of any TWikiDocGraphics icon. 
   * icon:tip Icon list
      * icon:led-red Full
      * icon:led-green OK
   * icon:unchecked Item 1
   * icon:checked Item 2
   * icon:empty No bullet

  • Icon list
    • Full
    • OK
  • Item 1
  • Item 2
  • No bullet
  Numbered List:
Multiple of three spaces, a type character, a dot, and another space. Several types are available besides a number:
Line: 295 to 320
 
WikiWord Links:
Changed:
<
<		 CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically if preceded by whitespace or parenthesis.
TIP 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.
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.
>
>		 CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically if preceded by whitespace or parenthesis.
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.
  It's generally a good idea to use the TWikiVariables %SYSTEMWEB% and %USERSWEB% instead of TWiki and Main.
Line: 349 to 374
 
Added:
>
>		External Links:
URLs starting with file, ftp, gopher, http, https, irc, mailto, news, nntp and telnet are linked automatically if preceded by whitespace or parenthesis. External links are indicated with a trailing External link icon, and open up in a new browser tab or window; the behavior of both can be set in configure or preferences variables (see TWikiExternalLinks for details). Links can be prevented with an ! exclamation point prefix. 
https://twiki.org

https://google.com

!https://escaped-link

https://twiki.org

https://google.com

https://escaped-link

  Forced Links:
Changed:
<
<		 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. https://TWiki.org/).
>
>		 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. https://TWiki.org/).
 
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.
Added:
>
>
TIP The topic title instead of the topic name is shown for [[WikiWord]] links if the SHOWTOPICTITLELINK preferences setting is enabled.
 
[[WikiWord]]
Line: 388 to 436
 
Added:
>
>		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.
TIP An alternative syntax is [[TopicName][$topictitle]] or [[Web.TopicName][$topictitle]]. 
[[+BugN1234]]

[[+Bugs.BugN1234]]

[[BugN1234][$topictitle]]

The sky is falling

The sky is falling

The sky is falling

  Prevent a Link:
Prevent a WikiWord from being linked by prepending it with an exclamation point.
Line: 403 to 474
 
Disable Links:
Changed:
<
<		 You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.
HELP It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting.
>
>		 You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.
HELP It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting.
 
 <noautolink>
Line: 445 to 516
 
Added:
>
>		Twitter Links:
@twitter IDs are linked automatically. The link rule is defined by the {Links}{TwitterUrlPattern} configure setting. 
@twiki

@twiki

  Verbatim Text:
Changed:
<
<		 Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
TIP verbatim tags disable HTML code. Use <pre> and </pre> tags instead if you want the HTML code within the tags to be interpreted.
ALERT! NOTE: Preferences variables (* Set NAME = value) are set within verbatim tags.
>
>		 Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
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.
 
<verbatim></verbatim>
<nop>
Line: 476 to 561
  Literal Text:
TWiki generates HTML code from TWiki shorthand. Experts surround anything that must be output literally in the HTML code, without the application of
Changed:
<
<		 TWiki shorthand rules, with <literal>..</literal> tags. 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.
>
>		 TWiki shorthand rules, with <literal>..</literal> tags.
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.
 
<literal>
View topic | History: r11 < r10 < r9 < r8 | More topic actions...
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiEditingShorthand.