From 05243a6c4881546b76f239d9b2996511e1fbaba1 Mon Sep 17 00:00:00 2001 From: Jermolene Date: Sat, 16 Mar 2019 16:39:08 +0000 Subject: [PATCH 1/6] Docs: Add performance instrumentation docs --- .../features/Performance Instrumentation.tid | 31 +++++++++++++++++++ .../tiddlers/workingwithtw/Performance.tid | 3 +- 2 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 editions/tw5.com/tiddlers/features/Performance Instrumentation.tid diff --git a/editions/tw5.com/tiddlers/features/Performance Instrumentation.tid b/editions/tw5.com/tiddlers/features/Performance Instrumentation.tid new file mode 100644 index 000000000..b7a95a39c --- /dev/null +++ b/editions/tw5.com/tiddlers/features/Performance Instrumentation.tid @@ -0,0 +1,31 @@ +created: 20190316163428191 +modified: 20190316163657710 +tags: Features +title: Performance Instrumentation +type: text/vnd.tiddlywiki + +The core has built-in performance instrumentation for the refresh cycle. See “Performance Instrumentation” on the “Settings” tab of control panel. The wiki will need to be reloaded before it takes effect. + +With performance instrumentation switched on, there is additional timing information displayed the browser developer console each time a refresh cycle is triggered. For example: + +``` +performance: mainRender: 327.83ms +performance: +filter: 49.70ms +performance: styleRefresh: 9.14ms +performance: +filter: 2.46ms +performance: mainRefresh: 68.10ms +performance: +filter: 37.69ms +``` + +The information above should be interpreted as follows: + +<<< +"Initial rendering of the main page took 327ms (of which 50ms was filter evaluation). Refreshing the page stylesheet took 9ms (of which 2ms was filter evaluation). Refreshing the main page took 68ms (of which 38ms was filter evaluation)" +<<< + +* mainRender is the time taken for the initial display of the page template +* styleRefresh is the time taken to refresh the page stylesheet +* mainRender is the time taken to refresh the main page template +* in each case, +filter denotes the time taken up with filter evaluation. + +As an example, try switching between the sidebar tabs to compare how long they take to render. \ No newline at end of file diff --git a/editions/tw5.com/tiddlers/workingwithtw/Performance.tid b/editions/tw5.com/tiddlers/workingwithtw/Performance.tid index 32c9707c8..a701a06ac 100644 --- a/editions/tw5.com/tiddlers/workingwithtw/Performance.tid +++ b/editions/tw5.com/tiddlers/workingwithtw/Performance.tid @@ -1,5 +1,5 @@ created: 20150330155120127 -modified: 20160607145222633 +modified: 20190316163827303 tags: [[Working with TiddlyWiki]] title: Performance type: text/vnd.tiddlywiki @@ -10,3 +10,4 @@ TiddlyWiki ships with defaults that are designed to get the best out of modern d * ''Use the "Vanilla" theme''. The default "Snow White" theme includes visual effects like shadows, transparency and blurring that can be slow to render on older devices * ''Avoid large tiddlers''. Large bitmaps can significantly slow TiddlyWiki's performance. For example, an image taken with a modern smartphone will often be 5MB or more. Use ExternalImages whenever possible * ''Don't have too many tiddlers open at once''. Every tiddler you have open will require processing to keep it up to date as the store changes (for example, while you type into a draft tiddler). It is particularly easy when using zoomin story view to end up with dozens of tiddlers listed in the ''Open'' tab in the sidebar. Get into the habit of periodically closing all open tiddlers with the {{$:/core/images/close-all-button}} ''close all'' button +* ''Use the built-in performance instrumentation''. Studying the [[performance instrumentation|Performance Instrumentation]] results can help highlight performance problems From d51a89135dc3cde16bc0b3b8b67f8d5ff733fac2 Mon Sep 17 00:00:00 2001 From: Brooks Boyd Date: Fri, 22 Mar 2019 13:08:36 -0500 Subject: [PATCH 2/6] Add signature for MidnightDesign, LLC to CLA Entity agreement (#3877) --- licenses/cla-entity.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/licenses/cla-entity.md b/licenses/cla-entity.md index cb8603085..a42687687 100644 --- a/licenses/cla-entity.md +++ b/licenses/cla-entity.md @@ -12,7 +12,7 @@ This contributor agreement ("Agreement") documents the rights granted by contrib "CLA" means Contributor License Agreement (this document). "Contribution" means any work of authorship that is Submitted by You to Us in which You own or assert ownership of the Copyright. If You do not own the Copyright in the entire work of authorship, please follow the instructions in `contributing.md`, which is in the root directory of the project repository. - + "Copyright" means all rights protecting works of authorship owned or controlled by You or Your Affiliates, including copyright, moral and neighboring rights, as appropriate, for the full term of their existence including any extensions by You. "Material" means the work of authorship which is made available by Us to third parties. When this Agreement covers more than one software project, the Material means the work of authorship to which the Contribution was Submitted. After You Submit the Contribution, it may be included in the Material. @@ -25,7 +25,7 @@ This contributor agreement ("Agreement") documents the rights granted by contrib "Media" means any portion of a Contribution which is not software. -"Legal Entity" means an entity which is not a natural person. +"Legal Entity" means an entity which is not a natural person. "Affiliates" means other Legal Entities that control, are controlled by, or under common control with that Legal Entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such Legal Entity, whether by contract or otherwise, (ii) ownership of fifty percent (50%) or more of the outstanding shares or securities which vote to elect the management or other persons who direct such Legal Entity or (iii) beneficial ownership of such entity. @@ -71,7 +71,7 @@ You confirm that: (a) You have the legal authority to enter into this Agreement. -(b) You or Your Affiliates own the Copyright and patent claims covering the Contribution which are required to grant the rights under Section 2. +(b) You or Your Affiliates own the Copyright and patent claims covering the Contribution which are required to grant the rights under Section 2. (c) The grant of rights under Section 2 does not violate any grant of rights which You or Your Affiliates have made to third parties. @@ -109,3 +109,5 @@ eg: Jeremy Ruston, @Jermolene for Federatial Limited, 2011/11/22 Jeremy Ruston, @Jermolene for Federatial Limited, 2011/11/22 Google Inc, 2015/12/21 + +Brooks Boyd, @MidnightLightning for MidnightDesign, LLC 2019/03/21 From 4ecc99c9d5225e4a2045f32c1dbdd7792b5cb87e Mon Sep 17 00:00:00 2001 From: 00SS <38947777+00SS@users.noreply.github.com> Date: Wed, 10 Apr 2019 17:17:07 +0700 Subject: [PATCH 3/6] DOCS: Correction: How to change the sort order of sub-branches in a TOC macro.tid (#3783) Changed line `<>` to `<>` Tested that this is the correct code. --- ...change the sort order of sub-branches in a TOC macro.tid | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/editions/tw5.com/tiddlers/howtos/How to change the sort order of sub-branches in a TOC macro.tid b/editions/tw5.com/tiddlers/howtos/How to change the sort order of sub-branches in a TOC macro.tid index 76dbfcbf6..86ee4280d 100644 --- a/editions/tw5.com/tiddlers/howtos/How to change the sort order of sub-branches in a TOC macro.tid +++ b/editions/tw5.com/tiddlers/howtos/How to change the sort order of sub-branches in a TOC macro.tid @@ -1,5 +1,5 @@ created: 20161209172820513 -modified: 20161209174234840 +modified: 20190220000000000 tags: Learning title: How to change the sort order of sub-branches in a TOC macro type: text/vnd.tiddlywiki @@ -7,7 +7,7 @@ type: text/vnd.tiddlywiki Imagine that you are using a [[Table of Contents|Table-of-Contents Macros]] macro similar to this: ``` -<> +<> ``` The sorting is fine for most cases, but you would like all your items tagged `Journal` to be sorted by the `created` field. How can you apply a separate sort order to just those sub-items tagged `Journal`? @@ -17,7 +17,7 @@ The trick is to add a field to the parent tagging tiddler (i.e. `Journal`) that Now change your [[Table of Contents|Table-of-Contents Macros]] to look like this: ``` -<> +<> ``` Now your Table of Contents will sort by title everywhere, except for the children of the `Journal` tiddler, which will sort by the `created `date. From 53124e1d8276da541ff101ed33b846d88e4b6576 Mon Sep 17 00:00:00 2001 From: 00SS <38947777+00SS@users.noreply.github.com> Date: Wed, 10 Apr 2019 17:17:54 +0700 Subject: [PATCH 4/6] DOCS: Update: TiddlyWiki5 Squared by Iannis Zannos.tid (#3773) * Update TiddlyWiki5 Squared by Iannis Zannos.tid Link no longer works. Changed it to the github page. * Update TiddlyWiki5 Squared by Iannis Zannos.tid Fixed URL linking to the "ur" field --- .../resources/TiddlyWiki5 Squared by Iannis Zannos.tid | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/editions/tw5.com/tiddlers/community/resources/TiddlyWiki5 Squared by Iannis Zannos.tid b/editions/tw5.com/tiddlers/community/resources/TiddlyWiki5 Squared by Iannis Zannos.tid index b3a3e880b..4e9457218 100644 --- a/editions/tw5.com/tiddlers/community/resources/TiddlyWiki5 Squared by Iannis Zannos.tid +++ b/editions/tw5.com/tiddlers/community/resources/TiddlyWiki5 Squared by Iannis Zannos.tid @@ -1,14 +1,12 @@ created: 20141009170239174 -modified: 20141009170711343 +modified: 20190217000000000 tags: Resources title: "TiddlyWiki5^2 documenting while learning TiddlyWiki5" by Iannis Zannos type: text/vnd.tiddlywiki -url: http://larigot.avarts.ionio.gr/users/iani/wikis/tw5square.html +url: https://web.archive.org/web/20170728212414/http://larigot.avarts.ionio.gr/users/iani/wikis/tw5square.html A wealth of hints, tips and notes about using [[TiddlyWiki on Node.js]]: -{{!!url}} - <<< TiddlyWiki is different from other wikis because of its principle of dynamically customizeable "storyline" based on tiddlers as basic units of information. That is, the user "composes" their own version of the webpage by clicking on tiddler links, which add tiddlers to the page in order to compose a storyline. @@ -16,3 +14,7 @@ The Node.js implementation in TiddlyWiki5 adds all the advantages of flat-file m Also very cool is the treatment of tags as menus everywhere. <<< + +<$text text="http://larigot.avarts.ionio.gr/users/iani/wikis/tw5square.html"/> + +Also available on [[GitHub|https://github.com/iani/tw5square]] (download and save index.html and open it in your browser). From 12b08b7abfe79abf0a78b1d21d875256925a088a Mon Sep 17 00:00:00 2001 From: 00SS <38947777+00SS@users.noreply.github.com> Date: Wed, 10 Apr 2019 17:22:12 +0700 Subject: [PATCH 5/6] Docs: Update ListMacro.tid (#3754) Addressing 2 issues. 1) If the caption field of a tiddler is empty 2) A note addressing no input titles resulting in a Filter Run as brought up on [Google Groups](https://groups.google.com/forum/?hl=en#!topic/tiddlywikidev/VNl_cwu_rIE) --- editions/tw5.com/tiddlers/macros/ListMacro.tid | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/editions/tw5.com/tiddlers/macros/ListMacro.tid b/editions/tw5.com/tiddlers/macros/ListMacro.tid index 5ab99f8f3..7ee39ee12 100644 --- a/editions/tw5.com/tiddlers/macros/ListMacro.tid +++ b/editions/tw5.com/tiddlers/macros/ListMacro.tid @@ -1,13 +1,15 @@ caption: list-links created: 20140917083515996 -modified: 20180109171310659 +modified: 20190206000000000 tags: Macros [[Core Macros]] title: list-links Macro type: text/vnd.tiddlywiki The <<.def list-links>> [[macro|Macros]] returns a formatted list of links to a [[selection of tiddlers|Title Selection]]. -If a tiddler has a <<.field caption>> field, this is shown instead of the tiddler's title. +If a tiddler has a <<.field caption>> field, this is shown instead of the tiddler's title. If the caption field is empty, a blank entry is shown. + +Note: Each first [[step|Filter Step]] of a [[filter run|Filter Run]] not given any input titles receives the output of <$link to="all Operator">[all[tiddlers]] as its input. This means all the existing non-[[shadow|ShadowTiddlers]] tiddlers. !! Parameters From 61db047870c630d93f0817b48e31da4384d0c4e9 Mon Sep 17 00:00:00 2001 From: 00SS <38947777+00SS@users.noreply.github.com> Date: Fri, 12 Apr 2019 17:44:58 +0700 Subject: [PATCH 6/6] Docs: Update Headings in WikiText.tid (#3908) Changed the example to use the **wikitext-example** macro and pointed out that wikitext only works till `
` --- .../tw5.com/tiddlers/wikitext/Headings in WikiText.tid | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/editions/tw5.com/tiddlers/wikitext/Headings in WikiText.tid b/editions/tw5.com/tiddlers/wikitext/Headings in WikiText.tid index ac3f155d6..e23278db4 100644 --- a/editions/tw5.com/tiddlers/wikitext/Headings in WikiText.tid +++ b/editions/tw5.com/tiddlers/wikitext/Headings in WikiText.tid @@ -1,11 +1,11 @@ created: 20131205161234909 -modified: 20131205161256525 +modified: 20190412000000000 tags: WikiText title: Headings in WikiText type: text/vnd.tiddlywiki caption: Headings -Headings are specified with one or more leading `!` characters: +Headings are specified with one up to six leading `!` characters: ``` ! This is a level 1 heading @@ -17,6 +17,4 @@ Headings are specified with one or more leading `!` characters: CSS classes can be assigned to individual headings like this: -``` -!.myStyle This heading has the class `myStyle` -``` +<>