mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-11-30 05:19:57 +00:00
f0bd06b38d
* Added macros for displaying wikitext examples in a table * Added documentation for WikiText parsing * Changed recognize to British spelling * Add links to the new wikitext parser tiddlers
31 lines
1.3 KiB
Plaintext
31 lines
1.3 KiB
Plaintext
caption: wikify
|
|
created: 20160321144949700
|
|
modified: 20220122191540121
|
|
tags: Widgets
|
|
title: WikifyWidget
|
|
type: text/vnd.tiddlywiki
|
|
|
|
! Introduction
|
|
|
|
The wikify widget parses and renders a string of text and assigns the result to a specified [[variable|Variables]]. The new value of the variable is available to the content within the wikify widget.
|
|
|
|
! Content and Attributes
|
|
|
|
The content of the `<$wikify>` widget is the scope for the value assigned to the variable.
|
|
|
|
|!Attribute |!Description |
|
|
|name |The name of the variable to assign |
|
|
|text |The text to parse and render |
|
|
|type |The ContentType of the text (defaults to `text/vnd.tiddlywiki`) |
|
|
|mode |The parse mode: [[block|Block Mode WikiText]] (the default) or [[inline|Inline Mode WikiText]] |
|
|
|output |Keyword indicating the desired output type, defaulting to `text` (see below) |
|
|
|
|
The available output types are:
|
|
|
|
|!Keyword |!Description |
|
|
|text |Return the plain text of the rendered output (ie HTML tags are omitted) |
|
|
|formattedtext |Return the plain text with simple text formatting of the rendered output (ie HTML tags are omitted) |
|
|
|html |Return the rendered HTML of the output |
|
|
|parsetree |Return a formatted JSON representation of the parse tree |
|
|
|widgettree |Return a formatted JSON representation of the widget tree |
|