Note: An alternative skin, TW4MW (work in progress), is available from the user preferences.

TiddlyWiki Markup

TiddlyWiki Community Wiki

Jump to: navigation, search
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.


Contents

[edit] Inline Formatting

Format text as desired
To Format Text As... Use This Mark-Up
Bold ''Bold'' Two single-quotes, not a double-quote.
Italics //Italics//
Bold Italics ''//Bold Italics//''
Underline __Underline__
Strikethrough --Strikethrough--
Superscript Super^^script^^
Subscript Sub~~script~~
Highlight
 @@Highlight@@
PlainText No ''Formatting'' {{{PlainText No ''Formatting''}}}

[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


[edit] Example

  • Unordered List, Level 1
    • Unordered List, Level 2
      • Unordered List, Level 3


[edit] Mark-Up Used

* Unordered List, Level 1
** Unordered List, Level 2
*** Unordered List, Level 3


[edit] Ordered Lists


[edit] Example

  1. Ordered List, Level 1A
  2. Ordered List, Level 1B
    1. Ordered List, Level 2A
      1. Ordered List, Level 3A


[edit] Mark-Up Used

# Ordered List, Level 1A
# Ordered List, Level 1B
## Ordered List, Level 2A
### Ordered List, Level 3A


[edit] Definition Lists 

; term
: description
term
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 double 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]]
  • File in a local subfolder of the TiddlyWiki location: [[label|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] Examples 

{{indent{
lorem ''ipsum'' dolor '''sit''' amet
}}}

(The indent is provided by the TiddlyWiki core in StyleSheetLayout.)

[edit] Inserting HTML

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

[edit] Avoiding Wikificitation

To prevent wiki markup from taking effect for a particular section (e.g. special characters), that section can be enclosed in three double quotes: e.g. """WikiWord""" (cf. Escaping).

[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.

[edit] See Also

Retrieved from "http://tiddlywiki.org/wiki/TiddlyWiki_Markup"
Personal tools