mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2026-08-07 03:18:53 +00:00
Code Issues Releases Wiki Activity

Docs tweaks

Browse Source
This commit is contained in:
Jeremy Ruston
2025-04-14 15:44:30 +01:00
parent 3801e2536c
commit 483522ea09
6 changed files with 37 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
editions/prerelease/tiddlers/system/DefaultTiddlers.tid
+2 -1
View File
@@ -2,8 +2,9 @@ created: 20131127215321439
modified: 20140912135951542
title: $:/DefaultTiddlers
[[$:/plugins/tiddlywiki/internals/config]]
[[$:/plugins/tiddlywiki/internals]]
[[$:/AdvancedSearch]]
[[$:/plugins/tiddlywiki/internals/config]]
[[$:/plugins/tiddlywiki/internals/filterinspection/docs/inspectoperator]]
[[$:/plugins/tiddlywiki/internals/filterinspection/docs/InspectFilterMacro]]
[[$:/plugins/tiddlywiki/internals/filterinspection/docs/inspectfiltermacro/examples]]
editions/tw5.com/tiddlers/system/DefaultTiddlers.tid
+2 -1
View File
@@ -3,8 +3,9 @@ modified: 20140912135951542
title: $:/DefaultTiddlers
type: text/vnd.tiddlywiki
[[$:/plugins/tiddlywiki/internals/config]]
[[$:/plugins/tiddlywiki/internals]]
[[$:/AdvancedSearch]]
[[$:/plugins/tiddlywiki/internals/config]]
[[$:/plugins/tiddlywiki/internals/filterinspection/docs/inspectoperator]]
[[$:/plugins/tiddlywiki/internals/filterinspection/docs/InspectFilterMacro]]
[[$:/plugins/tiddlywiki/internals/filterinspection/docs/inspectfiltermacro/examples]]
plugins/tiddlywiki/internals/docs.tid
+13
View File
@@ -0,0 +1,13 @@
title: $:/plugins/tiddlywiki/internals/docs
!! `<<inspect-filter>>` Procedure
{{$:/plugins/tiddlywiki/internals/filterinspection/docs/InspectFilterMacro}}
!!! `<<inspect-filter>>` Procedure Examples
{{$:/plugins/tiddlywiki/internals/filterinspection/docs/inspectfiltermacro/examples}}
!! `inspect` Operator
{{$:/plugins/tiddlywiki/internals/filterinspection/docs/inspectoperator}}
plugins/tiddlywiki/internals/filterinspection/docs/InspectFilterMacro.tid
+4 -4
View File
@@ -2,17 +2,17 @@ caption: inspect-filter
title: $:/plugins/tiddlywiki/internals/filterinspection/docs/InspectFilterMacro
type: text/vnd.tiddlywiki
The <<.def inspect-filter>> [[macro|Macros]] displays a schematic representation of the filter evaluation process, including the input, output and intermediate results of evaluating the specified filter. It is based on the [[inspect operator|inspect Operator]].
The <<.def inspect-filter>> procedure displays a schematic representation of the filter evaluation process, including the input, output and intermediate results of evaluating the specified filter. It is based on the [[inspect operator|$:/plugins/tiddlywiki/internals/filterinspection/docs/inspectoperator]].
By default the tabs are arranged horizontally above the content. To get vertical tabs, set the <<.param class>> parameter to <<.value tc-vertical>>.
By default the tabs are arranged horizontally above the content. To get vertical tabs, set the `orientation` parameter to `vertical`. This is useful for narrow windows or when the content is too wide to fit in a horizontal tab layout.
!! Parameters
;filter
: The [[filter|Filters]] to be inspected
: The filter to be inspected
;inputFilter
: Optionally, a filter defining the input titles for the filter to be inspected, defaulting to `[all[tiddlers]]`
;orientation
: Optionally, the orientation of the schematic representation, defaulting to `horizontal`. Set to `vertical` to display the tabs vertically. This is useful for narrow windows or when the content is too wide to fit in a horizontal tab layout
: Optionally, the orientation of the schematic representation, defaulting to `horizontal`. Set to `vertical` to display the tabs vertically
[[Examples|$:/plugins/tiddlywiki/internals/filterinspection/docs/inspectfiltermacro/examples]]
plugins/tiddlywiki/internals/plugin.info
+1 -1
View File
@@ -2,6 +2,6 @@
"title": "$:/plugins/tiddlywiki/internals",
"name": "Internals",
"description": "Tools for exploring the internals of TiddlyWiki",
"list": "readme config",
"list": "readme docs config",
"stability": "STABILITY_2_STABLE"
}
plugins/tiddlywiki/internals/readme.tid
+15 -6
View File
@@ -1,10 +1,19 @@
title: $:/plugins/tiddlywiki/internals/readme
This plugin adds features to help explore the internals of TiddlyWiki:
This plugin adds several features to help explore the internals of TiddlyWiki, and to debug issues with wikitext and filters.
* New preview panes showing:
** the parse tree
** the widget tree
** the raw HTML output
!! Inspecting Filters
The first two include a dropdown for choosing block vs. inline parsing mode.
Filter inspection is based on a schematic visualisation that shows all the steps involved in evaluating a filter. These schematics can be generated and accessed in several ways:
* A new "Inspect" tab under the Advanced Search filter results that shows the schematic for the current filter
* The background filter inspection mechanism allows specific filters to be registered to be inspected whenever they are evaluated, regardless of the context. The output of the inspection is only saved if the results are different than previous evaluations
* Directly using the `<<inspect-filter>>` procedure, or the underlying `inspect[]` operator
!! Inspecting Parse Trees and Widget Trees
New preview panes for the tiddler editor that show
* the parse tree
* the widget tree
* the raw HTML output