mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-24 17:10:29 +00:00
Code Issues Releases Wiki Activity

Doc updates for ActionLog and Log widgets (#5081)

Browse Source
This commit is contained in:
saqimtiaz 2020-11-20 19:37:48 +01:00 committed by GitHub
parent 4f07539164
commit c97003238b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 75 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
editions/tw5.com/tiddlers/definitions/Web Developer Tools.tid Normal file
View File

@ -0,0 +1,7 @@
created: 20201120153119665
modified: 20201120154646100
tags: Definitions
title: Web Developer Tools
type: text/vnd.tiddlywiki
Most browsers provide ''Web Developer Tools'' that include a JavaScript console. In Chrome and Firefox it can be opened via the ''Tools'' menu, or by pressing <kbd>Ctrl + Shift + J</kbd> (<kbd>Cmd + Shift + J</kbd> on a Mac).

26
editions/tw5.com/tiddlers/widgets/ActionLogWidget.tid
View File

@ -1,21 +1,29 @@
caption: action-log
created: 20201114113318785
modified: 20201114125859948
tags: Widgets ActionWidgets
modified: 20201120155202652
tags: Widgets ActionWidgets [[Debugging Widgets]]
title: ActionLogWidget
type: text/vnd.tiddlywiki
! Introduction
<<.from-version "5.1.23">> The ''action-log'' widget is an [[action widget|ActionWidgets]] that can be used to output debugging information to the JavaScript console supported by most browsers. This can be useful because otherwise it is difficult to observe what is going on within a sequence of actions.
<<.from-version "5.1.23">> The ''action-log'' widget is an [[action widget|ActionWidgets]] that can be used to output debugging information to the [[JavaScript console|Web Developer Tools]] supported by most browsers. This can be useful because otherwise it is difficult to observe what is going on within a sequence of actions.
ActionWidgets are used within triggering widgets such as the ButtonWidget.
<<.tip """ For debugging outside of actions see [[LogWidget]]""">>
! Content and Attributes
The ''action-log'' widget is invisible. Any content within it is ignored.
When the actions are invoked, the names and values of all attributes are logged to the JavaScript console.
In addition there are optional attributes that can be used:
|!Optional Attribute |!Description |
|$$filter|All variables matching this filter will also be logged. |
|$$message |A message to display as the title of the information logged. Useful when several `action-log` widgets are used in sequence. |
|$$all |Set to "yes" to log all variables in a collapsed table. Note that if there is nothing specified to log, all variables are always logged instead.|
<<.tip """A handy tip if an action widget is not behaving as expected is to temporarily change it to an `<$action-log>` widget so that the attributes can be observed.""">>
@ -28,3 +36,15 @@ Here is an example of logging two variables:
<$action-log myVar=<<myVar>> otherVar=<<otherVar>>/>
```
To log all variables:
```
<$action-log />
```
To log two variables as well as all core variables (which start with `tv-`):
```
<$action-log myVar=<<myVar>> other={{!!status}} $$filter="[prefix[tv-]]"/>
```

45
editions/tw5.com/tiddlers/widgets/LogWidget.tid Normal file
View File

@ -0,0 +1,45 @@
created: 20201120152706842
modified: 20201120154927696
tags: Widgets [[Debugging Widgets]]
title: LogWidget
type: text/vnd.tiddlywiki
! Introduction
<<.from-version "5.1.23">> The ''log'' widget can be used to output debugging information to the [[JavaScript console|Web Developer Tools]] supported by most browsers.
<<.tip """ For use with ActionWidgets see [[ActionLogWidget]] which uses identical parameters""">>
! Content and Attributes
The ''log'' widget is invisible. Any content within it is ignored. Note that the widget will log to the console both when it is first rendered and also every time it refreshes.
When the widget is rendered, the names and values of all attributes are logged to the JavaScript console.
In addition there are optional attributes that can be used:
|!Optional Attribute |!Description |
|$$filter|All variables matching this filter will also be logged. |
|$$message |A message to display as the title of the information logged. Useful when several `log` widgets are used in sequence. |
|$$all |Set to "yes" to log all variables in a collapsed table. Note that if there is nothing specified to log, all variables are always logged instead.|
! Example
Here is an example of logging two variables:
```
<$log myVar=<<myVar>> otherVar=<<otherVar>>/>
```
To log all variables:
```
<$log />
```
To log two variables as well as all core variables (which start with `tv-`):
```
<$log myVar=<<myVar>> other={{!!status}} $$filter="[prefix[tv-]]"/>
```