TiddlyWiki Markup

TiddlyWiki Community Wiki

This page's contents need to be reviewed and/or refactored to comply with TiddlyWiki.org's quality standards.

Please improve the article, or discuss the issue on the talk page.

[edit] Inline Formatting

Bold:

''bold''

Italic:

//italic//

Underlined:

__underlined__

Strikethrough:

--strikethrough--

Superscript:

^^super^^script

Subscript:

~~sub~~script

Highlighting:

@@highlighted@@

Preformatted:

{{{preformatted}}}

[edit] Block Elements

[edit] Headings

!Heading, level 1
!!Heading, level 2
!!!Heading, level 3
!!!!Heading, level 4
!!!!!Heading, level 5
!!!!!!Heading, level 6

[edit] Unordered Lists

* unordered list, level 1
** unordered list, level 2
*** unordered list, level 3

[edit] Ordered Lists

# ordered list, level 1
## ordered list, level 2
### ordered list, level 3

[edit] Definition Lists

; definition list, term
: definition list, description

Definition-list descriptions are sometimes used to create indented paragraphs.

[edit] Blockquotes

> blockquote, level 1
>> blockquote, level 2
>>> blockquote, level 3

<<<
blockquote
<<<

[edit] Preformatted

{{{
preformatted (e.g. code)
}}}

[edit] Tables

There is also an in-depth article on Tables.

Columns are delimited by a single pipe character (|); a new line creates a new row:

|CssClass|k
|!heading column 1|!heading column 2|h
|row 1, column 1|row 1, column 2|
|row 2, column 1|row 2, column 2|
|>|COLSPAN|
|ROWSPAN| … |
|~| … |
|CssProperty:value;…| … |
|caption|c

Annotation:

The > marker creates a "colspan", causing the current cell to merge with the one to the right.
The ~ marker creates a "rowspan", causing the current cell to merge with the one above.

[edit] Images

cf. TiddlyWiki.com

[edit] Links

WikiWords are automatically transformed to hyperlinks to the respective tiddler
- the automatic transformation can be suppressed by preceding the respective WikiWord with a tilde (~): ~WikiWord
PrettyLinks are enclosed in square brackets and contain the desired tiddler name: [[tiddler name]]
- optionally, a custom title or description can be added, separated by a pipe character (|): [[title|target]]
  N.B.: In this case, the target can also be any website (i.e. URL), folder or file.

[edit] Examples

a simple website (URL) requires no markup: http://domain.tld
website (URL) : [[label|http://domain.tld]]
Unix-style folder: [[label|file:///folder/file]]
Windows drive-mapped folder [[label|file:///c:/folder/file]]
Windows network share: [[label|file://///server/folder/file]]

[edit] Custom Styling

inline styles:

@@CssProperty:value;CssProperty:value;…@@

N.B.: CSS color definitions should use lowercase letters to prevent the inadvertent creation of WikiWords.

class wrapper:
```
{{customClass{…}}}
```

[edit] Inserting HTML

raw HTML can be inserted by enclosing the respective code in HTML tags (<html> … </html>).

[edit] Special Markers

<br> forces a manual line break
---- and <hr> create a horizontal rule (<hr> syntax supported from v2.4.2)
HTML entities
<<macroName>> calls the respective macro
To hide text within a tiddler so that it is not displayed, it can be wrapped in /% and %/.
This can be a useful trick for hiding drafts or annotating complex markup.
To prevent wiki markup from taking effect for a particular section, that section can be enclosed in three double quotes: e.g. """WikiWord""" (cf. Escaping).

[edit] See Also

Wiki Markup
Multi-Line Contents
Tiddler format (TiddlyWiki markup version)
Macros
Customization