mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-27 03:57:21 +00:00
Code Issues Releases Wiki Activity

Docs: Minor formatting tweaks

Browse Source 
I was cloning this docs tiddler to experiment with docs for a new widget and noticed some punctuation inconsistencies
This commit is contained in:
jeremy@jermolene.com 2021-02-07 12:48:06 +00:00
parent 2b41661721
commit 40d21f607a
2 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
editions/tw5.com/tiddlers/styleguide/Tiddler Structure.tid
View File

@ -1,5 +1,5 @@
created: 20150110183300000
modified: 20150117152556000
modified: 20210207124737959
title: Tiddler Structure
tags: [[Improving TiddlyWiki Documentation]]
@ -13,4 +13,6 @@ Use numbered lists for step-by-step instructions, and bullet points for lists wh
Use a table when information naturally falls into three or more columns, and also for lists of parameters, attributes, etc in [[reference tiddlers|Reference Tiddlers]].
Avoid periods at the end of list items, headings and table cell text.
The documentation describes the current reality of ~TiddlyWiki. Avoid discussing future aspirations.

36
editions/tw5.com/tiddlers/widgets/EventCatcherWidget.tid
View File

@ -14,9 +14,9 @@ The event catcher widget traps DOM-initiated Javascript events dispatched within
In order for the events to be trapped they must:
* be of one of the events specified in the event catcher widget's `events` attribute.
* arise within a DOM node specified by the widget's `selector` attribute.
* support event bubbling.
* be of one of the events specified in the event catcher widget's `events` attribute
* arise within a DOM node specified by the widget's `selector` attribute
* support event bubbling
Use of the event catcher widget is beneficial when using large numbers of other trigger widgets such as the ButtonWidget is causing performance problems. The workflow it enables is akin to what is referred to as "event delegation" in JavaScript parlance.
@ -25,11 +25,11 @@ Use of the event catcher widget is beneficial when using large numbers of other
The content of the `<$eventcatcher>` widget is displayed normally.
|!Attribute |!Description |
|events |Space separated list of JavaScript events to be trapped, for example "click" or "click dblclick". |
|selector |A CSS selector. Only events originating inside a DOM node with this selector will be trapped. |
|events |Space separated list of JavaScript events to be trapped, for example "click" or "click dblclick" |
|selector |A CSS selector. Only events originating inside a DOM node with this selector will be trapped |
|actions-* |Action strings to be invoked when a matching event is trapped. Each event is mapped to an action attribute name of the form <code>actions-<em>event</em></code> where <code><em>event</em></code> represents the type of the event. For example: `actions-click` or `actions-dblclick` |
|tag |Optional. The HTML element the widget creates to capture the events, defaults to:<br>» `span` when parsed in inline-mode<br>» `div` when parsed in block-mode |
|class |Optional. A CSS class name (or names) to be assigned to the widget HTML element. |
|class |Optional. A CSS class name (or names) to be assigned to the widget HTML element |
! Variables
@ -38,18 +38,18 @@ The following variables are made available to the actions:
|!Variables |!Description |
|`dom-*` |All DOM attributes of the node matching the given selector are made available as variables, with the prefix `dom-` |
|`modifier` |The [[modifier Variable]] contains the Modifier Key held during the event (can be "normal", "ctrl", "shift", "alt" or combinations thereof) |
|`event-mousebutton`|The mouse button (if any) used to trigger the event (can be "left", "right" or "middle"). Note that not all event types support the mousebutton property |
|`event-type`|The type property of the JavaScript event |
|`event-detail-*`|Any properties in the detail attribute of the event are made available with the prefix `event-detail-` |
|`tv-popup-coords`|A co-ordinate string that can be used with the ActionPopupWidget to trigger a popup at the DOM node matching the selector where the event originated |
|`tv-selectednode-posx`|`x` offset position of the selected DOM node |
|`tv-selectednode-posy`|`y` offset position of the selected DOM node |
|`tv-selectednode-width`|`offsetWidth` of the selected DOM node |
|`tv-selectednode-height`|`offsetHeight` of the selected DOM node |
|`event-fromselected-posx`|`x` position of the event relative to the selected DOM node |
|`event-fromselected-posy`|`y` position of the event relative to the selected DOM node |
|`event-fromcatcher-posx`|`x` position of the event relative to the event catcher DOM node |
|`event-fromcatcher-posy`|`y` position of the event relative to the event catcher DOM node |
|`event-mousebutton` |The mouse button (if any) used to trigger the event (can be "left", "right" or "middle"). Note that not all event types support the mousebutton property |
|`event-type` |The type property of the JavaScript event |
|`event-detail-*` |Any properties in the detail attribute of the event are made available with the prefix `event-detail-` |
|`tv-popup-coords` |A co-ordinate string that can be used with the ActionPopupWidget to trigger a popup at the DOM node matching the selector where the event originated |
|`tv-selectednode-posx` |`x` offset position of the selected DOM node |
|`tv-selectednode-posy` |`y` offset position of the selected DOM node |
|`tv-selectednode-width` |`offsetWidth` of the selected DOM node |
|`tv-selectednode-height` |`offsetHeight` of the selected DOM node |
|`event-fromselected-posx` |`x` position of the event relative to the selected DOM node |
|`event-fromselected-posy` |`y` position of the event relative to the selected DOM node |
|`event-fromcatcher-posx` |`x` position of the event relative to the event catcher DOM node |
|`event-fromcatcher-posy` |`y` position of the event relative to the event catcher DOM node |
! Example