TiddlyWiki5/editions/tw5.com/tiddlers/macros/DumpVariablesMacro.tid

caption: dumpvariables
created: 20140908104107181
modified: 20240501101941520
tags: Macros [[Core Macros]]
title: dumpvariables Macro
type: text/vnd.tiddlywiki

The <<.def dumpvariables>> [[macro|Macros]] returns a table showing the values of all [[variables|Variables]], [[procedures|Procedures]], [[functions|Functions]], [[widgets|Widgets]] and [[macros|Macros]] that exist at that position in the [[widget tree|Widgets]].

It is useful for debugging and exploring ~TiddlyWiki's internals.

Placeholders are replaced with values in the normal way, but using the default values for all macro parameters.

!! Parameters

The following parameters are <<.from-version "5.3.4">>

; type
: If type is empty all variable types are shown: `fn, var, proc, macro, widget`. Using the type parameter will reduce the list.

; sort
: `raw`: Is used to allow the <<.olink variables>> to return a raw list.
: `alphabetical`: If sort is missing, by ''default ''the list is alphabetically sorted.

; subfilter
: This parameter limits the number of variables that are listed eg:  `subfilter:"[search::some[sort .attr]]" `

; format
: Format the output string using the VariableFormat. Defaults to `$type$ $name$($params$) $firstLine$`.

Also see: [[search-variables Macro]]

!!! <<.macro-examples "dumpvariables">>
WIP improve dumpvariables macro, add search-variables macro 2024-02-16 15:20:48 +00:00			`caption: dumpvariables`
Add dumpvariables macro 2014-09-08 14:06:48 +00:00			`created: 20140908104107181`
improve docs 2024-05-01 11:02:27 +00:00			`modified: 20240501101941520`
Overhaul the macro and variable documentation #1519 2015-02-24 16:41:16 +00:00			`tags: Macros [[Core Macros]]`
			`title: dumpvariables Macro`
Add dumpvariables macro 2014-09-08 14:06:48 +00:00			`type: text/vnd.tiddlywiki`

update and add documentation tiddlers 2024-04-29 12:54:24 +00:00			`The <<.def dumpvariables>> [[macro\|Macros]] returns a table showing the values of all [[variables\|Variables]], [[procedures\|Procedures]], [[functions\|Functions]], [[widgets\|Widgets]] and [[macros\|Macros]] that exist at that position in the [[widget tree\|Widgets]].`
Add dumpvariables macro 2014-09-08 14:06:48 +00:00
Overhaul the macro and variable documentation #1519 2015-02-24 16:41:16 +00:00			`It is useful for debugging and exploring ~TiddlyWiki's internals.`
Add dumpvariables macro 2014-09-08 14:06:48 +00:00
Overhaul the macro and variable documentation #1519 2015-02-24 16:41:16 +00:00			`Placeholders are replaced with values in the normal way, but using the default values for all macro parameters.`
Add dumpvariables macro 2014-09-08 14:06:48 +00:00
Overhaul the macro and variable documentation #1519 2015-02-24 16:41:16 +00:00			`!! Parameters`
Add dumpvariables macro 2014-09-08 14:06:48 +00:00
update and add documentation tiddlers 2024-04-29 12:54:24 +00:00			`The following parameters are <<.from-version "5.3.4">>`

WIP dumpvariables, search-variables seem to work now using the format-operator 2024-02-21 16:39:00 +00:00			`; type`
			: If type is empty all variable types are shown: `fn, var, proc, macro, widget`. Using the type parameter will reduce the list.

update and add documentation tiddlers 2024-04-29 12:54:24 +00:00			`; sort`
			: `raw`: Is used to allow the <<.olink variables>> to return a raw list.
			: `alphabetical`: If sort is missing, by ''default ''the list is alphabetically sorted.
WIP dumpvariables, search-variables seem to work now using the format-operator 2024-02-21 16:39:00 +00:00
WIP improve dumpvariables macro, add search-variables macro 2024-02-16 15:20:48 +00:00			`; subfilter`
WIP dumpvariables, search-variables seem to work now using the format-operator 2024-02-21 16:39:00 +00:00			: This parameter limits the number of variables that are listed eg: `subfilter:"[search::some[sort .attr]]" `

			`; format`
			: Format the output string using the VariableFormat. Defaults to `$type$ $name$($params$) $firstLine$`.
Add dumpvariables macro 2014-09-08 14:06:48 +00:00
update and add documentation tiddlers 2024-04-29 12:54:24 +00:00			`Also see: [[search-variables Macro]]`
improve docs 2024-05-01 11:02:27 +00:00
			`!!! <<.macro-examples "dumpvariables">>`