temml 0.10.33 → 0.11.0

package/src/environments/array.js

@@ -3,6 +3,7 @@ import { parseCD } from "./cd";
 import defineFunction from "../defineFunction";
 import mathMLTree from "../mathMLTree";
 import { Span } from "../domTree"
+import { Token } from "../Token";
 import { StyleLevel } from "../constants"
 import ParseError from "../ParseError";
 import { assertNodeType, assertSymbolNodeType } from "../parseNode";
@@ -57,31 +58,28 @@ const arrayGaps = macros => {
   return [arraystretch, arraycolsep]
 }
 
-const getTag = (group, style, rowNum) => {
-  let tag
-  const tagContents = group.tags.shift()
-  if (tagContents) {
-    // The author has written a \tag or a \notag in this row.
-    if (tagContents.body) {
-      tag = mml.buildExpressionRow(tagContents.body, style, true)
-      tag.classes = ["tml-tag"]
-    } else {
-      // \notag. Return an empty span.
-      tag = new mathMLTree.MathNode("mtext", [], [])
-      return tag
+const checkCellForLabels = cell => {
+  // Check if the author wrote a \tag{} inside this cell.
+  let rowLabel = ""
+  for (let i = 0; i < cell.length; i++) {
+    if (cell[i].type === "label") {
+      if (rowLabel) { throw new ParseError(("Multiple \\labels in one row")) }
+      rowLabel = cell[i].string
     }
-  } else if (group.envClasses.includes("multline") &&
-    ((group.leqno && rowNum !== 0) || (!group.leqno && rowNum !== group.body.length - 1))) {
-    // A multiline that does not receive a tag. Return an empty cell.
-    tag = new mathMLTree.MathNode("mtext", [], [])
-    return tag
-  } else {
-    // AMS automatcally numbered equaton.
-    // Insert a class so the element can be populated by a CSS counter.
-    // WebKit will display the CSS counter only inside a span.
-    tag = new mathMLTree.MathNode("mtext", [new Span(["tml-eqn"])])
   }
-  return tag
+  return rowLabel
+}
+
+// autoTag (an argument to parseArray) can be one of three values:
+// * undefined: Regular (not-top-level) array; no tags on each row
+// * true: Automatic equation numbering, overridable by \tag
+// * false: Tags allowed on each row, but no automatic numbering
+// This function *doesn't* work with the "split" environment name.
+function getAutoTag(name) {
+  if (name.indexOf("ed") === -1) {
+    return name.indexOf("*") === -1;
+  }
+  // return undefined;
 }
 
 /**
@@ -95,7 +93,7 @@ function parseArray(
   {
     cols, // [{ type: string , align: l|c|r|null }]
     envClasses, // align(ed|at|edat) | array | cases | cd | small | multline
-    addEqnNum,      // boolean
+    autoTag,        // boolean
     singleRow,      // boolean
     emptySingleRow, // boolean
     maxNumCols,     // number
@@ -111,13 +109,6 @@ function parseArray(
     // TODO: provide helpful error when \cr is used outside array environment
     parser.gullet.macros.set("\\cr", "\\\\\\relax");
   }
-  if (addEqnNum) {
-    parser.gullet.macros.set("\\tag", "\\@ifstar\\envtag@literal\\envtag@paren")
-    parser.gullet.macros.set("\\envtag@paren", "\\env@tag{{(\\text{#1})}}");
-    parser.gullet.macros.set("\\envtag@literal", "\\env@tag{\\text{#1}}")
-    parser.gullet.macros.set("\\notag", "\\env@notag");
-    parser.gullet.macros.set("\\nonumber", "\\env@notag")
-  }
 
   // Start group for first cell
   parser.gullet.beginGroup();
@@ -125,29 +116,39 @@ function parseArray(
   let row = [];
   const body = [row];
   const rowGaps = [];
-  const tags = [];
-  let rowTag;
+  const labels = [];
+
   const hLinesBeforeRow = [];
 
+  const tags = (autoTag != null ? [] : undefined);
+
+  // amsmath uses \global\@eqnswtrue and \global\@eqnswfalse to represent
+  // whether this row should have an equation number.  Simulate this with
+  // a \@eqnsw macro set to 1 or 0.
+  function beginRow() {
+    if (autoTag) {
+      parser.gullet.macros.set("\\@eqnsw", "1", true);
+    }
+  }
+  function endRow() {
+    if (tags) {
+      if (parser.gullet.macros.get("\\df@tag")) {
+        tags.push(parser.subparse([new Token("\\df@tag")]));
+        parser.gullet.macros.set("\\df@tag", undefined, true);
+      } else {
+        tags.push(Boolean(autoTag) &&
+            parser.gullet.macros.get("\\@eqnsw") === "1");
+      }
+    }
+  }
+  beginRow();
+
   // Test for \hline at the top of the array.
   hLinesBeforeRow.push(getHLines(parser));
 
   while (true) {
     // Parse each cell in its own group (namespace)
     let cell = parser.parseExpression(false, singleRow ? "\\end" : "\\\\");
-
-    if (addEqnNum && !rowTag) {
-      // Check if the author wrote a \tag{} inside this cell.
-      for (let i = 0; i < cell.length; i++) {
-        if (cell[i].type === "envTag" || cell[i].type === "noTag") {
-          // Get the contents of the \text{} nested inside the \env@Tag{}
-          rowTag = cell[i].type === "envTag"
-            ? cell.splice(i, 1)[0].body.body[0]
-            : { body: null };
-          break
-        }
-      }
-    }
     parser.gullet.endGroup();
     parser.gullet.beginGroup();
 
@@ -176,6 +177,7 @@ function parseArray(
       }
       parser.consume();
     } else if (next === "\\end") {
+      endRow()
       // Arrays terminate newlines with `\crcr` which consumes a `\cr` if
       // the last line is empty.  However, AMS environments keep the
       // empty row if it's the only one.
@@ -183,6 +185,7 @@ function parseArray(
       if (row.length === 1 && cell.body.length === 0 && (body.length > 1 || !emptySingleRow)) {
         body.pop();
       }
+      labels.push(checkCellForLabels(cell.body))
       if (hLinesBeforeRow.length < body.length + 1) {
         hLinesBeforeRow.push([]);
       }
@@ -198,16 +201,17 @@ function parseArray(
       if (parser.gullet.future().text !== " ") {
         size = parser.parseSizeGroup(true);
       }
-      rowGaps.push(size ? size.value : null);
+      rowGaps.push(size ? size.value : null)
+      endRow()
 
-      tags.push(rowTag)
+      labels.push(checkCellForLabels(cell.body))
 
       // check for \hline(s) following the row separator
       hLinesBeforeRow.push(getHLines(parser));
 
       row = [];
-      rowTag = null;
       body.push(row);
+      beginRow();
     } else {
       throw new ParseError("Expected & or \\\\ or \\cr or \\end", parser.nextToken);
     }
@@ -218,8 +222,6 @@ function parseArray(
   // End array group defining \cr
   parser.gullet.endGroup();
 
-  tags.push(rowTag)
-
   return {
     type: "array",
     mode: parser.mode,
@@ -228,9 +230,10 @@ function parseArray(
     rowGaps,
     hLinesBeforeRow,
     envClasses,
-    addEqnNum,
+    autoTag,
     scriptLevel,
     tags,
+    labels,
     leqno,
     arraystretch,
     arraycolsep
@@ -287,19 +290,43 @@ const mathmlBuilder = function(group, style) {
       }
       row.push(mtd)
     }
-    if (group.addEqnNum) {
-      row.unshift(glue(group));
-      row.push(glue(group));
-      const tag = getTag(group, style.withLevel(cellLevel), i)
-      if (group.leqno) {
-        row[0].children.push(tag)
-        row[0].classes.push("tml-left")
-      } else {
-        row[row.length - 1].children.push(tag)
-        row[row.length - 1].classes.push("tml-right")
+    const numColumns = group.body[0].length
+    // Fill out a short row with empty <mtd> elements.
+    for (let k = 0; k < numColumns - rw.length; k++) {
+      row.push(new mathMLTree.MathNode("mtd", [], style))
+    }
+    if (group.autoTag) {
+      const tag = group.tags[i];
+      let tagElement
+      if (tag === true) {  // automatic numbering
+        tagElement = new mathMLTree.MathNode("mtext", [new Span(["tml-eqn"])])
+      } else if (tag === false) {
+        // \nonumber/\notag or starred environment
+        tagElement = new mathMLTree.MathNode("mtext", [], [])
+      } else {  // manual \tag
+        tagElement = mml.buildExpressionRow(tag[0].body, style.withLevel(cellLevel), true)
+        tagElement = mml.consolidateText(tagElement)
+        tagElement.classes = ["tml-tag"]
+      }
+      if (tagElement) {
+        row.unshift(glue(group))
+        row.push(glue(group))
+        if (group.leqno) {
+          row[0].children.push(tagElement)
+          row[0].classes.push("tml-left")
+        } else {
+          row[row.length - 1].children.push(tagElement)
+          row[row.length - 1].classes.push("tml-right")
+        }
       }
     }
     const mtr = new mathMLTree.MathNode("mtr", row, [])
+    const label = group.labels.shift()
+    if (label && group.tags && group.tags[i]) {
+      mtr.setAttribute("id", label)
+      if (Array.isArray(group.tags[i])) { mtr.classes.push("tml-tageqn") }
+    }
+
     // Write horizontal rules
     if (i === 0 && hlines[0].length > 0) {
       if (hlines[0].length === 2) {
@@ -323,16 +350,17 @@ const mathmlBuilder = function(group, style) {
   }
 
   if (group.envClasses.length > 0) {
-    let pad = group.envClasses.includes("jot")
-      ? "0.7" // 0.5ex + 0.09em top & bot padding
-      : group.envClasses.includes("small")
-      ? "0.35"
-      : "0.5" // 0.5ex default top & bot padding
     if (group.arraystretch && group.arraystretch !== 1) {
       // In LaTeX, \arraystretch is a factor applied to a 12pt strut height.
       // It defines a baseline to baseline distance.
       // Here, we do an approximation of that approach.
-      pad = String(1.4 * group.arraystretch - 0.8)
+      const pad = String(1.4 * group.arraystretch - 0.8) + "ex"
+      for (let i = 0; i < tbl.length; i++) {
+        for (let j = 0; j < tbl[i].children.length; j++) {
+          tbl[i].children[j].style.paddingTop = pad
+          tbl[i].children[j].style.paddingBottom = pad
+        }
+      }
     }
     let sidePadding = group.envClasses.includes("abut")
       ? "0"
@@ -346,7 +374,7 @@ const mathmlBuilder = function(group, style) {
     let sidePadUnit = "em"
     if (group.arraycolsep) {
       const arraySidePad = calculateSize(group.arraycolsep, style)
-      sidePadding = arraySidePad.number
+      sidePadding = arraySidePad.number.toFixed(4)
       sidePadUnit = arraySidePad.unit
     }
 
@@ -357,18 +385,18 @@ const mathmlBuilder = function(group, style) {
       if (j === numCols - 1 && hand === 1) { return "0" }
       if (group.envClasses[0] !== "align") { return sidePadding }
       if (hand === 1) { return "0" }
-      if (group.addEqnNum) {
+      if (group.autoTag) {
         return (j % 2) ? "1" : "0"
       } else {
         return (j % 2) ? "0" : "1"
       }
     }
 
-    // Padding
+    // Side padding
     for (let i = 0; i < tbl.length; i++) {
       for (let j = 0; j < tbl[i].children.length; j++) {
-        tbl[i].children[j].style.padding = `${pad}ex ${sidePad(j, 1)}${sidePadUnit}`
-          + ` ${pad}ex ${sidePad(j, 0)}${sidePadUnit}`
+        tbl[i].children[j].style.paddingLeft = `${sidePad(j, 0)}${sidePadUnit}`
+        tbl[i].children[j].style.paddingRight = `${sidePad(j, 1)}${sidePadUnit}`
       }
     }
 
@@ -382,13 +410,13 @@ const mathmlBuilder = function(group, style) {
           // TODO: Remove -webkit- when Chromium no longer needs it.
           row.children[j].classes = ["tml-" + (j % 2 ? "left" : "right")]
         }
-        if (group.addEqnNum) {
+        if (group.autoTag) {
           const k = group.leqno ? 0 : row.children.length - 1
           row.children[k].classes = ["tml-" + (group.leqno ? "left" : "right")]
         }
       }
       if (row.children.length > 1 && group.envClasses.includes("cases")) {
-        row.children[1].style.padding = row.children[1].style.padding.replace(/0em$/, "1em")
+        row.children[1].style.paddingLeft = "1em"
       }
 
       if (group.envClasses.includes("cases") || group.envClasses.includes("subarray")) {
@@ -408,9 +436,17 @@ const mathmlBuilder = function(group, style) {
   }
 
   let table = new mathMLTree.MathNode("mtable", tbl)
+  if (group.envClasses.length > 0) {
+    // Top & bottom padding
+    if (group.envClasses.includes("jot")) {
+      table.classes.push("tml-jot")
+    } else if (group.envClasses.includes("small")) {
+      table.classes.push("tml-small")
+    }
+  }
   if (group.scriptLevel === "display") { table.setAttribute("displaystyle", "true") }
 
-  if (group.addEqnNum || group.envClasses.includes("multline")) {
+  if (group.autoTag || group.envClasses.includes("multline")) {
     table.style.width = "100%"
   }
 
@@ -440,7 +476,7 @@ const mathmlBuilder = function(group, style) {
         row.children[0].style.borderLeft = sep
       }
     }
-    let iCol = group.addEqnNum ? 0 : -1
+    let iCol = group.autoTag ? 0 : -1
     for (let i = iStart; i < iEnd; i++) {
       if (cols[i].type === "align") {
         const colAlign = alignMap[cols[i].align];
@@ -482,7 +518,7 @@ const mathmlBuilder = function(group, style) {
       }
     }
   }
-  if (group.addEqnNum) {
+  if (group.autoTag) {
      // allow for glue cells on each side
     align = "left " + (align.length > 0 ? align : "center ") + "right "
   }
@@ -506,13 +542,14 @@ const alignedHandler = function(context, args) {
   if (context.envName.indexOf("ed") === -1) {
     validateAmsEnvironmentContext(context);
   }
+  const isSplit = context.envName === "split";
   const cols = [];
   const res = parseArray(
     context.parser,
     {
       cols,
-      addEqnNum: context.envName === "align" || context.envName === "alignat",
       emptySingleRow: true,
+      autoTag: isSplit ? undefined : getAutoTag(context.envName),
       envClasses: ["abut", "jot"], // set row spacing & provisional column spacing
       maxNumCols: context.envName === "split" ? 2 : undefined,
       leqno: context.parser.settings.leqno
@@ -836,7 +873,7 @@ defineEnvironment({
     const res = {
       cols: [],
       envClasses: ["abut", "jot"],
-      addEqnNum: context.envName === "gather",
+      autoTag: getAutoTag(context.envName),
       emptySingleRow: true,
       leqno: context.parser.settings.leqno
     };
@@ -854,7 +891,7 @@ defineEnvironment({
   handler(context) {
     validateAmsEnvironmentContext(context);
     const res = {
-      addEqnNum: context.envName === "equation",
+      autoTag: getAutoTag(context.envName),
       emptySingleRow: true,
       singleRow: true,
       maxNumCols: 1,
@@ -875,7 +912,7 @@ defineEnvironment({
   handler(context) {
     validateAmsEnvironmentContext(context);
     const res = {
-      addEqnNum: context.envName === "multline",
+      autoTag: context.envName === "multline",
       maxNumCols: 1,
       envClasses: ["jot", "multline"],
       leqno: context.parser.settings.leqno

package/src/environments/cd.js

@@ -190,6 +190,8 @@ export function parseCD(parser) {
     type: "array",
     mode: "math",
     body,
+    tags: null,
+    labels: new Array(body.length + 1).fill(""),
     envClasses: ["jot", "cd"],
     cols: [],
     hLinesBeforeRow: new Array(body.length + 1).fill([])

package/src/functions/label.js

@@ -22,7 +22,7 @@ defineFunction({
     // Return a no-width, no-ink element with an HTML id.
     const node = new mathMLTree.MathNode("mrow", [], ["tml-label"])
     if (group.string.length > 0) {
-      node.setAttribute("id", group.string)
+      node.setLabel(group.string)
     }
     return node
   }

package/src/linebreaking.js

@@ -58,7 +58,7 @@ export default function setLineBreaks(expression, wrapMode, isDisplayMode) {
     }
     block.push(node);
     if (node.type && node.type === "mo" && node.children.length === 1 &&
-        !Object.hasOwn(node.attributes, "movablelimits")) {
+        !Object.prototype.hasOwnProperty.call(node.attributes, "movablelimits")) {
       const ch = node.children[0].text
       if (openDelims.indexOf(ch) > -1) {
         level += 1

package/src/macros.js

@@ -463,8 +463,10 @@ defineMacro("\\tag@literal", (context) => {
   if (context.macros.get("\\df@tag")) {
     throw new ParseError("Multiple \\tag");
   }
-  return "\\def\\df@tag{\\text{#1}}";
+  return "\\gdef\\df@tag{\\text{#1}}";
 });
+defineMacro("\\notag", "\\nonumber");
+defineMacro("\\nonumber", "\\gdef\\@eqnsw{0}")
 
 // \renewcommand{\bmod}{\nonscript\mskip-\medmuskip\mkern5mu\mathbin
 //   {\operator@font mod}\penalty900

package/src/mathMLTree.js

@@ -25,6 +25,7 @@ export class MathNode {
     this.children = children || [];
     this.classes = classes || [];
     this.style = style || {};   // Used for <mstyle> elements
+    this.label = "";
   }
 
   /**
@@ -42,6 +43,10 @@ export class MathNode {
     return this.attributes[name];
   }
 
+  setLabel(value) {
+    this.label = value
+  }
+
   /**
    * Converts the math node into a MathML-namespaced DOM element.
    */

package/src/postProcess.js

@@ -5,7 +5,7 @@
  * https://mit-license.org/
  */
 
-export const version = "0.10.33";
+export const version = "0.11.00";
 
 export function postProcess(block) {
   const labelMap = {}
@@ -21,15 +21,15 @@ export function postProcess(block) {
     // No need to write a number into the text content of the element.
     // A CSS counter has done that even if this postProcess() function is not used.
 
-    // Find any \label that refers to an AMS eqn number.
+    // Find any \label that refers to an AMS automatic eqn number.
     while (true) {
+      if (parent.tagName === "mtable") { break }
       const labels = parent.getElementsByClassName("tml-label")
       if (labels.length > 0) {
-        parent.setAttribute("id", labels[0].id)
-        labelMap[labels[0].id] = String(i)
+        const id = parent.attributes.id.value
+        labelMap[id] = String(i)
         break
       } else {
-        if (parent.tagName === "mtable") { break }
         parent = parent.parentElement
       }
     }
@@ -42,7 +42,8 @@ export function postProcess(block) {
     if (labels.length > 0) {
       const tags = parent.getElementsByClassName("tml-tag")
       if (tags.length > 0) {
-        labelMap[labels[0].id] = tags[0].textContent
+        const id = parent.attributes.id.value
+        labelMap[id] = tags[0].textContent
       }
     }
   }

package/src/symbols.js

@@ -670,7 +670,7 @@ defineSymbol(math, mathord, "\u03db", "\\stigma", true);
 defineSymbol(math, mathord, "\u2aeb", "\\Bot");
 defineSymbol(math, bin, "\u2217", "\u2217", true);
 defineSymbol(math, bin, "+", "+");
-defineSymbol(math, bin, "*", "*");
+defineSymbol(math, bin, "\u2217", "*");
 defineSymbol(math, bin, "\u2044", "/", true);
 defineSymbol(math, bin, "\u2044", "\u2044");
 defineSymbol(math, bin, "\u2212", "-", true);

package/temml.js

@@ -19,6 +19,7 @@ import { Span, TextNode } from "./src/domTree";
 import { defineSymbol } from "./src/symbols";
 import defineMacro from "./src/defineMacro";
 import { postProcess, version } from "./src/postProcess";
+import { renderMathInElement } from "./src/auto-render"
 
 /**
  * @type {import('./temml').render}
@@ -144,6 +145,11 @@ export default {
    * for sending to the client.
    */
   renderToString,
+  /**
+   * Finds all the math delimiters in a given element of a running HTML document
+   * and converts the contents of each instance into a <math> element.
+   */
+  renderMathInElement,
   /**
    * Post-process an entire HTML block.
    * Writes AMS auto-numbers and implements \ref{}.

package/contrib/auto-render/README.md

@@ -1,89 +0,0 @@
-# Auto-render extension
-
-This is a client-side extension to automatically render all of the math inside of the
-text of a running HTML document. It searches all of the text nodes in a given element
-for the given delimiters, and renders the math in place.
-
-
-This extension isn't part of Temml proper, so the script needs to be included
-(via a `<script>` tag) in the page along with Temml itself.  For example:
-
-```html
-<head>
-   ...
-<link rel="stylesheet" href="./Temml-Local.css">
-<script src="./temml.min.js"></script>
-<script src="./auto-render.min.js"></script>
-  ...
-</head>
-<body>
-  ...
-<script>renderMathInElement(document.body);</script>
-</body>
-```
-
-The auto-render extension exposes a single function, `window.renderMathInElement`, with
-the following API:
-
-```js
-function renderMathInElement(elem, options)
-```
-
-`elem` is an HTML DOM element, typically `document.main`. The function will
-recursively search for text nodes inside this element and render the math in them.
-
-`options` is an optional object argument that can have the same keys as [the
-options](https://temml.org/docs/en/administration.html#options) passed to 
-`temml.render`. In addition, there are five auto-render-specific keys:
-
-- `delimiters`: This is a list of delimiters to look for math, processed in
-  the same order as the list. Each delimiter has three properties:
-
-    - `left`: A string which starts the math expression (i.e. the left delimiter).
-    - `right`: A string which ends the math expression (i.e. the right delimiter).
-    - `display`: A boolean of whether the math in the expression should be
-      rendered in display mode or not.
-
-  The default `delimiters` value is:
-
-  ```js
-  [
-    { left: "$$", right: "$$", display: true },
-    { left: "\\(", right: "\\)", display: false },
-    { left: "\\begin{equation}", right: "\\end{equation}", display: true },
-    { left: "\\begin{align}",    right: "\\end{align}", display: true },
-    { left: "\\begin{alignat}",  right: "\\end{alignat}", display: true },
-    { left: "\\begin{gather}",   right: "\\end{gather}", display: true },
-    { left: "\\begin{CD}",       right: "\\end{CD}", display: true },
-    { left: "\\begin{multline}", right: "\\end{multline}", display: true },
-    { left: "\\[", right: "\\]", display: true }
-  ]
-  ```
-
-  If you want to add support for inline math via `$…$`, be sure to list it
-  **after** `$$…$$`. Because rules are processed in order, putting a `$` rule first would
-  match `$$` and treat as an empty math expression. Here is an example that includes `$…$`: 
-
-  ```js
-  [
-    {left: "$$", right: "$$", display: true},
-    // Put $ after $$.
-    {left: "$", right: "$", display: false},
-    {left: "\\(", right: "\\)", display: false},
-    // Put \[ last to avoid conflict with possible future \\[1em] row separator.
-    {left: "\\[", right: "\\]", display: true}
-  ]
-  ```
-
-- `ignoredTags`: This is a list of DOM node types to ignore when recursing
-  through. The default value is
-  `["script", "noscript", "style", "textarea", "pre", "code", "option"]`.
-
-- `ignoredClasses`: This is a list of DOM node class names to ignore when
-  recursing through. By default, this value is not set.
-
-- `errorCallback`: A callback method returning a message and an error stack
-  in case of an critical error during rendering. The default uses `console.error`.
-
-- `preProcess`: A callback function, `(math: string) => string`, used to process
-  math expressions before rendering.