2024-02-16 15:20:48 +00:00
caption: dumpvariables
2014-09-08 14:06:48 +00:00
created: 20140908104107181
2024-04-29 12:54:24 +00:00
modified: 20240427121039507
2015-02-24 16:41:16 +00:00
tags: Macros [[Core Macros]]
title: dumpvariables Macro
2014-09-08 14:06:48 +00:00
type: text/vnd.tiddlywiki
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]].
2014-09-08 14:06:48 +00:00
2015-02-24 16:41:16 +00:00
It is useful for debugging and exploring ~TiddlyWiki's internals.
2014-09-08 14:06:48 +00:00
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.
2014-09-08 14:06:48 +00:00
2015-02-24 16:41:16 +00:00
!! Parameters
2014-09-08 14:06:48 +00:00
2024-04-29 12:54:24 +00:00
The following parameters are <<.from-version "5.3.4">>
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.
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.
2024-02-21 16:39:00 +00:00
2024-02-16 15:20:48 +00:00
; subfilter
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$`.
2014-09-08 14:06:48 +00:00
2024-02-16 15:20:48 +00:00
!!! <<.macro-examples "dumpvariables">>
2024-04-29 12:54:24 +00:00
Also see: [[search-variables Macro]]