mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-09-20 03:09:42 +00:00
1a95ec9ac4
Thanks to @cjrk and @cheigele for contributing their developer docs (which can be found at https://github.com/cjrk/saa-tw). By the way, I plan to remove the “creator” and “modifier” fields but will keep a prominent acknowledgement for your contributions.
27 lines
1.4 KiB
Plaintext
27 lines
1.4 KiB
Plaintext
chapter.of: TiddlyWiki - A quick Overview
|
|
created: 20140708083145150
|
|
creator: Christian Heigele, Christian Jurke
|
|
modified: 20140717212656341
|
|
modifier: Christian Heigele, Christian Jurke
|
|
sub.num: 7
|
|
tags: doc
|
|
title: WikiText Markup
|
|
|
|
The WikiText is a markup language, created especially for the requirements of the TiddlyWiki application. It is based on [[Markdown|http://daringfireball.net/projects/markdown]], but extended with some TiddlyWiki specific features. On one hand its a text-to-HTML conversion language and on the other hand its used to provide the interactive features of TiddlyWiki. The aim of this language is to allow the user of the software to focus on the writing. The WikiText is used to format Tiddlers within the TiddlyWiki application. The tags of the WikiText syntax can be used within the standard text input field.
|
|
During the saving process these tags renders to HTML elements for example:
|
|
|
|
```
|
|
WikiText:---
|
|
Renders as:
|
|
HTML:<hr>
|
|
WikiText:[img[http://tiddlywiki.com/favicon.ico]]
|
|
Renders as: TW
|
|
HTML:<img src="http://tiddlywiki.com/favicon.ico">
|
|
```
|
|
|
|
Furthermore the WikiText is used to access the widgets which are integrated in the application.These widgets are used to enhance the the WikiText with a rich functionality. Widgets are based on the ~HTML-Syntax but always starts with a $.
|
|
|
|
```
|
|
WikiText:
|
|
<$button message="tw-close-tiddler">Close Me!</$button>
|
|
``` |