Difference: TWikiEditingShorthand (6 vs. 7)

Revision 72011-06-05 - 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: 18 to 18
 
Added:
>
>
 Paragraphs:
Blank lines will create new paragraphs.
Line: 35 to 36
 
Added:
>
>
  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 ---+.

ALERT! Empty headings are allowed, but won't appear in the table of contents.

>
>		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.
 
---++ Sushi
Line: 56 to 58
 
Added:
>
>
 Bold Text:
Words get shown in bold by enclosing them in * asterisks.
Line: 69 to 72
 
Added:
>
>
 Italic Text:
Words get shown in italic by enclosing them in _ underscores.
Line: 82 to 86
 
Added:
>
>
 Bold Italic:
Words get shown in bold italic by enclosing them in __ double-underscores.
Line: 95 to 100
 
Added:
>
>
 Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.
Line: 109 to 115
 
Added:
>
>
 Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.
Line: 124 to 131
 
TIP You can follow the closing bold, italic, or other (* _ __ = ==) indicator with normal punctuation, such as commas and full stops.
Changed:
<
<		 ALERT! Make sure there is no space between the text and the indicators.
>
>
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.
 
_This works_,
_this does not _
Added:
>
>		_this fails too_
 

This works,

Changed:
<
<		_this does not _
Verbatim (Literal) Text:
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. 
<verbatim>
class CatAnimal {
  void purr() {
    <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}
>
>		_this does not _
_this fails too_
 
Added:
>
>
 Separator (Horizontal Rule):
Three or more three dashes at the beginning of a line..
Line: 178 to 164
 
Added:
>
>
  Bulleted List:
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.
Line: 204 to 191
 
Added:
>
>
 Numbered List:
Multiple of three spaces, a type character, a dot, and another space. Several types are available besides a number:
Type Generated Style Sample Sequence
Line: 243 to 231
 
Added:
>
>
  Definition List:
Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.
Line: 260 to 249
 
Added:
>
>
  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
Line: 303 to 293
 
Added:
>
>
  WikiWord Links:
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.
Line: 334 to 325
 
Added:
>
>
  Anchors:
Changed:
<
<		 You can define a reference inside a TWiki topic (called an anchor name) and link to that. To define an anchor write #AnchorName at the beginning of a line. The anchor name must be a WikiWord of no more than 32 characters. To link to an anchor name use the [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.
>
>		 You can define a reference inside a TWiki topic (called an anchor name) and link to that. To define an anchor write #AnchorName at the beginning of a line. The anchor name must be a WikiWord of no more than 32 characters. To link to an anchor name use the [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.
 
[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]
Changed:
<
<		 To here
>
>		 To here
 
Line: 350 to 343
  Jump
Changed:
<
<		 To here
>
>		 To here
 
Added:
>
>
  Forced Links:
Changed:
<
<		 You can create a forced internal link by enclosing words in double square brackets.
Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; for example, [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.
TIP To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point.
>
>		 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/).
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.
 
Changed:
<
<		wiki syntax
>
>		WikiWord

WikiWord#TheSyntax

wiki syntax

 
Changed:
<
<		Main.TWiki groups
>
>		GNU

Singleton

  escaped:
Changed:
<
<		[[wiki syntax]]
>
>		[[WikiSyntax]]
 
Changed:
<
<		wiki syntax
>
>		WikiWord
 
Changed:
<
<		Main.TWiki groups
>
>		WikiWord#TheSyntax
 
Deleted:
<
<		escaped: [[wiki syntax]]
Specific Links:
You can create a link where you specify the link text and the URL separately using nested square brackets [[reference][text]]. Internal link references (e.g. WikiSyntax) and URLs (e.g. http://TWiki.org/) are both supported. The rules described under Forced Links apply for internal link references.
TIP Anchor names can be added as well, to create a link to a specific place in a topic.
 wiki syntax
Changed:
<
<		GNU
>
>		GNU
 
Changed:
<
<		wiki syntax
>
>		Singleton
 
Changed:
<
<		GNU
>
>		escaped: [[WikiSyntax]]
 
Added:
>
>
 Prevent a Link:
Prevent a WikiWord from being linked by prepending it with an exclamation point.
Line: 414 to 401
 
Added:
>
>
  Disable Links:
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.
Line: 432 to 420
 
Added:
>
>
 Mailto Links:
E-mail addresses are linked automatically. To create e-mail links that have more descriptive link text, specify subject lines or message bodies, or omit the e-mail address, you can write [[mailto:user@domain][descriptive text]].
Line: 454 to 443
 Hi
Changed:
<
<
>
>
 
Changed:
<
<		 Literal content:
>
>		Verbatim Text:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
TIPverbatim 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. 
<verbatim>
class CatAnimal {
  void purr() {
    <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}
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 TWiki shorthand rules, with <literal>..</literal> tags. ALERT! any HTML
Line: 475 to 492
 
Changed:
<
<
>
>
 
Changed:
<
<		 Protected content:
>
>		 Protected Text:
  Experts protect text from mangling by WYSIWYG editors using <sticky>..</sticky> tags. Sticky tags don't have any effect on normal topic display; they are only relevant when content has to be
View topic | History: r10 < r9 < r8 < r7 | 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.