tiddlywiki 5.1.23 → 5.2.2

package/plugins/tiddlywiki/katex/files/tiddlywiki.files

@@ -32,7 +32,9 @@
 				"type": "application/javascript",
 				"title": "$:/plugins/tiddlywiki/katex/mhchem.min.js",
 				"module-type": "library"
-			}
+			},
+			"prefix": "(function(realRequire) {var require = function(m) {if(m===\"katex\"){m = \"$:/plugins/tiddlywiki/katex/katex.min.js\"};return realRequire(m);};",
+			"suffix": "})(require);\n"
 		}
 	]
 }

package/plugins/tiddlywiki/katex/plugin.info

@@ -2,6 +2,6 @@
 	"title": "$:/plugins/tiddlywiki/katex",
 	"name": "KaTeX",
 	"description": "KaTeX library for mathematical typography",
-	"list": "readme usage",
-	"library-version": "v0.10.2"
+	"list": "readme usage config",
+	"library-version": "v0.13.18"
 }

package/plugins/tiddlywiki/katex/readme.tid

@@ -1,6 +1,6 @@
 title: $:/plugins/tiddlywiki/katex/readme
 
-This is a TiddlyWiki plugin for mathematical and chemical typesetting based on [ext[KaTeX from Khan Academy|http://khan.github.io/KaTeX/]] (v0.10.2) and [ext[mhchem|https://github.com/mhchem/MathJax-mhchem]] through a [ext[Katex extension|https://github.com/KaTeX/KaTeX/tree/master/contrib/mhchem]].
+This is a TiddlyWiki plugin for mathematical and chemical typesetting based on [ext[KaTeX from Khan Academy|http://khan.github.io/KaTeX/]] (v0.13.18) and [ext[mhchem|https://github.com/mhchem/MathJax-mhchem]] through a [ext[Katex extension|https://github.com/KaTeX/KaTeX/tree/master/contrib/mhchem]].
 
 It is completely self-contained, and doesn't need an Internet connection in order to work. It works both in the browser and under Node.js.
 

package/plugins/tiddlywiki/katex/styles.tid

@@ -13,10 +13,16 @@ tags: [[$:/tags/Stylesheet]]
     text-rendering: auto;
 }
 
+/* Reset Automatic Numbering on a per tiddler basis */
+
+.tc-tiddler-frame {
+	counter-reset: katexEqnNo;
+}
+
 /* Avoid TW5's max-width: 100% */
 
 .katex svg {
-  max-width: initial;
+	max-width: initial;
 }
 
 /* Override font URLs */

package/plugins/tiddlywiki/katex/ui/config/macro.tid

@@ -0,0 +1,137 @@
+title: $:/plugins/tiddlywiki/katex/ui/config/macro
+tags: $:/tags/KaTeX/Config
+caption: Custom macro editor
+
+\define katex-escape(text)
+<$vars t=$text$>
+<$latex text={{{[<t>search-replace:g:regexp[(?<!\\)#(\d)],[{\#_$1}]]}}}>
+</$vars>
+\end
+
+\define katex-create-macro()
+<$vars loc={{$:/temp/katex/new-macro-name}}>
+<$action-createtiddler $basetitle={{{[<loc>addprefix[$:/plugins/tiddlywiki/katex/macros/]]}}} tags="$:/tags/KaTeX/Macro" type="text/plain" caption={{$:/temp/katex/new-macro-name}} text={{$:/temp/katex/new-macro-command}} $overwrite=yes/>
+</$vars>
+\end
+
+\define katex-edit-cell()
+<$reveal state="$:/temp/katex/edit-macro" type=match text={{!!title}}>
+<$edit-text tiddler=<<currentTiddler>> tag="input" default=""/>
+</$reveal>
+\end
+
+\define katex-view-cell()
+<$reveal state="$:/temp/katex/edit-macro" type=nomatch text={{!!title}}>
+<tt><$view field=text/></tt>
+</$reveal>
+\end
+
+\define katex-edit-macro-button()
+<$reveal state="$:/temp/katex/edit-macro" type=nomatch text={{!!title}}>
+<$button class="tc-btn-invisible tc-btn-dropdown">
+<$action-setfield $tiddler="$:/temp/katex/edit-macro" text={{!!title}}/>
+{{$:/core/images/edit-button}}
+</$button>
+</$reveal>
+\end
+
+\define katex-save-macro-button()
+<$reveal state="$:/temp/katex/edit-macro" type=match text={{!!title}}>
+<$button class="tc-btn-invisible tc-btn-dropdown">
+<$action-deletetiddler $tiddler="$:/temp/katex/edit-macro"/>
+{{$:/core/images/done-button}}
+</$button>
+</$reveal>
+\end
+
+<table>
+<tr>
+<th>Macro</th>
+<th>Command</th>
+<th>Preview</th>
+<th></th>
+</tr>
+
+<$list filter="[all[shadows+tiddlers]tag[$:/tags/KaTeX/Macro]!has[draft.of]sort[caption]]">
+<tr>
+<td><tt><$text text={{!!caption}}/></tt></td>
+<td><<katex-edit-cell>><<katex-view-cell>></td>
+<td><<katex-escape {{!!text}}>></td>
+<td>
+<<katex-edit-macro-button>>
+<<katex-save-macro-button>>
+<$button class="tc-btn-invisible tc-btn-dropdown">
+<$action-deletetiddler $tiddler={{!!title}}/>
+{{$:/core/images/delete-button}}
+</$button>
+</td>
+</tr>
+</$list>
+
+<tr>
+<td colspan="4" align="left">Add a new macro</td>
+</tr>
+<tr>
+<td><$edit-text tiddler="$:/temp/katex/new-macro-name" tag="input" default=""/></td>
+<td><$edit-text tiddler="$:/temp/katex/new-macro-command" tag="input" default=""/></td>
+<td><<katex-escape {{$:/temp/katex/new-macro-command}}>></td>
+<td><$button actions=<<katex-create-macro>>>
+{{$:/language/EditTemplate/Fields/Add/Button}}
+</$button></td>
+</tr>
+
+<tr><td colspan="4" align="left">
+<details>
+<summary>Import</summary>
+<$edit-text tiddler="$:/temp/katex/import-macro" tag="textarea" default="" class="tc-edit-texteditor" placeholder="You can type commands like \def\ZZ{\mathbb{Z}} and import them automatically."/>
+
+<$vars macros={{$:/temp/katex/import-macro}} sep="%.*\n|\n+" re="^\\g?def([^{]*){(.*)}.*">
+
+<$button>
+<$list filter="[<macros>splitregexp<sep>regexp<re>]" variable=line>
+<$vars m={{{[<line>search-replace:g:regexp<re>,[$1]]}}} c={{{[<line>search-replace:g:regexp<re>,[$2]]}}}>
+<$action-createtiddler $basetitle={{{[<m>addprefix[$:/plugins/tiddlywiki/katex/macros/]]}}} tags="$:/tags/KaTeX/Macro" type="text/plain" caption=<<m>> text=<<c>> $overwrite=yes/>
+</$vars>
+</$list>
+Import
+</$button>
+<$button>
+<$action-setfield $tiddler="$:/temp/katex/import-macro" text=""/>
+Clear
+</$button>
+
+''Preview''
+<table>
+<$list filter="[<macros>splitregexp<sep>regexp<re>]" variable=line>
+<$vars m={{{[<line>search-replace:g:regexp<re>,[$1]]}}} c={{{[<line>search-replace:g:regexp<re>,[$2]]}}}>
+<tr>
+<td><tt><<m>></tt></td>
+<td><tt><<c>></tt></td>
+<td><$macrocall $name=katex-escape text="<<c>>"/></td></tr>
+</$vars>
+</$list>
+</table>
+
+</$vars>
+</details>
+</td>
+</tr>
+
+<tr><td colspan="4" align="left">
+<details>
+<summary>Usage</summary>
+<ul>
+<li>
+You can add entries like `\ZZ`, `\mathbb{Z}`, which will render as <$latex text="\mathbb{Z}"/>.
+</li>
+<li>
+An entry mapping `\dd#1#2` to `\frac{d#1}{d#2}` will create a macro with two arguments; `\dd{f}{x}` will then render as <$latex text="\frac{df}{dx}"/>.
+</li>
+<li>
+Note that the macros defined here have higher priority than those defined using `\gdef`. Also, deleted macros will continue to exist until a full refresh.
+</li>
+</ul>
+</details>
+</td>
+</tr>
+</table>

package/plugins/tiddlywiki/katex/wrapper.js

@@ -15,18 +15,23 @@ Wrapper for `katex.min.js` that provides a `<$latex>` widget. It is also availab
 var katex = require("$:/plugins/tiddlywiki/katex/katex.min.js"),
     chemParse = require("$:/plugins/tiddlywiki/katex/mhchem.min.js"),
 	Widget = require("$:/core/modules/widgets/widget.js").widget;
-// Add \ce, \pu, and \tripledash to the KaTeX macros.
-katex.__defineMacro("\\ce", function(context) {
-  return chemParse(context.consumeArgs(1)[0], "ce")
-});
-katex.__defineMacro("\\pu", function(context) {
-  return chemParse(context.consumeArgs(1)[0], "pu");
-});
-//  Needed for \bond for the ~ forms
-//  Raise by 2.56mu, not 2mu. We're raising a hyphen-minus, U+002D, not 
-//  a mathematical minus, U+2212. So we need that extra 0.56.
-katex.__defineMacro("\\tripledash", "{\\vphantom{-}\\raisebox{2.56mu}{$\\mkern2mu"
-+ "\\tiny\\text{-}\\mkern1mu\\text{-}\\mkern1mu\\text{-}\\mkern2mu$}}");
+
+katex.macros = {};
+katex.updateMacros = function() {
+	var tiddlers = $tw.wiki.getTiddlersWithTag("$:/tags/KaTeX/Macro"),
+		regex = /#\d/g, // Remove the arguments like #1#2
+		tid, macro, cmd;
+	for (var i=0; i < tiddlers.length; i++) {
+		tid = $tw.wiki.getTiddler(tiddlers[i]);
+		try {
+			macro = tid.fields["caption"];
+			macro = macro.replace(regex, "");
+			cmd = tid.fields["text"];
+			katex.macros[macro] = cmd;
+		} catch(ex) {// Catch the bad ones
+		};
+	};
+};
 
 var KaTeXWidget = function(parseTreeNode,options) {
 	this.initialise(parseTreeNode,options);
@@ -48,9 +53,10 @@ KaTeXWidget.prototype.render = function(parent,nextSibling) {
 	// Get the source text
 	var text = this.getAttribute("text",this.parseTreeNode.text || "");
 	var displayMode = this.getAttribute("displayMode",this.parseTreeNode.displayMode || "false") === "true";
+	katex.updateMacros();
 	// Render it into a span
 	var span = this.document.createElement("span"),
-		options = {throwOnError: false, displayMode: displayMode};
+		options = {throwOnError: false, displayMode: displayMode, macros: katex.macros};
 	try {
 		if(!this.document.isTiddlyWikiFakeDom) {
 			katex.render(text,span,options);

package/plugins/tiddlywiki/markdown/config_renderWikiTextPragma.tid

@@ -1,3 +1,3 @@
 title: $:/config/markdown/renderWikiTextPragma
 
-\rules only html image macrocallinline syslink transcludeinline wikilink filteredtranscludeblock macrocallblock transcludeblock
+\rules only html image macrocallinline syslink transcludeinline wikilink filteredtranscludeblock macrocallblock transcludeblock latex-parser

package/plugins/tiddlywiki/markdown/files/remarkable-katex-license.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Brad Howes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/plugins/tiddlywiki/markdown/files/remarkable-katex.js

@@ -0,0 +1,137 @@
+"use strict";
+
+/**
+ * Plugin for Remarkable Markdown processor which transforms $..$ and $$..$$ sequences into math HTML using the
+ * Katex package.
+ */
+const rkatex = (md, options) => {
+  const backslash = '\\';
+  const dollar = '$';
+  const opts = options || {};
+  const delimiter = opts.delimiter || dollar;
+  if (delimiter.length !== 1) { throw new Error('invalid delimiter'); }
+
+  const katex = require("katex");
+
+  /**
+   * Render the contents as KaTeX
+   */
+  const renderKatex = (source, displayMode) => katex.renderToString(source,
+                                                                    {displayMode: displayMode,
+                                                                     throwOnError: false});
+
+  /**
+   * Parse '$$' as a block. Based off of similar method in remarkable.
+   */
+  const parseBlockKatex = (state, startLine, endLine) => {
+    let haveEndMarker = false;
+    let pos = state.bMarks[startLine] + state.tShift[startLine];
+    let max = state.eMarks[startLine];
+
+    if (pos + 1 > max) { return false; }
+
+    const marker = state.src.charAt(pos);
+    if (marker !== delimiter) { return false; }
+
+    // scan marker length
+    let mem = pos;
+    pos = state.skipChars(pos, marker);
+    let len = pos - mem;
+
+    if (len !== 2) { return false; }
+
+    // search end of block
+    let nextLine = startLine;
+
+    for (;;) {
+      ++nextLine;
+      if (nextLine >= endLine) { break; }
+
+      pos = mem = state.bMarks[nextLine] + state.tShift[nextLine];
+      max = state.eMarks[nextLine];
+
+      if (pos < max && state.tShift[nextLine] < state.blkIndent) { break; }
+      if (state.src.charAt(pos) !== delimiter) { continue; }
+      if (state.tShift[nextLine] - state.blkIndent >= 4) { continue; }
+
+      pos = state.skipChars(pos, marker);
+      if (pos - mem < len) { continue; }
+
+      pos = state.skipSpaces(pos);
+      if (pos < max) { continue; }
+
+      haveEndMarker = true;
+      break;
+    }
+
+    // If a fence has heading spaces, they should be removed from its inner block
+    len = state.tShift[startLine];
+    state.line = nextLine + (haveEndMarker ? 1 : 0);
+    const content = state.getLines(startLine + 1, nextLine, len, true)
+            .replace(/[ \n]+/g, ' ')
+            .trim();
+
+    state.tokens.push({type: 'katex', params: null, content: content, lines: [startLine, state.line],
+                       level: state.level, block: true});
+    return true;
+  };
+
+  /**
+   * Look for '$' or '$$' spans in Markdown text. Based off of the 'fenced' parser in remarkable.
+   */
+  const parseInlineKatex = (state, silent) => {
+    const start = state.pos;
+    const max = state.posMax;
+    let pos = start;
+
+    // Unexpected starting character
+    if (state.src.charAt(pos) !== delimiter) { return false; }
+
+    ++pos;
+    while (pos < max && state.src.charAt(pos) === delimiter) { ++pos; }
+
+    // Capture the length of the starting delimiter -- closing one must match in size
+    const marker = state.src.slice(start, pos);
+    if (marker.length > 2) { return false; }
+
+    const spanStart = pos;
+    let escapedDepth = 0;
+    while (pos < max) {
+      const char = state.src.charAt(pos);
+      if (char === '{' && (pos == 0 || state.src.charAt(pos - 1) != backslash)) {
+        escapedDepth += 1;
+      } else if (char === '}' && (pos == 0 || state.src.charAt(pos - 1) != backslash)) {
+        escapedDepth -= 1;
+        if (escapedDepth < 0) { return false; }
+      } else if (char === delimiter && escapedDepth === 0) {
+        const matchStart = pos;
+        let matchEnd = pos + 1;
+        while (matchEnd < max && state.src.charAt(matchEnd) === delimiter) { ++matchEnd; }
+
+        if (matchEnd - matchStart === marker.length) {
+          if (!silent) {
+            const content = state.src.slice(spanStart, matchStart)
+                .replace(/[ \n]+/g, ' ')
+                .trim();
+            state.push({type: 'katex', content: content, block: marker.length > 1, level: state.level});
+          }
+          state.pos = matchEnd;
+          return true;
+        }
+      }
+      pos += 1;
+    }
+
+    if (!silent) { state.pending += marker; }
+    state.pos += marker.length;
+
+    return true;
+  };
+
+  md.inline.ruler.push('katex', parseInlineKatex, options);
+  md.block.ruler.push('katex', parseBlockKatex, options);
+  md.renderer.rules.katex = (tokens, idx) => renderKatex(tokens[idx].content, tokens[idx].block);
+  md.renderer.rules.katex.delimiter = delimiter;
+};
+
+module.exports = rkatex;

package/plugins/tiddlywiki/markdown/files/remarkable-katex.min.js

@@ -0,0 +1,20 @@
+"use strict";const rkatex=(md,options)=>{const backslash='\\';const dollar='$';const opts=options||{};const delimiter=opts.delimiter||dollar;if(delimiter.length!==1){throw new Error('invalid delimiter');}
+const katex=require("katex");const renderKatex=(source,displayMode)=>katex.renderToString(source,{displayMode:displayMode,throwOnError:false});const parseBlockKatex=(state,startLine,endLine)=>{let haveEndMarker=false;let pos=state.bMarks[startLine]+state.tShift[startLine];let max=state.eMarks[startLine];if(pos+1>max){return false;}
+const marker=state.src.charAt(pos);if(marker!==delimiter){return false;}
+let mem=pos;pos=state.skipChars(pos,marker);let len=pos-mem;if(len!==2){return false;}
+let nextLine=startLine;for(;;){++nextLine;if(nextLine>=endLine){break;}
+pos=mem=state.bMarks[nextLine]+state.tShift[nextLine];max=state.eMarks[nextLine];if(pos<max&&state.tShift[nextLine]<state.blkIndent){break;}
+if(state.src.charAt(pos)!==delimiter){continue;}
+if(state.tShift[nextLine]-state.blkIndent>=4){continue;}
+pos=state.skipChars(pos,marker);if(pos-mem<len){continue;}
+pos=state.skipSpaces(pos);if(pos<max){continue;}
+haveEndMarker=true;break;}
+len=state.tShift[startLine];state.line=nextLine+(haveEndMarker?1:0);const content=state.getLines(startLine+1,nextLine,len,true).replace(/[ \n]+/g,' ').trim();state.tokens.push({type:'katex',params:null,content:content,lines:[startLine,state.line],level:state.level,block:true});return true;};const parseInlineKatex=(state,silent)=>{const start=state.pos;const max=state.posMax;let pos=start;if(state.src.charAt(pos)!==delimiter){return false;}
+++pos;while(pos<max&&state.src.charAt(pos)===delimiter){++pos;}
+const marker=state.src.slice(start,pos);if(marker.length>2){return false;}
+const spanStart=pos;let escapedDepth=0;while(pos<max){const char=state.src.charAt(pos);if(char==='{'&&(pos==0||state.src.charAt(pos-1)!=backslash)){escapedDepth+=1;}else if(char==='}'&&(pos==0||state.src.charAt(pos-1)!=backslash)){escapedDepth-=1;if(escapedDepth<0){return false;}}else if(char===delimiter&&escapedDepth===0){const matchStart=pos;let matchEnd=pos+1;while(matchEnd<max&&state.src.charAt(matchEnd)===delimiter){++matchEnd;}
+if(matchEnd-matchStart===marker.length){if(!silent){const content=state.src.slice(spanStart,matchStart).replace(/[ \n]+/g,' ').trim();state.push({type:'katex',content:content,block:marker.length>1,level:state.level});}
+state.pos=matchEnd;return true;}}
+pos+=1;}
+if(!silent){state.pending+=marker;}
+state.pos+=marker.length;return true;};md.inline.ruler.push('katex',parseInlineKatex,options);md.block.ruler.push('katex',parseBlockKatex,options);md.renderer.rules.katex=(tokens,idx)=>renderKatex(tokens[idx].content,tokens[idx].block);md.renderer.rules.katex.delimiter=delimiter;};module.exports=rkatex;

package/plugins/tiddlywiki/markdown/files/remarkable-license.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2016, Jon Schlinkert
+Copyright (c) 2014 Jon Schlinkert, Vitaly Puzrin.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/plugins/tiddlywiki/markdown/files/tiddlywiki.files

@@ -7,6 +7,30 @@
 				"title": "$:/plugins/tiddlywiki/markdown/remarkable.js",
 				"module-type": "library"
 			}
+		},
+		{
+			"file": "remarkable-license.txt",
+			"fields": {
+				"type": "text/plain",
+				"title": "$:/plugins/tiddlywiki/markdown/remarkable-license"
+			}
+		},
+		{
+			"file": "remarkable-katex.min.js",
+			"fields": {
+				"type": "application/javascript",
+				"title": "$:/plugins/tiddlywiki/markdown/remarkable-katex.js",
+				"module-type": "library"
+			},
+			"prefix": "(function(realRequire) {var require = function(m) {if(m===\"katex\"){m = \"$:/plugins/tiddlywiki/katex/katex.min.js\"};return realRequire(m);};",
+			"suffix": "})(require);\n"
+		},
+		{
+			"file": "remarkable-katex-license.txt",
+			"fields": {
+				"type": "text/plain",
+				"title": "$:/plugins/tiddlywiki/markdown/remarkable-katex-license"
+			}
 		}
 	]
 }

package/plugins/tiddlywiki/markdown/plugin.info

@@ -1,6 +1,6 @@
 {
 	"title": "$:/plugins/tiddlywiki/markdown",
 	"name": "Markdown",
-	"description": "Markdown parser based on remarkable by Jon Schlinkert",
-	"list": "readme usage"
+	"description": "Markdown parser based on remarkable by Jon Schlinkert and remarkable-katex by Brad Howes",
+	"list": "readme usage remarkable-license remarkable-katex-license"
 }

package/plugins/tiddlywiki/markdown/readme.tid

@@ -1,6 +1,6 @@
 title: $:/plugins/tiddlywiki/markdown/readme
 
-This is a TiddlyWiki plugin for parsing Markdown text, using the [[Remarkable|https://github.com/jonschlinkert/remarkable]] library.
+This is a TiddlyWiki plugin for parsing Markdown text, using the [[Remarkable|https://github.com/jonschlinkert/remarkable]] library. If the KaTeX TiddlyWiki plugin is installed, KaTeX support is enabled using the [[remarkable-katex|https://github.com/bradhowes/remarkable-katex]] Remarkable plugin.
 
 It is completely self-contained, and doesn't need an Internet connection in order to work. It works both in the browser and under Node.js.