TiddlyWiki5/editions/tw5.com/tiddlers/_tw_shared/doc-utilities/wikitext-macros.tid

code-body: yes
created: 20150117184156000
modified: 20240716181836632
tags: $:/tags/Macro
title: $:/editions/tw5.com/wikitext-macros
type: text/vnd.tiddlywiki

\whitespace trim

\procedure activatePluginTab()
<$action-setfield $tiddler="$:/state/tab-1749438307" text="$:/core/ui/ControlPanel/Plugins"/>
<$action-navigate $to="$:/ControlPanel"/>
\end

\procedure activateTiddlerWindow()
<$action-sendmessage $message="tm-open-window" $param=<<currentTiddler>> windowTitle="Side by Side View" width="800" height="600" />
\end

\procedure controlPanel-plugin-link()
<$button actions=<<activatePluginTab>> class="tc-btn-invisible tc-tiddlylink">
	{{$:/core/images/options-button}} ~ControlPanel
</$button>
\end

\procedure open-tiddler-in-window()
\whitespace notrim
<$button actions=<<activateTiddlerWindow>> class="tc-btn-invisible tc-tiddlylink">
	open ''this'' tiddler in a new window
</$button>
\end

\procedure activateEditionWindow(url)
<$action-sendmessage $message="tm-open-external-window" $param=<<url>> windowName="_edition" windowFeatures="width=800 height=600" />
\end

\procedure open-external-window(url)
\whitespace notrim
<$button actions=<<activateEditionWindow <<url>> class="tc-btn-invisible tc-tiddlylink">
	open the ''example edition'' in a new window
</$button>
\end


\procedure wikitext-example(src)
<div class="doc-example">
	<$macrocall $name="copy-to-clipboard-above-right" src=<<src>>/>
	<$codeblock code=<<src>>/>
	<p>
		That renders as:
	</p>
	<$transclude $variable="src" $mode="block"/>
	<p>
		... and the underlying HTML is:
	</p>
	<$wikify name="html" text=<<src>> output="html">
		<$codeblock code=<<html>>/>
	</$wikify>
</div>
\end

\procedure wikitext-example-without-html(src)
<div class="doc-example">
	<$macrocall $name="copy-to-clipboard-above-right" src=<<src>>/>
	<$codeblock code=<<src>>/>
	<p>
		That renders as:
	</p>
	<$transclude $variable="src" $mode="block"/>
</div>
\end

\procedure wikitext-example-table-header() <thead><tr><th/><th>wiki text</th><th>renders as</th></tr></thead>

\procedure wikitext-example-table-row(id, code)
<tr>
	<th><<id>></th>
	<td><$codeblock code=<<code>>/></td>
	<td><$transclude $variable="code" $mode="block"/></td>
</tr>
\end

\procedure tw-code(tiddler)
<$codeblock language={{{ [<tiddler>get[type]] }}} code={{{ [<tiddler>get[text]] }}}/>
\end

\procedure tw-code-link(tiddler)
<$link to=<<tiddler>>/>:
<$transclude $variable=tw-code tiddler=<<tiddler>> />
\end
Doc restructuring Plugin Install using core Libraries and with Node.js (#6722) * Doc restructuring Plugin Install using core Libraries and with Node.js * fixing typos and concerns raised by Jeremy 2022-06-20 12:55:12 +00:00			`code-body: yes`
Overhaul the filter operator documentation: part 1 2015-01-18 18:39:00 +00:00			`created: 20150117184156000`
Wikitext Procedures (#8390) 2024-07-28 12:43:20 +00:00			`modified: 20240716181836632`
Support global macros via the importvariables widget The new importvariables widget imports macro/variable definitions from the specified tiddlers and makes them available to its children. Allows us to split PageMacros up into separate tiddlers. We still support loading macros from $:/core/ui/PageMacros to help people upgrading. Fixes #644 and #559 2014-06-12 17:01:33 +00:00			`tags: $:/tags/Macro`
Add doc related to WikiText parser modes (#6415) * 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 2022-01-23 09:44:01 +00:00			`title: $:/editions/tw5.com/wikitext-macros`
			`type: text/vnd.tiddlywiki`
Support global macros via the importvariables widget The new importvariables widget imports macro/variable definitions from the specified tiddlers and makes them available to its children. Allows us to split PageMacros up into separate tiddlers. We still support loading macros from $:/core/ui/PageMacros to help people upgrading. Fixes #644 and #559 2014-06-12 17:01:33 +00:00
Docs - wikitext-macros new v5.3.x syntaxWikitext macros (#8059) * docs - wikitext-macros new v5.3.x syntax * fix flexcard macro wrong link 2024-03-13 22:02:56 +00:00			`\whitespace trim`

			`\procedure activatePluginTab()`
Doc restructuring Plugin Install using core Libraries and with Node.js (#6722) * Doc restructuring Plugin Install using core Libraries and with Node.js * fixing typos and concerns raised by Jeremy 2022-06-20 12:55:12 +00:00			`<$action-setfield $tiddler="$:/state/tab-1749438307" text="$:/core/ui/ControlPanel/Plugins"/>`
			`<$action-navigate $to="$:/ControlPanel"/>`
			`\end`

Docs - wikitext-macros new v5.3.x syntaxWikitext macros (#8059) * docs - wikitext-macros new v5.3.x syntax * fix flexcard macro wrong link 2024-03-13 22:02:56 +00:00			`\procedure activateTiddlerWindow()`
			`<$action-sendmessage $message="tm-open-window" $param=<<currentTiddler>> windowTitle="Side by Side View" width="800" height="600" />`
Doc restructuring Plugin Install using core Libraries and with Node.js (#6722) * Doc restructuring Plugin Install using core Libraries and with Node.js * fixing typos and concerns raised by Jeremy 2022-06-20 12:55:12 +00:00			`\end`

Docs - wikitext-macros new v5.3.x syntaxWikitext macros (#8059) * docs - wikitext-macros new v5.3.x syntax * fix flexcard macro wrong link 2024-03-13 22:02:56 +00:00			`\procedure controlPanel-plugin-link()`
Doc restructuring Plugin Install using core Libraries and with Node.js (#6722) * Doc restructuring Plugin Install using core Libraries and with Node.js * fixing typos and concerns raised by Jeremy 2022-06-20 12:55:12 +00:00			`<$button actions=<<activatePluginTab>> class="tc-btn-invisible tc-tiddlylink">`
Docs - wikitext-macros new v5.3.x syntaxWikitext macros (#8059) * docs - wikitext-macros new v5.3.x syntax * fix flexcard macro wrong link 2024-03-13 22:02:56 +00:00			`{{$:/core/images/options-button}} ~ControlPanel`
Doc restructuring Plugin Install using core Libraries and with Node.js (#6722) * Doc restructuring Plugin Install using core Libraries and with Node.js * fixing typos and concerns raised by Jeremy 2022-06-20 12:55:12 +00:00			`</$button>`
			`\end`

Docs - wikitext-macros new v5.3.x syntaxWikitext macros (#8059) * docs - wikitext-macros new v5.3.x syntax * fix flexcard macro wrong link 2024-03-13 22:02:56 +00:00			`\procedure open-tiddler-in-window()`
			`\whitespace notrim`
Doc restructuring Plugin Install using core Libraries and with Node.js (#6722) * Doc restructuring Plugin Install using core Libraries and with Node.js * fixing typos and concerns raised by Jeremy 2022-06-20 12:55:12 +00:00			`<$button actions=<<activateTiddlerWindow>> class="tc-btn-invisible tc-tiddlylink">`
Docs - wikitext-macros new v5.3.x syntaxWikitext macros (#8059) * docs - wikitext-macros new v5.3.x syntax * fix flexcard macro wrong link 2024-03-13 22:02:56 +00:00			`open ''this'' tiddler in a new window`
Doc restructuring Plugin Install using core Libraries and with Node.js (#6722) * Doc restructuring Plugin Install using core Libraries and with Node.js * fixing typos and concerns raised by Jeremy 2022-06-20 12:55:12 +00:00			`</$button>`
			`\end`

Docs - wikitext-macros new v5.3.x syntaxWikitext macros (#8059) * docs - wikitext-macros new v5.3.x syntax * fix flexcard macro wrong link 2024-03-13 22:02:56 +00:00			`\procedure activateEditionWindow(url)`
			`<$action-sendmessage $message="tm-open-external-window" $param=<<url>> windowName="_edition" windowFeatures="width=800 height=600" />`
Doc restructuring Plugin Install using core Libraries and with Node.js (#6722) * Doc restructuring Plugin Install using core Libraries and with Node.js * fixing typos and concerns raised by Jeremy 2022-06-20 12:55:12 +00:00			`\end`

Docs - wikitext-macros new v5.3.x syntaxWikitext macros (#8059) * docs - wikitext-macros new v5.3.x syntax * fix flexcard macro wrong link 2024-03-13 22:02:56 +00:00			`\procedure open-external-window(url)`
			`\whitespace notrim`
			`<$button actions=<<activateEditionWindow <<url>> class="tc-btn-invisible tc-tiddlylink">`
			`open the ''example edition'' in a new window`
Doc restructuring Plugin Install using core Libraries and with Node.js (#6722) * Doc restructuring Plugin Install using core Libraries and with Node.js * fixing typos and concerns raised by Jeremy 2022-06-20 12:55:12 +00:00			`</$button>`
			`\end`


Docs - wikitext-macros new v5.3.x syntaxWikitext macros (#8059) * docs - wikitext-macros new v5.3.x syntax * fix flexcard macro wrong link 2024-03-13 22:02:56 +00:00			`\procedure wikitext-example(src)`
Overhaul the filter operator documentation: part 1 2015-01-18 18:39:00 +00:00			`<div class="doc-example">`
Docs - wikitext-macros new v5.3.x syntaxWikitext macros (#8059) * docs - wikitext-macros new v5.3.x syntax * fix flexcard macro wrong link 2024-03-13 22:02:56 +00:00			`<$macrocall $name="copy-to-clipboard-above-right" src=<<src>>/>`
			`<$codeblock code=<<src>>/>`
			`<p>`
			`That renders as:`
			`</p>`
			`<$transclude $variable="src" $mode="block"/>`
			`<p>`
			`... and the underlying HTML is:`
			`</p>`
			`<$wikify name="html" text=<<src>> output="html">`
			`<$codeblock code=<<html>>/>`
			`</$wikify>`
Overhaul the filter operator documentation: part 1 2015-01-18 18:39:00 +00:00			`</div>`
Support global macros via the importvariables widget The new importvariables widget imports macro/variable definitions from the specified tiddlers and makes them available to its children. Allows us to split PageMacros up into separate tiddlers. We still support loading macros from $:/core/ui/PageMacros to help people upgrading. Fixes #644 and #559 2014-06-12 17:01:33 +00:00			`\end`

Docs - wikitext-macros new v5.3.x syntaxWikitext macros (#8059) * docs - wikitext-macros new v5.3.x syntax * fix flexcard macro wrong link 2024-03-13 22:02:56 +00:00			`\procedure wikitext-example-without-html(src)`
Overhaul the filter operator documentation: part 1 2015-01-18 18:39:00 +00:00			`<div class="doc-example">`
Docs - wikitext-macros new v5.3.x syntaxWikitext macros (#8059) * docs - wikitext-macros new v5.3.x syntax * fix flexcard macro wrong link 2024-03-13 22:02:56 +00:00			`<$macrocall $name="copy-to-clipboard-above-right" src=<<src>>/>`
			`<$codeblock code=<<src>>/>`
			`<p>`
			`That renders as:`
			`</p>`
Fix wikitext-macros example block mode (#8071) 2024-03-15 18:08:37 +00:00			`<$transclude $variable="src" $mode="block"/>`
Overhaul the filter operator documentation: part 1 2015-01-18 18:39:00 +00:00			`</div>`
Support global macros via the importvariables widget The new importvariables widget imports macro/variable definitions from the specified tiddlers and makes them available to its children. Allows us to split PageMacros up into separate tiddlers. We still support loading macros from $:/core/ui/PageMacros to help people upgrading. Fixes #644 and #559 2014-06-12 17:01:33 +00:00			`\end`
updated NestedLists, renamed to GroupedLists added tw-code macro Didn't implement the codeblock widget as suggested here... https://github.com/Jermolene/TiddlyWiki5/pull/1332#discussion_r22762157 ...because it would only return `undefined`. 2015-01-11 10:55:22 +00:00
Docs - wikitext-macros new v5.3.x syntaxWikitext macros (#8059) * docs - wikitext-macros new v5.3.x syntax * fix flexcard macro wrong link 2024-03-13 22:02:56 +00:00			`\procedure wikitext-example-table-header() <thead><tr><th/><th>wiki text</th><th>renders as</th></tr></thead>`
Add doc related to WikiText parser modes (#6415) * 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 2022-01-23 09:44:01 +00:00
Docs - wikitext-macros new v5.3.x syntaxWikitext macros (#8059) * docs - wikitext-macros new v5.3.x syntax * fix flexcard macro wrong link 2024-03-13 22:02:56 +00:00			`\procedure wikitext-example-table-row(id, code)`
			`<tr>`
			`<th><<id>></th>`
			`<td><$codeblock code=<<code>>/></td>`
Fix wikitext-example-table-row to render output in block mode (#8288) * Fix wikitext-example-table-row so example output table cell is rendered in block mode * Use transclude with =block instead of empty line to force block mode parsing 2024-06-22 16:53:47 +00:00			`<td><$transclude $variable="code" $mode="block"/></td>`
Add doc related to WikiText parser modes (#6415) * 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 2022-01-23 09:44:01 +00:00			`</tr>`
			`\end`

Docs - wikitext-macros new v5.3.x syntaxWikitext macros (#8059) * docs - wikitext-macros new v5.3.x syntax * fix flexcard macro wrong link 2024-03-13 22:02:56 +00:00			`\procedure tw-code(tiddler)`
Wikitext Procedures (#8390) 2024-07-28 12:43:20 +00:00			`<$codeblock language={{{ [<tiddler>get[type]] }}} code={{{ [<tiddler>get[text]] }}}/>`
updated NestedLists, renamed to GroupedLists added tw-code macro Didn't implement the codeblock widget as suggested here... https://github.com/Jermolene/TiddlyWiki5/pull/1332#discussion_r22762157 ...because it would only return `undefined`. 2015-01-11 10:55:22 +00:00			`\end`

Docs - wikitext-macros new v5.3.x syntaxWikitext macros (#8059) * docs - wikitext-macros new v5.3.x syntax * fix flexcard macro wrong link 2024-03-13 22:02:56 +00:00			`\procedure tw-code-link(tiddler)`
Wikitext Procedures (#8390) 2024-07-28 12:43:20 +00:00			`<$link to=<<tiddler>>/>:`
			`<$transclude $variable=tw-code tiddler=<<tiddler>> />`
Improve readability for documentation macros (#6494) 2022-03-02 17:36:53 +00:00			`\end`