tiddlywiki 5.2.2 → 5.2.3

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,67 @@
+name: Bug report
+description: Create a report to help us improve TiddlyWiki 5
+title: "[BUG] "
+body:
+  - type: textarea
+    id: Describe
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: Expected
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: false
+  - type: textarea
+    id: Reproduce
+    attributes:
+      label: To Reproduce
+      description: "Steps to reproduce the behavior:"
+      value: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: false
+  - type: textarea
+    id: Screenshots
+    attributes:
+      label: Screenshots
+      description: If applicable, add screenshots to help explain your problem.
+      placeholder: Drag image here to upload screenshot!
+    validations:
+      required: false
+  - type: textarea
+    id: Configuration
+    attributes:
+      label: TiddlyWiki Configuration
+      description: please complete the following information
+      value: |
+        - Version [e.g. v5.1.24]
+        - Saving mechanism [e.g. Node.js, TiddlyDesktop, TiddlyHost etc]
+        - Plugins installed [e.g. Freelinks, TiddlyMap]
+
+        ### Desktop (please complete the following information):
+
+        - OS: [e.g. iOS]
+        - Browser [e.g. chrome, safari]
+        - Version [e.g. 22]
+
+        ### Smartphone (please complete the following information):
+
+        - Device: [e.g. iPhone6]
+        - OS: [e.g. iOS8.1]
+        - Browser [e.g. stock browser, safari]
+        - Version [e.g. 22]
+    validations:
+      required: true
+  - type: textarea
+    id: Context
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discuss feature request
+    url: https://github.com/Jermolene/TiddlyWiki5/discussions
+    about: Open new discussion about new feature
+  - name: Talk.Tiddlywiki Forum
+    url: https://talk.tiddlywiki.org
+    about: Join the Forum

package/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -20,3 +20,11 @@ A clear and concise description of any alternative solutions or features you've
 Add any other context or screenshots about the feature request here.
 
 If you link to discussions elsewhere then please copy and paste the important text, and don't expect readers to scan the entire discussion to find the relevant part.
+
+## Checklist before requesting a review
+
+- [ ] Illustrate any visual changes (however minor) with before/after screenshots
+- [ ] Self-review of code
+- [ ] Documentation updates (for user-visible changes)
+- [ ] Tests (for core code changes)
+- [ ] Complies with coding style guidelines (for JavaScript code)

package/bin/build-site.sh

@@ -5,7 +5,7 @@
 # Default to the current version number for building the plugin library
 
 if [  -z "$TW5_BUILD_VERSION" ]; then
-    TW5_BUILD_VERSION=v5.2.2
+    TW5_BUILD_VERSION=v5.2.3
 fi
 
 echo "Using TW5_BUILD_VERSION as [$TW5_BUILD_VERSION]"

package/boot/boot.js

@@ -2596,7 +2596,7 @@ $tw.boot.isStartupTaskEligible = function(taskModule) {
 		for(t=0; t<remaining.length; t++) {
 			var task = remaining[t];
 			if(task.before && task.before.indexOf(name) !== -1) {
-				if($tw.boot.doesTaskMatchPlatform(task) || (task.name && $tw.boot.disabledStartupModules.indexOf(name) !== -1)) {
+				if($tw.boot.doesTaskMatchPlatform(task) && (!task.name || $tw.boot.disabledStartupModules.indexOf(task.name) === -1)) {
 					return false;
 				}
 			}

package/contributing.md

@@ -1,3 +1,3 @@
-<h1 class="">Contributing to <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/TiddlyWiki5.html">TiddlyWiki5</a></h1><p>Here we focus on contributions via <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/GitHub.html">GitHub</a> Pull Requests but there are many other ways that anyone can help the <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> project, such as <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/ReportingBugs.html">reporting bugs</a> or helping to <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/Improving%2520TiddlyWiki%2520Documentation.html">improve our documentation</a>.</p><h1 class="">Rules for Pull Requests</h1><p>PRs must meet these minimum requirements before they can be considered for merging:</p><ul><li>The material in the PR must be free of licensing restrictions. Which means that either:<ul><li>The author must hold the copyright in all of the material themselves</li><li>The material must be licensed under a license compatible with <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a>'s BSD license</li></ul></li><li>The author must sign the Contributors License Agreement (see below)</li><li>Each PR should only make a single feature change</li><li>The title of the PR should be 50 characters or less</li><li>The title of the PR should be capitalised, and should not end with a period</li><li>The title of the PR should be written in the imperative mood. See below</li><li>Adequate explanation in the body of the PR for the motivation and implementation of the change. Focus on the <em>why</em> and <em>what</em>, rather than the <em>how</em></li><li>PRs must be self-contained. Although they can link to material elsewhere, everything needed to understand the intention of the PR should be included</li><li>Documentation as appropriate for end-users or developers</li><li>Observe the coding style</li><li>Read the developers documentation</li><li>Please open a consultation issue prior to investing time in making a large PR</li></ul><h2 class="">Imperative Mood for PR Titles</h2><p>The "imperative mood" means written as if giving a command or instruction. See <a class="tc-tiddlylink-external" href="https://chris.beams.io/posts/git-commit/#imperative" rel="noopener noreferrer" target="_blank">this post</a> for more details, but the gist is that the title of the PR should make sense when used to complete the sentence "If applied, this commit will...". So for example, these are good PR titles:</p><ul><li>If applied, this commit will <em>update the contributing guidelines</em></li><li>If applied, this commit will <em>change css-escape-polyfill to a $tw.utils method</em></li><li>If applied, this commit will <em>make it easier to subclass the wikitext parser with a custom rule set</em></li></ul><p>These a poorly worded PR titles:</p><ul><li><strike>If applied, this commit will <em>edit text widgets should use default text for missing fields</em></strike></li><li><strike>If applied, this commit will <em>signing the CLA</em></strike></li><li><strike>If applied, this commit will <em>don't crash if options.event is missing</em></strike></li></ul><p>PR titles may also include a short prefix to indicate the subsystem to which they apply. For example:</p><ul><li><em>Menu plugin: Include menu text in aerial rotator</em></li></ul><h1 class="">Commenting on Pull Requests</h1><p>One of the principles of open source is that many pairs of eyes on the code can improve quality. So, we welcome comments and critiques of pending PRs. <a class="tc-tiddlylink-external" href="https://conventionalcomments.org" rel="noopener noreferrer" target="_blank">Conventional Comments</a> has some techniques to help make comments as constructive and actionable as possible. Notably, they recommend prefixing a comment with a label to clarify the intention:</p><table><tbody><tr class="evenRow"><td align="left">praise</td><td align="left">Praises highlight something positive. Try to leave at least one of these comments per review. Do not leave false praise (which can actually be damaging). Do look for something to sincerely praise</td></tr><tr class="oddRow"><td align="left">nitpick</td><td align="left">Nitpicks are small, trivial, but necessary changes. Distinguishing nitpick comments significantly helps direct the reader's attention to comments requiring more involvement</td></tr><tr class="evenRow"><td align="left">suggestion</td><td align="left">Suggestions are specific requests to improve the subject under review. It is assumed that we all want to do what's best, so these comments are never dismissed as “mere suggestions”, but are taken seriously</td></tr><tr class="oddRow"><td align="left">issue</td><td align="left">Issues represent user-facing problems. If possible, it's great to follow this kind of comment with a suggestion</td></tr><tr class="evenRow"><td align="left">question</td><td align="left">Questions are appropriate if you have a potential concern but are not quite sure if it's relevant or not. Asking the author for clarification or investigation can lead to a quick resolution</td></tr><tr class="oddRow"><td align="left">thought</td><td align="left">Thoughts represent an idea that popped up from reviewing. These comments are non-blocking by nature, but they are extremely valuable and can lead to more focused initiatives and mentoring opportunities</td></tr><tr class="evenRow"><td align="left">chore</td><td align="left">Chores are simple tasks that must be done before the subject can be “officially” accepted. Usually, these comments reference some common process. Try to leave a link to the process description so that the reader knows how to resolve the chore</td></tr></tbody></table><h1 class="">Contributor License Agreement</h1><p>Like other <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/OpenSource.html">OpenSource</a> projects, <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/TiddlyWiki5.html">TiddlyWiki5</a> needs a signed contributor license agreement from individual contributors. This is a legal agreement that allows contributors to assert that they own the copyright of their contribution, and that they agree to license it to the <a class="tc-tiddlylink tc-tiddlylink-missing" href="https://tiddlywiki.com/static/UnaMesa.html">UnaMesa</a> Association (the legal entity that owns <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> on behalf of the community).</p><ul><li>For individuals use: <a class="tc-tiddlylink-external" href="https://github.com/Jermolene/TiddlyWiki5/tree/tiddlywiki-com/licenses/cla-individual.md" rel="noopener noreferrer" target="_blank">licenses/CLA-individual</a></li><li>For entities use: <a class="tc-tiddlylink-external" href="https://github.com/Jermolene/TiddlyWiki5/tree/tiddlywiki-com/licenses/cla-entity.md" rel="noopener noreferrer" target="_blank">licenses/CLA-entity</a></li></ul><h1 class="">How to sign the CLA</h1><p>Create a <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/GitHub.html">GitHub</a> pull request to add your name to <code>cla-individual.md</code> or <code>cla-entity.md</code>, with the date in the format (YYYY/MM/DD).</p><p><strong>step by step</strong></p><ol><li>Navigate to <a class="tc-tiddlylink-external" href="https://github.com/Jermolene/TiddlyWiki5/tree/tiddlywiki-com/licenses/cla-individual.md" rel="noopener noreferrer" target="_blank">licenses/CLA-individual</a> or <a class="tc-tiddlylink-external" href="https://github.com/Jermolene/TiddlyWiki5/tree/tiddlywiki-com/licenses/cla-entity.md" rel="noopener noreferrer" target="_blank">licenses/CLA-entity</a> according to whether you are signing as an individual or representative of an organisation</li><li>Ensure that the "branch" dropdown at the top left is set to <code>tiddlywiki-com</code></li><li>Click the "edit" button at the top-right corner (clicking this button will fork the project so you can edit the file)</li><li>Add your name at the bottom<ul><li>eg: <code>Jeremy Ruston, @Jermolene, 2011/11/22</code></li></ul></li><li>Below the edit box for the CLA text you should see a box labelled <strong>Propose file change</strong></li><li>Enter a brief title to explain the change (eg, "Signing the CLA")</li><li>Click the green button labelled <strong>Propose file change</strong></li><li>On the following screen, click the green button labelled <strong>Create pull request</strong></li></ol><hr><p><em>The CLA documents used for this project were created using <a class="tc-tiddlylink-external" href="http://www.harmonyagreements.org" rel="noopener noreferrer" target="_blank">Harmony Project Templates</a>. "HA-CLA-I-LIST Version 1.0" for "CLA-individual" and "HA-CLA-E-LIST Version 1.0" for "CLA-entity".</em>
+<h1 class="">Contributing to <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/TiddlyWiki5.html">TiddlyWiki5</a></h1><p>Here we focus on contributions via <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/GitHub.html">GitHub</a> Pull Requests but there are many other ways that anyone can help the <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> project, such as <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/ReportingBugs.html">reporting bugs</a> or helping to <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/Improving%2520TiddlyWiki%2520Documentation.html">improve our documentation</a>.</p><h1 class="">Rules for Pull Requests</h1><p>PRs must meet these minimum requirements before they can be considered for merging:</p><ul><li>The material in the PR must be free of licensing restrictions. Which means that either:<ul><li>The author must hold the copyright in all of the material themselves</li><li>The material must be licensed under a license compatible with <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a>'s BSD license</li></ul></li><li>The author must sign the Contributors License Agreement (see below)</li><li>Each PR should only make a single feature change</li><li>The title of the PR should be 50 characters or less</li><li>The title of the PR should be capitalised, and should not end with a period</li><li>The title of the PR should be written in the imperative mood. See below</li><li>Adequate explanation in the body of the PR for the motivation and implementation of the change. Focus on the <em>why</em> and <em>what</em>, rather than the <em>how</em></li><li>PRs must be self-contained. Although they can link to material elsewhere, everything needed to understand the intention of the PR should be included</li><li>Any visual changes introduced by the PR should be noted and illustrated with before/after screenshots</li><li>Documentation as appropriate for end-users or developers</li><li>Observe the coding style</li><li>Read the developers documentation</li><li>Please open a consultation issue prior to investing time in making a large PR</li></ul><h2 class="">Imperative Mood for PR Titles</h2><p>The "imperative mood" means written as if giving a command or instruction. See <a class="tc-tiddlylink-external" href="https://chris.beams.io/posts/git-commit/#imperative" rel="noopener noreferrer" target="_blank">this post</a> for more details, but the gist is that the title of the PR should make sense when used to complete the sentence "If applied, this commit will...". So for example, these are good PR titles:</p><ul><li>If applied, this commit will <em>update the contributing guidelines</em></li><li>If applied, this commit will <em>change css-escape-polyfill to a $tw.utils method</em></li><li>If applied, this commit will <em>make it easier to subclass the wikitext parser with a custom rule set</em></li></ul><p>These a poorly worded PR titles:</p><ul><li><strike>If applied, this commit will <em>edit text widgets should use default text for missing fields</em></strike></li><li><strike>If applied, this commit will <em>signing the CLA</em></strike></li><li><strike>If applied, this commit will <em>don't crash if options.event is missing</em></strike></li></ul><p>PR titles may also include a short prefix to indicate the subsystem to which they apply. For example:</p><ul><li><em>Menu plugin: Include menu text in aerial rotator</em></li></ul><h1 class="">Commenting on Pull Requests</h1><p>One of the principles of open source is that many pairs of eyes on the code can improve quality. So, we welcome comments and critiques of pending PRs. <a class="tc-tiddlylink-external" href="https://conventionalcomments.org" rel="noopener noreferrer" target="_blank">Conventional Comments</a> has some techniques to help make comments as constructive and actionable as possible. Notably, they recommend prefixing a comment with a label to clarify the intention:</p><table><tbody><tr class="evenRow"><td align="left">praise</td><td align="left">Praises highlight something positive. Try to leave at least one of these comments per review. Do not leave false praise (which can actually be damaging). Do look for something to sincerely praise</td></tr><tr class="oddRow"><td align="left">nitpick</td><td align="left">Nitpicks are small, trivial, but necessary changes. Distinguishing nitpick comments significantly helps direct the reader's attention to comments requiring more involvement</td></tr><tr class="evenRow"><td align="left">suggestion</td><td align="left">Suggestions are specific requests to improve the subject under review. It is assumed that we all want to do what's best, so these comments are never dismissed as “mere suggestions”, but are taken seriously</td></tr><tr class="oddRow"><td align="left">issue</td><td align="left">Issues represent user-facing problems. If possible, it's great to follow this kind of comment with a suggestion</td></tr><tr class="evenRow"><td align="left">question</td><td align="left">Questions are appropriate if you have a potential concern but are not quite sure if it's relevant or not. Asking the author for clarification or investigation can lead to a quick resolution</td></tr><tr class="oddRow"><td align="left">thought</td><td align="left">Thoughts represent an idea that popped up from reviewing. These comments are non-blocking by nature, but they are extremely valuable and can lead to more focused initiatives and mentoring opportunities</td></tr><tr class="evenRow"><td align="left">chore</td><td align="left">Chores are simple tasks that must be done before the subject can be “officially” accepted. Usually, these comments reference some common process. Try to leave a link to the process description so that the reader knows how to resolve the chore</td></tr></tbody></table><h1 class="">Contributor License Agreement</h1><p>Like other <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/OpenSource.html">OpenSource</a> projects, <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/TiddlyWiki5.html">TiddlyWiki5</a> needs a signed contributor license agreement from individual contributors. This is a legal agreement that allows contributors to assert that they own the copyright of their contribution, and that they agree to license it to the <a class="tc-tiddlylink tc-tiddlylink-missing" href="https://tiddlywiki.com/static/UnaMesa.html">UnaMesa</a> Association (the legal entity that owns <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> on behalf of the community).</p><ul><li>For individuals use: <a class="tc-tiddlylink-external" href="https://github.com/Jermolene/TiddlyWiki5/tree/tiddlywiki-com/licenses/cla-individual.md" rel="noopener noreferrer" target="_blank">licenses/CLA-individual</a></li><li>For entities use: <a class="tc-tiddlylink-external" href="https://github.com/Jermolene/TiddlyWiki5/tree/tiddlywiki-com/licenses/cla-entity.md" rel="noopener noreferrer" target="_blank">licenses/CLA-entity</a></li></ul><h1 class="">How to sign the CLA</h1><p>Create a <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/GitHub.html">GitHub</a> pull request to add your name to <code>cla-individual.md</code> or <code>cla-entity.md</code>, with the date in the format (YYYY/MM/DD).</p><p><strong>step by step</strong></p><ol><li>Navigate to <a class="tc-tiddlylink-external" href="https://github.com/Jermolene/TiddlyWiki5/tree/tiddlywiki-com/licenses/cla-individual.md" rel="noopener noreferrer" target="_blank">licenses/CLA-individual</a> or <a class="tc-tiddlylink-external" href="https://github.com/Jermolene/TiddlyWiki5/tree/tiddlywiki-com/licenses/cla-entity.md" rel="noopener noreferrer" target="_blank">licenses/CLA-entity</a> according to whether you are signing as an individual or representative of an organisation</li><li>Ensure that the "branch" dropdown at the top left is set to <code>tiddlywiki-com</code></li><li>Click the "edit" button at the top-right corner (clicking this button will fork the project so you can edit the file)</li><li>Add your name at the bottom<ul><li>eg: <code>Jeremy Ruston, @Jermolene, 2011/11/22</code></li></ul></li><li>Below the edit box for the CLA text you should see a box labelled <strong>Propose file change</strong></li><li>Enter a brief title to explain the change (eg, "Signing the CLA")</li><li>Click the green button labelled <strong>Propose file change</strong></li><li>On the following screen, click the green button labelled <strong>Create pull request</strong></li></ol><hr><p><em>The CLA documents used for this project were created using <a class="tc-tiddlylink-external" href="http://www.harmonyagreements.org" rel="noopener noreferrer" target="_blank">Harmony Project Templates</a>. "HA-CLA-I-LIST Version 1.0" for "CLA-individual" and "HA-CLA-E-LIST Version 1.0" for "CLA-entity".</em>
 </p><p><em>This file was automatically generated by <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/TiddlyWiki5.html">TiddlyWiki5</a></em>
 </p>

package/core/language/en-GB/EditTemplate.multids

@@ -1,5 +1,6 @@
 title: $:/language/EditTemplate/
 
+Caption: Editor
 Body/External/Hint: This tiddler shows content stored outside of the main TiddlyWiki file. You can edit the tags and fields but cannot directly edit the content itself
 Body/Placeholder: Type the text for this tiddler
 Body/Preview/Type/Output: output

package/core/language/en-GB/Help/default.tid

@@ -3,6 +3,7 @@ title: $:/language/Help/default
 \define commandTitle()
 $:/language/Help/$(command)$
 \end
+\whitespace trim
 ```
 usage: tiddlywiki [<wikifolder>] [--<command> [<args>...]...]
 ```
@@ -11,7 +12,9 @@ Available commands:
 
 <ul>
 <$list filter="[commands[]sort[title]]" variable="command">
-<li><$link to=<<commandTitle>>><$macrocall $name="command" $type="text/plain" $output="text/plain"/></$link>: <$transclude tiddler=<<commandTitle>> field="description"/></li>
+<li><$link to=<<commandTitle>>><$macrocall $name="command" $type="text/plain" $output="text/plain"/></$link>:
+&#32;
+<$transclude tiddler=<<commandTitle>> field="description"/></li>
 </$list>
 </ul>
 

package/core/language/en-GB/Help/render.tid

@@ -31,5 +31,5 @@ Notes:
 
 Examples:
 
-* `--render "[!is[system]]" "[encodeuricomponent[]addprefix[tiddlers/]addsuffix[.html]]"` -- renders all non-system tiddlers as files in the subdirectory "tiddlers" with URL-encoded titles and the extension HTML
-
+* `--render '[!is[system]]' '[encodeuricomponent[]addprefix[tiddlers/]addsuffix[.html]]'` -- renders all non-system tiddlers as files in the subdirectory "tiddlers" with URL-encoded titles and the extension HTML
+* `--render '.' 'tiddlers.json' 'text/plain' '$:/core/templates/exporters/JsonFile' 'exportFilter' '[tag[HelloThere]]'` -- renders the tiddlers tagged "HelloThere" to a JSON file named "tiddlers.json"

package/core/language/en-GB/SideBar.multids

@@ -1,5 +1,6 @@
 title: $:/language/SideBar/
 
+Caption: Sidebar
 All/Caption: All
 Contents/Caption: Contents
 Drafts/Caption: Drafts

package/core/modules/commands/render.js

@@ -50,7 +50,7 @@ Render individual tiddlers and save the results to the specified files
 				console.log("Rendering \"" + title + "\" to \"" + filepath + "\"");
 			}
 			var parser = wiki.parseTiddler(template || title),
-				widgetNode = wiki.makeWidget(parser,{variables: $tw.utils.extend({},variables,{currentTiddler: title})}),
+				widgetNode = wiki.makeWidget(parser,{variables: $tw.utils.extend({},variables,{currentTiddler: title,storyTiddler: title})}),
 				container = $tw.fakeDocument.createElement("div");
 			widgetNode.render(container,null);
 			var text = type === "text/html" ? container.innerHTML : container.textContent;

package/core/modules/commands/rendertiddler.js

@@ -40,6 +40,7 @@ Command.prototype.execute = function() {
 	$tw.utils.createFileDirectories(filename);
 	if(template) {
 		variables.currentTiddler = title;
+		variables.storyTiddler = title;
 		title = template;
 	}
 	if(name && value) {

package/core/modules/commands/rendertiddlers.js

@@ -46,7 +46,7 @@ Command.prototype.execute = function() {
 	}
 	$tw.utils.each(tiddlers,function(title) {
 		var parser = wiki.parseTiddler(template),
-			widgetNode = wiki.makeWidget(parser,{variables: {currentTiddler: title}}),
+			widgetNode = wiki.makeWidget(parser,{variables: {currentTiddler: title, storyTiddler: title}}),
 			container = $tw.fakeDocument.createElement("div");
 		widgetNode.render(container,null);
 		var text = type === "text/html" ? container.innerHTML : container.textContent,

package/core/modules/commands/save.js

@@ -8,46 +8,60 @@ Saves individual tiddlers in their raw text or binary format to the specified fi
 \*/
 (function(){
 
-/*jslint node: true, browser: true */
-/*global $tw: false */
-"use strict";
-
-exports.info = {
-	name: "save",
-	synchronous: true
-};
-
-var Command = function(params,commander,callback) {
-	this.params = params;
-	this.commander = commander;
-	this.callback = callback;
-};
-
-Command.prototype.execute = function() {
-	if(this.params.length < 1) {
-		return "Missing filename filter";
-	}
-	var self = this,
-		fs = require("fs"),
-		path = require("path"),
-		wiki = this.commander.wiki,
-		tiddlerFilter = this.params[0],
-		filenameFilter = this.params[1] || "[is[tiddler]]",
-		tiddlers = wiki.filterTiddlers(tiddlerFilter);
-	$tw.utils.each(tiddlers,function(title) {
-		var tiddler = self.commander.wiki.getTiddler(title),
-			type = tiddler.fields.type || "text/vnd.tiddlywiki",
-			contentTypeInfo = $tw.config.contentTypeInfo[type] || {encoding: "utf8"},
-			filepath = path.resolve(self.commander.outputPath,wiki.filterTiddlers(filenameFilter,$tw.rootWidget,wiki.makeTiddlerIterator([title]))[0]);
-		if(self.commander.verbose) {
-			console.log("Saving \"" + title + "\" to \"" + filepath + "\"");
+	/*jslint node: true, browser: true */
+	/*global $tw: false */
+	"use strict";
+	
+	exports.info = {
+		name: "save",
+		synchronous: true
+	};
+	
+	var Command = function(params,commander,callback) {
+		this.params = params;
+		this.commander = commander;
+		this.callback = callback;
+	};
+	
+	Command.prototype.execute = function() {
+		if(this.params.length < 1) {
+			return "Missing filename filter";
 		}
-		$tw.utils.createFileDirectories(filepath);
-		fs.writeFileSync(filepath,tiddler.fields.text,contentTypeInfo.encoding);
-	});
-	return null;
-};
-
-exports.Command = Command;
-
-})();
+		var self = this,
+			fs = require("fs"),
+			path = require("path"),
+			result = null,
+			wiki = this.commander.wiki,
+			tiddlerFilter = this.params[0],
+			filenameFilter = this.params[1] || "[is[tiddler]]",
+			tiddlers = wiki.filterTiddlers(tiddlerFilter);
+		$tw.utils.each(tiddlers,function(title) {
+			if(!result) {
+				var tiddler = self.commander.wiki.getTiddler(title);
+				if(tiddler) {
+					var fileInfo = $tw.utils.generateTiddlerFileInfo(tiddler,{
+						directory: path.resolve(self.commander.outputPath),
+						pathFilters: [filenameFilter],
+						wiki: wiki,
+						fileInfo: {}
+					});
+					if(self.commander.verbose) {
+						console.log("Saving \"" + title + "\" to \"" + fileInfo.filepath + "\"");
+					}
+					try {
+						$tw.utils.saveTiddlerToFileSync(tiddler,fileInfo);
+					} catch (err) {
+						result = "Error saving tiddler \"" + title + "\", to file: \"" + fileInfo.filepath + "\"";
+					}
+				} else {
+					result = "Tiddler '" + title + "' not found";
+				}
+			}
+		});
+		return result;
+	};
+	
+	exports.Command = Command;
+	
+	})();
+	

package/core/modules/editor/engines/framed.js

@@ -34,8 +34,10 @@ function FramedEngine(options) {
 	this.parentNode.insertBefore(this.iframeNode,this.nextSibling);
 	this.iframeDoc = this.iframeNode.contentWindow.document;
 	// (Firefox requires us to put some empty content in the iframe)
+	var paletteTitle = this.widget.wiki.getTiddlerText("$:/palette");
+	var colorScheme = (this.widget.wiki.getTiddler(paletteTitle) || {fields: {}}).fields["color-scheme"] || "light";
 	this.iframeDoc.open();
-	this.iframeDoc.write("");
+	this.iframeDoc.write("<meta name='color-scheme' content='" + colorScheme + "'>");
 	this.iframeDoc.close();
 	// Style the iframe
 	this.iframeNode.className = this.dummyTextArea.className;

package/core/modules/editor/operations/text/prefix-lines.js

@@ -25,8 +25,8 @@ exports["prefix-lines"] = function(event,operation) {
 	$tw.utils.each(lines,function(line,index) {
 		// Remove and count any existing prefix characters
 		var count = 0;
-		while(line.charAt(0) === event.paramObject.character) {
-			line = line.substring(1);
+		while($tw.utils.startsWith(line,event.paramObject.character)) {
+			line = line.substring(event.paramObject.character.length);
 			count++;
 		}
 		// Remove any whitespace

package/core/modules/editor/operations/text/wrap-lines.js

@@ -15,16 +15,33 @@ Text editor operation to wrap the selected lines with a prefix and suffix
 exports["wrap-lines"] = function(event,operation) {
 	var prefix = event.paramObject.prefix || "",
 		suffix = event.paramObject.suffix || "";
-	// Cut just past the preceding line break, or the start of the text
-	operation.cutStart = $tw.utils.findPrecedingLineBreak(operation.text,operation.selStart);
-	// Cut to just past the following line break, or to the end of the text
-	operation.cutEnd = $tw.utils.findFollowingLineBreak(operation.text,operation.selEnd);
-	// Add the prefix and suffix
-	operation.replacement = prefix + "\n" +
-				operation.text.substring(operation.cutStart,operation.cutEnd) + "\n" +
-				suffix + "\n";
-	operation.newSelStart = operation.cutStart + prefix.length + 1;
-	operation.newSelEnd = operation.newSelStart + (operation.cutEnd - operation.cutStart);
+	if($tw.utils.endsWith(operation.text.substring(0,operation.selStart), prefix + "\n") &&
+			$tw.utils.startsWith(operation.text.substring(operation.selEnd), "\n" + suffix)) {
+		// Selected text is already surrounded by prefix and suffix: Remove them
+		// Cut selected text plus prefix and suffix
+		operation.cutStart = operation.selStart - (prefix.length + 1);
+		operation.cutEnd = operation.selEnd + suffix.length + 1;
+		// Also cut the following newline (if there is any)
+		if (operation.text[operation.cutEnd] === "\n") {
+			operation.cutEnd++;
+		}
+		// Replace with selection
+		operation.replacement = operation.text.substring(operation.selStart,operation.selEnd);
+		// Select text that was in between prefix and suffix
+		operation.newSelStart = operation.cutStart;
+		operation.newSelEnd = operation.selEnd - (prefix.length + 1);
+	} else {
+		// Cut just past the preceding line break, or the start of the text
+		operation.cutStart = $tw.utils.findPrecedingLineBreak(operation.text,operation.selStart);
+		// Cut to just past the following line break, or to the end of the text
+		operation.cutEnd = $tw.utils.findFollowingLineBreak(operation.text,operation.selEnd);
+		// Add the prefix and suffix
+		operation.replacement = prefix + "\n" +
+					operation.text.substring(operation.cutStart,operation.cutEnd) + "\n" +
+					suffix + "\n";
+		operation.newSelStart = operation.cutStart + prefix.length + 1;
+		operation.newSelEnd = operation.newSelStart + (operation.cutEnd - operation.cutStart);
+	}
 };
 
 })();

package/core/modules/filterrunprefixes/map.js

@@ -16,7 +16,9 @@ exports.map = function(operationSubFunction,options) {
 	return function(results,source,widget) {
 		if(results.length > 0) {
 			var inputTitles = results.toArray(),
-				index = 0;
+				index = 0,
+				suffixes = options.suffixes,
+				flatten = (suffixes[0] && suffixes[0][0] === "flat") ? true : false;
 			results.clear();
 			$tw.utils.each(inputTitles,function(title) {
 				var filtered = operationSubFunction(options.wiki.makeTiddlerIterator([title]),{
@@ -36,7 +38,13 @@ exports.map = function(operationSubFunction,options) {
 						}
 					}
 				});
-				results.push(filtered[0] || "");
+				if(filtered.length && flatten) {
+					$tw.utils.each(filtered,function(value) {
+						results.push(value);
+					})
+				} else {
+					results.push(filtered[0]||"");
+				}
 				++index;
 			});
 		}

package/core/modules/filters/insertafter.js

@@ -0,0 +1,46 @@
+/*\
+title: $:/core/modules/filters/insertafter.js
+type: application/javascript
+module-type: filteroperator
+
+Insert an item after another item in a list
+
+\*/
+(function(){
+
+/*jslint node: true, browser: true */
+/*global $tw: false */
+"use strict";
+
+/*
+Order a list
+*/
+exports.insertafter = function(source,operator,options) {
+	var results = [];
+	source(function(tiddler,title) {
+		results.push(title);
+	});
+	var target = operator.operands[1] || (options.widget && options.widget.getVariable(operator.suffix || "currentTiddler"));
+	if(target !== operator.operand) {
+		// Remove the entry from the list if it is present
+		var pos = results.indexOf(operator.operand);
+		if(pos !== -1) {
+			results.splice(pos,1);
+		}
+		// Insert the entry after the target marker
+		pos = results.indexOf(target);
+		if(pos !== -1) {
+			results.splice(pos+1,0,operator.operand);
+		} else {
+			var suffix = operator.operands.length > 1 ? operator.suffix : "";
+			if(suffix === "start") {
+				results.splice(0,0,operator.operand);
+			} else {
+				results.push(operator.operand);
+			}
+		}
+	}
+	return results;
+};
+
+})();

package/core/modules/filters/insertbefore.js

@@ -32,7 +32,12 @@ exports.insertbefore = function(source,operator,options) {
 		if(pos !== -1) {
 			results.splice(pos,0,operator.operand);
 		} else {
-			results.push(operator.operand);
+			var suffix = operator.operands.length > 1 ? operator.suffix : "";
+			if(suffix == "start") {
+				results.splice(0,0,operator.operand);
+			} else {
+				results.push(operator.operand);
+			}
 		}
 	}
 	return results;

package/core/modules/filters.js

@@ -220,10 +220,18 @@ source: an iterator function for the source tiddlers, called source(iterator), w
 widget: an optional widget node for retrieving the current tiddler etc.
 */
 exports.compileFilter = function(filterString) {
+	if(!this.filterCache) {
+		this.filterCache = Object.create(null);
+		this.filterCacheCount = 0;
+	}
+	if(this.filterCache[filterString] !== undefined) {
+		return this.filterCache[filterString];
+	}
 	var filterParseTree;
 	try {
 		filterParseTree = this.parseFilter(filterString);
 	} catch(e) {
+		// We do not cache this result, so it adjusts along with localization changes
 		return function(source,widget) {
 			return [$tw.language.getString("Error/Filter") + ": " + e];
 		};
@@ -320,7 +328,7 @@ exports.compileFilter = function(filterString) {
 		})());
 	});
 	// Return a function that applies the operations to a source iterator of tiddler titles
-	return $tw.perf.measure("filter: " + filterString,function filterFunction(source,widget) {
+	var compiled = $tw.perf.measure("filter: " + filterString,function filterFunction(source,widget) {
 		if(!source) {
 			source = self.each;
 		} else if(typeof source === "object") { // Array or hashmap
@@ -335,6 +343,16 @@ exports.compileFilter = function(filterString) {
 		});
 		return results.toArray();
 	});
+	if(this.filterCacheCount >= 2000) {
+		// To prevent memory leak, we maintain an upper limit for cache size.
+		// Reset if exceeded. This should give us 95% of the benefit
+		// that no cache limit would give us.
+		this.filterCache = Object.create(null);
+		this.filterCacheCount = 0;
+	}
+	this.filterCache[filterString] = compiled;
+	this.filterCacheCount++;
+	return compiled;
 };
 
 })();

package/core/modules/savers/put.js

@@ -80,6 +80,7 @@ PutSaver.prototype.save = function(text,method,callback) {
 	if(this.etag) {
 		headers["If-Match"] = this.etag;
 	}
+	$tw.notifier.display("$:/language/Notifications/Save/Starting");
 	$tw.utils.httpRequest({
 		url: this.uri(),
 		type: "PUT",
@@ -87,17 +88,20 @@ PutSaver.prototype.save = function(text,method,callback) {
 		data: text,
 		callback: function(err,data,xhr) {
 			if(err) {
-				// response is textual: "XMLHttpRequest error code: 412"
-				var status = Number(err.substring(err.indexOf(':') + 2, err.length))
+				var status = xhr.status,
+					errorMsg = err;
 				if(status === 412) { // file changed on server
-					callback($tw.language.getString("Error/PutEditConflict"));
+					errorMsg = $tw.language.getString("Error/PutEditConflict");
 				} else if(status === 401) { // authentication required
-					callback($tw.language.getString("Error/PutUnauthorized"));
+					errorMsg = $tw.language.getString("Error/PutUnauthorized");
 				} else if(status === 403) { // permission denied
-					callback($tw.language.getString("Error/PutForbidden"));
-				} else {
-					callback(err); // fail
+					errorMsg = $tw.language.getString("Error/PutForbidden");
 				}
+				if (xhr.responseText) {
+					// treat any server response like a plain text error explanation
+					errorMsg = errorMsg + "\n\n" + xhr.responseText;
+				}
+				callback(errorMsg); // fail
 			} else {
 				self.etag = xhr.getResponseHeader("ETag");
 				if(self.etag == null) {

package/core/modules/savers/upload.js

@@ -64,6 +64,7 @@ UploadSaver.prototype.save = function(text,method,callback) {
 	var tail = "\r\n--" + boundary + "--\r\n",
 		data = head.join("\r\n") + text + tail;
 	// Do the HTTP post
+	$tw.notifier.display("$:/language/Notifications/Save/Starting");
 	var http = new XMLHttpRequest();
 	http.open("POST",url,true,username,password);
 	http.setRequestHeader("Content-Type","multipart/form-data; charset=UTF-8; boundary=" + boundary);
@@ -81,7 +82,6 @@ UploadSaver.prototype.save = function(text,method,callback) {
 	} catch(ex) {
 		return callback($tw.language.getString("Error/Caption") + ":" + ex);
 	}
-	$tw.notifier.display("$:/language/Notifications/Save/Starting");
 	return true;
 };
 

package/core/modules/server/server.js

@@ -359,8 +359,9 @@ Server.prototype.listen = function(port,host,prefix) {
 	}
 	// Display the port number after we've started listening (the port number might have been specified as zero, in which case we will get an assigned port)
 	server.on("listening",function() {
-		var address = server.address();
-		$tw.utils.log("Serving on " + self.protocol + "://" + address.address + ":" + address.port + prefix,"brown/orange");
+		var address = server.address(),
+			url = self.protocol + "://" + (address.family === "IPv6" ? "[" + address.address + "]" : address.address) + ":" + address.port + prefix;
+		$tw.utils.log("Serving on " + url,"brown/orange");
 		$tw.utils.log("(press ctrl-C to exit)","red");
 	});
 	// Listen

package/core/modules/startup/browser-messaging.js

@@ -62,12 +62,14 @@ function loadIFrame(url,callback) {
 Unload library iframe for given url
 */
 function unloadIFrame(url){
-	$tw.utils.each(document.getElementsByTagName('iframe'), function(iframe) {
+	var iframes = document.getElementsByTagName('iframe');
+	for(var t=iframes.length-1; t--; t>=0) {
+		var iframe = iframes[t];
 		if(iframe.getAttribute("library") === "true" &&
 		  iframe.getAttribute("src") === url) {
 			iframe.parentNode.removeChild(iframe);
 		}
-	});
+	}
 }
 
 function saveIFrameInfoTiddler(iframeInfo) {