@amermathsoc/texml-to-html 17.1.0 → 18.0.0

package/CHANGELOG.md

@@ -1,6 +1,51 @@
 # Changelog
 
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
+
+## [18.0.0](https://github.com/AmerMathSoc/texml-to-html/compare/v18.0.0-0...v18.0.0) (2024-08-16)
+
+## [18.0.0-0](https://github.com/AmerMathSoc/texml-to-html/compare/v17.1.0...v18.0.0-0) (2024-08-13)
+
+
+### ⚠ BREAKING CHANGES
+
+* label.js no longer generates
+punctuation&space in label (with title) but adds space
+between label and title (if both present); also no longer adds
+space and possible punctuation after theorem title.
+* secheading no longer generates
+punctuation+space in label, but spaces after label&title.
+* caption.js no longer generates
+punctuation after label nor parentheses around subfigure
+labels.
+* toc-entry no longer generates
+punctuation after label.
+* xref-group now preserved in tex-math
+* cite-detail no longer unwrapped in tex-math
+* book-app-groups are no longer
+forcibly marked as parts and level.
+* all x elements are now preserved as
+ams-x, i.e. downstream will need to remove unwanted ones.
+
+* feat!(label.js): stop adding "generated text" ([4b9543d](https://github.com/AmerMathSoc/texml-to-html/commit/4b9543d0d04ffb1d0b79f3046b95fc180fa13d92)), closes [#454](https://github.com/AmerMathSoc/texml-to-html/issues/454)
+* feat!(secheading.js): stop adding "generated text" ([d98265e](https://github.com/AmerMathSoc/texml-to-html/commit/d98265e57560690a3f793c49493e74751d9202f9)), closes [#454](https://github.com/AmerMathSoc/texml-to-html/issues/454)
+* feat!(caption.js): stop adding "generated text" ([3d17ff1](https://github.com/AmerMathSoc/texml-to-html/commit/3d17ff1b52ba459d9facda1c01b6ad301b046992)), closes [#454](https://github.com/AmerMathSoc/texml-to-html/issues/454)
+* feat!(toc-entry.js): stop adding "generated text" ([1981ae3](https://github.com/AmerMathSoc/texml-to-html/commit/1981ae371bc1c7770903381c2c22966858b452dd)), closes [#454](https://github.com/AmerMathSoc/texml-to-html/issues/454)
+* feat!(xref-groupl.js): preserve in tex-math ([133d8a5](https://github.com/AmerMathSoc/texml-to-html/commit/133d8a529446fa47d75f3a02bab0ee42c26aba23)), closes [#456](https://github.com/AmerMathSoc/texml-to-html/issues/456)
+* feat!(cite-detail.js): preserve in tex-math ([0a570fe](https://github.com/AmerMathSoc/texml-to-html/commit/0a570feb05678164db0e7834c32977b2fa74182a)), closes [#455](https://github.com/AmerMathSoc/texml-to-html/issues/455)
+* feat!(sec.js): revise book-app-group output ([2f4e06a](https://github.com/AmerMathSoc/texml-to-html/commit/2f4e06a117a62a49489b413c6cc26436773b0a36)), closes [#436](https://github.com/AmerMathSoc/texml-to-html/issues/436)
+* feat!(x.js): preserve all x elements as ams-x ([5b77a86](https://github.com/AmerMathSoc/texml-to-html/commit/5b77a8642fe78bfd56fb5bfc753d67e9bbd3d719)), closes [#445](https://github.com/AmerMathSoc/texml-to-html/issues/445)
+
+
+### Features
+
+* **algorithm.js:** support missing line no. delimiter ([0ef3047](https://github.com/AmerMathSoc/texml-to-html/commit/0ef3047623af712c11bae148c372d623ee611b10)), closes [#453](https://github.com/AmerMathSoc/texml-to-html/issues/453)
+
+
+### Bug Fixes
+
+* **package.json:** replace standard-version ([5db8c62](https://github.com/AmerMathSoc/texml-to-html/commit/5db8c62ccbb441b4902b0bb30db8e568d1a486d2)), closes [#458](https://github.com/AmerMathSoc/texml-to-html/issues/458)
+* secheading, toc-entry should match label.js ([4e9d7ef](https://github.com/AmerMathSoc/texml-to-html/commit/4e9d7eff09e3c481dbb4c917f8e31ac23a6db03e)), closes [#454](https://github.com/AmerMathSoc/texml-to-html/issues/454)
 
 ## [17.1.0](https://github.com/AmerMathSoc/texml-to-html/compare/v17.0.1...v17.1.0) (2024-07-04)
 

package/README.md

@@ -117,6 +117,7 @@ Beyond HTML element and attributes, texml-to-html stores data in custom `data-*`
   - tags - container for (duplicated) equation tags
     - container is inside data-ams-doc="math block" elements
     - ams-html uses these to generate the math panel DTs for equations
+  - app-group [from book-app-group]
 - data-ams-doc-contrib
   - {@content-type} [expected: "authors", "editors", "translators", "contributors"]
   - {@contrib-type} [expected: "author", "editor", "translator", "contributor"]
@@ -187,7 +188,6 @@ The following [ARIA-DPUB](https://w3c.github.io/dpub-aria/) role attribute value
 - doc-abstract
 - doc-toc
 - doc-footnote
-- doc-appendix
 
 #### texml XML to `data-*` mappings
 

package/lib/elements/algorithm.js

@@ -35,7 +35,7 @@ export function algLine(htmlParentNode, xmlnode) {
     const spansLineNo = ['alg:require', 'alg:ensure'].includes(xmlnode.firstElementChild.tagName); // NOTE if texml generated a suitable attribute, we wouldn't need an allowlist
     const lineNo = this.createNode('alg-lineno');
     htmlParentNode.appendChild(lineNo);
-    if (!spansLineNo && xmlnode.getAttribute('lineno')) lineNo.innerHTML = `${xmlnode.getAttribute('lineno')}${xmlnode.closest('[linenodelimiter]').getAttribute('linenodelimiter')}`;
+    if (!spansLineNo && xmlnode.getAttribute('lineno')) lineNo.innerHTML = `${xmlnode.getAttribute('lineno')}${xmlnode.closest('[linenodelimiter]')?.getAttribute('linenodelimiter') || ''}`;
     const node = this.createNode('alg-line');
     if (spansLineNo) node.setAttribute('data-ams-alg-spanslineno');
     htmlParentNode.appendChild(node);

package/lib/elements/cite-detail.js

@@ -20,10 +20,6 @@
  * @param {Element} xmlnode 
  */
 export default function (htmlParentNode, xmlnode) {
-    if (xmlnode.closest('tex-math')) {
-        this.passThrough(htmlParentNode, xmlnode);
-        return;
-    }
     const citeGroup = this.createNode('cite-detail');
     htmlParentNode.appendChild(citeGroup);
     this.passThrough(citeGroup, xmlnode);

package/lib/elements/fig.js

@@ -28,5 +28,23 @@ export default function (htmlParentNode, xmlnode) {
   if (xmlnode.getAttribute('position')) figure.setAttribute('data-ams-position', xmlnode.getAttribute('position'));
   mapAttributes(figure, xmlnode);
   htmlParentNode.appendChild(figure);
+
+  const label = xmlnode.querySelector(':scope>label');
+  const caption = xmlnode.querySelector(':scope>caption');
+
+  if (label || caption) {
+    const figcaption = this.createNode('figcaption');
+    figure.appendChild(figcaption);
+    if (label) {
+      const strong = this.createNode('strong');//TODO: cf. & unify with label.js; NOTE: no space after label necessary (since downstream rewrites things); but space shouldn't be harmful if we unify with label.js.
+      figcaption.appendChild(strong);
+      this.passThrough(strong, label);
+      label.remove();//NOTE: prevent duplicate processing later on
+    }
+    if (caption) {
+      this.passThrough(figcaption, caption);
+    }
+  }
+  // process remaining children
   this.passThrough(figure, xmlnode);
 };

package/lib/elements/fn.js

@@ -31,12 +31,22 @@ const getElementToInsertAfter = maybeBadAncestor => (maybeBadAncestor.nextElemen
  */
 export default function (htmlParentNode, xmlnode) {
   if (xmlnode.closest('tex-math')) xmlnode.remove();
-  const div = this.createNode('div', '', { role: 'doc-footnote', 'aria-label': `Footnote ${xmlnode.querySelector('label').textContent}` });
+  const label = xmlnode.querySelector('label');
+  const div = this.createNode('div', '', { role: 'doc-footnote', 'aria-label': `Footnote ${label.textContent}` });
   // NOTE AmerMathSoc/texml-to-html#336 analyzed where fn occurs in publications; might need revisions
   // Essentially, we can assume fn occurs inside elements (that turn into) p, h1, and span (from formula markup)
   // Since a span ancestor can be inside p (e.g., from inline-formula) we check for the others first.
   const maybeBadAncestor = htmlParentNode.closest('p, h1') || htmlParentNode.closest('span');
   maybeBadAncestor ? getElementToInsertAfter(maybeBadAncestor).insertAdjacentElement('afterend', div) : htmlParentNode.appendChild(div);
   mapAttributes(div, xmlnode);
+  // label
+  const span = this.createNode('span', '<sup></sup>', {
+    'data-ams-doc': 'label'
+  });
+  div.appendChild(span);
+  const superscript = span.firstElementChild;
+  this.passThrough(superscript, label);
+  label.remove(); //NOTE: prevent duplicate processing later on
+
   this.passThrough(div, xmlnode);
 };

package/lib/elements/label.js

@@ -22,35 +22,6 @@ import getParentLevel from '../helpers/getParentLevel.js';
  * @param {Element} xmlnode 
  */
 export default function (htmlParentNode, xmlnode) {
-  const caption = this.caption;
-
-  // simple cases
-  // CASE fn
-  if (xmlnode.parentNode.tagName === 'fn') {
-    const span = this.createNode('span', '<sup></sup>', {
-      'data-ams-doc': 'label'
-    });
-    htmlParentNode.appendChild(span);
-    const superscript = span.firstElementChild;
-    this.passThrough(superscript, xmlnode);
-    return;
-  }
-  // CASE ref
-  if (xmlnode.parentNode.tagName === 'ref') {
-    // NOTE the DT created in ref.js serves as wrapper
-    this.passThrough(htmlParentNode, xmlnode);
-    return;
-  }
-  // CASE fig, fig-group, table-wrap, table-wrap-group via caption
-  if (
-    xmlnode.parentNode.tagName === 'table-wrap' ||
-    xmlnode.parentNode.tagName === 'table-wrap-group' ||
-    xmlnode.parentNode.tagName === 'fig' ||
-    xmlnode.parentNode.tagName === 'fig-group'
-  ) {
-    caption(htmlParentNode, xmlnode);
-    return;
-  }
   // CASE label followed by a title -- we skip (and pull in the label later on when processing title)
   if (xmlnode.nextElementSibling?.tagName === 'title') return;
   // CASE empty label
@@ -82,8 +53,7 @@ export default function (htmlParentNode, xmlnode) {
     const labelSpan = this.createNode('span', '', { 'data-ams-doc': 'label' });
     container.appendChild(labelSpan);
     this.passThrough(labelSpan, previousSibling);
-    const labelSeparatorString = isStatement ? ' ' : '. ';
-    labelSpan.insertAdjacentText('beforeend', labelSeparatorString);
+    labelSpan.insertAdjacentText('afterend', ' '); // NOTE: adding (in HTML meaningful) space after label & before title to avoid them from smashing together.
   }
 
   // CASE Book
@@ -96,8 +66,6 @@ export default function (htmlParentNode, xmlnode) {
   // add main node and recurse
   const actualSpan = this.createNode('span', '', { 'data-ams-doc':  xmlnode.tagName });
   container.appendChild(actualSpan);
+  // NOTE: no space after title/label if there's only one. Downstream might insert some (e.g., with inlined headings).
   this.passThrough(actualSpan, xmlnode);
-
-  // faking TeX's punctutation-at-end logic
-  if (isStatement) container.insertAdjacentText('beforeend', container.textContent.endsWith('.') ? ' ' : '. ');
 };

package/lib/elements/ref.js

@@ -23,6 +23,6 @@ export default function (htmlParentNode, xmlnode) {
   const dt = this.createNode('dt');
   dt.id = xmlnode.id;
   htmlParentNode.appendChild(dt);
-  this.recurseTheDom(dt, xmlnode.querySelector('label'));
+  this.passThrough(dt, xmlnode.querySelector('label'));
   this.recurseTheDom(htmlParentNode, xmlnode.querySelector('mixed-citation'));
 };

package/lib/elements/sec.js

@@ -78,10 +78,7 @@ export default function (htmlParentNode, xmlnode) {
 
   // book appendices
   if (tagName === 'book-app-group') {
-    // NOTE might become redundant if book-app-group gets specific-use=part
-    section.setAttribute('role', 'doc-part');
-    section.setAttribute('data-ams-doc', 'part');
-    section.setAttribute('data-ams-doc-level', '0');
+    section.setAttribute('data-ams-doc', 'app-group');
   }
   if (tagName === 'book-app') section.setAttribute('role', 'doc-appendix');
 

package/lib/elements/secheading.js

@@ -34,10 +34,8 @@ export default function (htmlParentNode, xmlnode) {
   const title = xmlnode.querySelector('title');
   if (label) {
     this.passThrough(span, label);
+    if (title) span.insertAdjacentText('beforeend', ' '); //TODO: cf. & unify with label.js 
   }
-  if (title && label) {
-    span.insertAdjacentText('beforeend', '. ');
-    // NOTE this does not match label/title punctuation where a title without label would get a period.
-  }
+  if (!title) return;
   this.passThrough(span, title);
 };

package/lib/elements/toc-entry.js

@@ -35,7 +35,7 @@ export default function (htmlParentNode, xmlnode) {
     const labelSpan = this.createNode('span', '', { 'data-ams-doc': 'label' });
     anchor.appendChild(labelSpan);
     this.passThrough(labelSpan, label);
-    anchor.insertAdjacentText('beforeend', '. ');
+    if (title) labelSpan.insertAdjacentText('afterend', ' '); //TODO: cf. & unify with label.js
   }
   if (altTitle) {
     const altTitleContent = altTitle.textContent;

package/lib/elements/x.js

@@ -20,8 +20,8 @@
  * @param {Element} xmlnode 
  */
 export default function (htmlParentNode, xmlnode) {
-  // ignore if not xref/x or isBook
-  if (!xmlnode.closest('xref') && xmlnode.closest('article'))
-    return;
-  this.passThrough(htmlParentNode, xmlnode);
+  // NOTE: downstream will (sometimes) strip (some) of these out later
+  const amsx =  this.createNode('ams-x');
+  htmlParentNode.appendChild(amsx);
+  this.passThrough(amsx, xmlnode);
 };

package/lib/elements/xref-group.js

@@ -22,10 +22,6 @@
 export default function (htmlParentNode, xmlnode) {
     const refType = xmlnode.getAttribute('ref-type');
     const refrange = xmlnode.getAttribute('middle');
-    if (xmlnode.parentNode.closest('tex-math')) {
-        // NOTE: no use case so far; cf. #428 for code example
-        return;
-    }
     const span = this.createNode('span', '', {
         'data-ams-doc': 'refgroup',
         'data-ams-ref': refType,

package/lib/transformer.js

@@ -56,7 +56,6 @@ import SecMeta from './elements/sec-meta.js';
 import Graphic from './elements/graphic.js';
 import Img from './elements/img.js';
 import Fig from './elements/fig.js';
-import Caption from './elements/caption.js';
 import Toc from './elements/toc.js';
 import TocEntry from './elements/toc-entry.js';
 import Formula from './elements/formula.js';
@@ -252,7 +251,6 @@ export class Transformer {
     graphic = Graphic.bind(this)
     img = Img.bind(this)
     fig = Fig.bind(this)
-    caption = Caption.bind(this)
     toc = Toc.bind(this)
     'toc-entry' = TocEntry.bind(this)
     'inline-formula' = Formula.bind(this)