@amermathsoc/texml-to-html 15.2.1 → 16.1.1

package/CHANGELOG.md

@@ -2,6 +2,38 @@
 
 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.
 
+### [16.1.1](https://github.com/AmerMathSoc/texml-to-html/compare/v16.1.0...v16.1.1) (2024-06-03)
+
+
+### Bug Fixes
+
+* **hacks.js:** treat custom elements like phrasing content ([ab7c158](https://github.com/AmerMathSoc/texml-to-html/commit/ab7c1583a635f095de6dc9c3315ceb4c3a50d63e)), closes [#447](https://github.com/AmerMathSoc/texml-to-html/issues/447)
+
+## [16.1.0](https://github.com/AmerMathSoc/texml-to-html/compare/v16.0.0...v16.1.0) (2024-06-03)
+
+
+### Features
+
+* **book-meta.json.js:** preserve LCCN if present ([4426d63](https://github.com/AmerMathSoc/texml-to-html/commit/4426d632aa0e804ac516b39aea62186aa2c32751)), closes [#440](https://github.com/AmerMathSoc/texml-to-html/issues/440)
+* support cite-group and cite-detail ([dc832cf](https://github.com/AmerMathSoc/texml-to-html/commit/dc832cf7a4b002a8c6dc3725df34b814a306239a)), closes [#443](https://github.com/AmerMathSoc/texml-to-html/issues/443)
+* **toc-entry.js:** support specific-use attribute ([b11a3c9](https://github.com/AmerMathSoc/texml-to-html/commit/b11a3c955bc1601b425612a0a9ede0213e163bdd)), closes [#444](https://github.com/AmerMathSoc/texml-to-html/issues/444)
+
+## [16.0.0](https://github.com/AmerMathSoc/texml-to-html/compare/v15.2.1...v16.0.0) (2024-04-29)
+
+
+### ⚠ BREAKING CHANGES
+
+* Nested `a` are now "flattened" to `span`.
+
+### Features
+
+* revise treatment of nested links ([cdc63a9](https://github.com/AmerMathSoc/texml-to-html/commit/cdc63a970cc14c87ae6faa115ae2484bb03fe339)), closes [#442](https://github.com/AmerMathSoc/texml-to-html/issues/442)
+
+
+### Bug Fixes
+
+* **xref.js:** warn on nested link not inside toc-entry ([a59b69e](https://github.com/AmerMathSoc/texml-to-html/commit/a59b69e205cc9296d65668e364040995144e564e)), closes [#442](https://github.com/AmerMathSoc/texml-to-html/issues/442)
+
 ### [15.2.1](https://github.com/AmerMathSoc/texml-to-html/compare/v15.2.0...v15.2.1) (2024-03-29)
 
 ## [15.2.0](https://github.com/AmerMathSoc/texml-to-html/compare/v15.1.1...v15.2.0) (2024-03-29)

package/README.md

@@ -46,6 +46,11 @@ Some elements in texml's XML output have the same name (and purpose) as in HTML.
 - tr
 - td
 
+The following custom tag names are preserved:
+
+- cite-group (wrapper around citations)
+- cite-detail (wrapper for optional argument of `\cite`)
+
 ### preseved attributes
 
 Some attributes in texml's XML output have the same name (and purpose) in HTML.
@@ -132,6 +137,7 @@ Beyond HTML element and attributes, texml-to-html stores data in custom `data-*`
   - {@ref-type} [expected: bibr, fn, disp-formula, sec, fig, table, algorithm, list, statement]
   - notrid
   - fn-return [added in ams-html output]
+  - `toc-entry@specific-use` [expected: section, chapter, etc.]
 - data-ams-doc-level
   - [0-9]
 - data-ams-content-type
@@ -149,6 +155,8 @@ Beyond HTML element and attributes, texml-to-html stores data in custom `data-*`
   - graphic | inline-graphic @height
 - data-ams-doc-alttitle
   - alt-title (book only, for sectioning content only)
+- data-ams-href
+  - stores href for span that avoids a nested link (cf. xref, ext-link)
 
 ##### downstream `data-*` attributes
 
@@ -238,6 +246,7 @@ The following provide a list from the reverse point of view.
 - notes => section with data-ams-doc="notes"
   - @notes-type => @data-ams-content-type (and role=dedication for dedications)
   - use cases: dedication (articles), article and section notes (NOTI only), drm notice & epub note (books)
+- toc-entry@specific-use => data-ams-ref
 - attributes
   - @disp-level => data-ams-doc-level [data-ams-doc-level is also added to some elements that lack disp-level]
   - @content-type => data-ams-content-type

package/lib/elements/book-meta-json.js

@@ -34,6 +34,9 @@ const bookMetaJson =
                 // google: '',
                 // print: '',
                 // softcover: '',
+            },
+            loc: {
+                // llcn
             }
         },
         title: '', // NOTE might contain math (but no use case yet)
@@ -87,6 +90,7 @@ export function generateBookJson(bookMetaNode) {
     bookMetaJson.book.identifiers.AMS.publKey = bookMetaNode.querySelector('book-id[assigning-authority="AMS"][book-id-type="publisher"]')?.textContent;
     bookMetaJson.book.identifiers.AMS.volumeId = bookMetaNode.querySelector('book-id[assigning-authority="AMS"][book-id-type="volume_id"]')?.textContent;
     bookMetaJson.book.identifiers.crossref.doi = bookMetaNode.querySelector('book-id[assigning-authority="crossref"][book-id-type="doi"]')?.textContent;
+    bookMetaJson.book.identifiers.loc.lccn = bookMetaNode.querySelector('book-id[assigning-authority="Library of Congress"][book-id-type="lccn"]')?.textContent;
 
     // Volume number
     bookMetaJson.book.identifiers.AMS.volumeNr = bookMetaNode.querySelector('book-volume-number')?.textContent;

package/lib/elements/ext-link.js

@@ -14,7 +14,6 @@
  *  limitations under the License.
  */
 
-import { unnestLinks } from '../helpers/unnest.js';
 import { node2macro } from '../helpers/helpers-tex.js';
 
 /**
@@ -27,12 +26,16 @@ export default function (htmlParentNode, xmlnode) {
     node2macro.apply(this, [htmlParentNode, xmlnode, `href{${xmlnode.getAttribute('xlink:href')}}`, true]); // NOTE href works in both math and text mode; `\href`'s first argument does not need escaping
     return;
   }
-  const anchor = this.createNode('a', '', {
-    href: xmlnode.getAttribute('xlink:href')
-  });
+  const isNestedLink = htmlParentNode.closest('a');
+  if (isNestedLink) console.log('Warning: texml-to-html: Nested ext-link', xmlnode.outerHTML);
+  const anchor = isNestedLink ?
+    this.createNode('span', '', {
+      'data-ams-href': xmlnode.getAttribute('xlink:href')
+    })
+    : this.createNode('a', '', {
+      href: xmlnode.getAttribute('xlink:href')
+    });
   htmlParentNode.appendChild(anchor);
-  // handle nested links
-  const linkChild = xmlnode.childNodes.find(node => node.tagName === 'xref' || node.tagName === 'ext-link');
-  if (linkChild) unnestLinks(this.recurseTheDom, this.createNode, xmlnode, anchor, linkChild)
-  else this.passThrough(anchor, xmlnode);
+
+  this.passThrough(anchor, xmlnode);
 };

package/lib/elements/toc-entry.js

@@ -24,6 +24,7 @@ export default function (htmlParentNode, xmlnode) {
   htmlParentNode.appendChild(li);
   const anchor = this.createNode('a', '', {
     href: `#${xmlnode.querySelector('nav-pointer').getAttribute('rid')}`,
+    "data-ams-ref": xmlnode.getAttribute('specific-use') // NOTE: specific-use contains `ref@ref-type`-like information (e.g., 'chapter', 'section')
   });
   li.appendChild(anchor);
   // NOTE unify label/title processing with label() - requires some form of new wrapper around content in lieu of heading (or have it add the anchor but then the nav-pointer will be odd to pull in). See #398

package/lib/elements/x.js

@@ -21,7 +21,7 @@
  */
 export default function (htmlParentNode, xmlnode) {
   // ignore if not xref/x or isBook
-  if ('xref' !== xmlnode.parentNode.tagName && xmlnode.closest('article'))
+  if (!xmlnode.closest('xref') && xmlnode.closest('article'))
     return;
   this.passThrough(htmlParentNode, xmlnode);
 };

package/lib/elements/xref.js

@@ -14,7 +14,6 @@
  *  limitations under the License.
  */
 
-import { unnestLinks } from '../helpers/unnest.js';
 import { replaceTeXCharactersInNodes } from '../helpers/helpers-tex.js';
 
 /**
@@ -23,10 +22,28 @@ import { replaceTeXCharactersInNodes } from '../helpers/helpers-tex.js';
  * @param {Element} xmlnode 
  */
 export default function (htmlParentNode, xmlnode) {
-  // case toc-entry//xref
-  const tocEntryAncestor = xmlnode.closest('toc-entry');
-  if (tocEntryAncestor) {
-    this.passThrough(htmlParentNode, xmlnode);
+  const rid = xmlnode.getAttribute('rid');
+
+  // case: no RID 
+  if (!rid) {
+    const span = this.createNode('span', '', {
+      'data-ams-ref': 'notrid'
+    });
+    htmlParentNode.appendChild(span);
+    this.passThrough(span, xmlnode);
+    return;
+  }
+
+  // case nested links
+  const isNestedLink = htmlParentNode.closest('a');
+  if (isNestedLink) {
+    const anchor =
+      this.createNode('span', '', {
+        'data-ams-href': rid,
+      })
+    htmlParentNode.appendChild(anchor);
+    this.passThrough(anchor, xmlnode);
+    if (!xmlnode.closest('toc-entry')) console.log('Warning: texml-to-html: Nested xref', xmlnode.outerHTML);
     return;
   }
   const refType = xmlnode.getAttribute('ref-type');
@@ -41,7 +58,6 @@ export default function (htmlParentNode, xmlnode) {
       [...texmathAncestor.querySelectorAll('*')].includes(foonoteAncestor)
     )
   ) {
-    const rid = xmlnode.getAttribute('rid');
     htmlParentNode.insertAdjacentText(
       'beforeend',
       `\\xhref[${refType}]{#${rid}}{`
@@ -53,15 +69,7 @@ export default function (htmlParentNode, xmlnode) {
     htmlParentNode.insertAdjacentText('beforeend', `}`);
     return;
   }
-  const rid = xmlnode.getAttribute('rid');
-  if (!rid) {
-    const span = this.createNode('span', '', {
-      'data-ams-ref': 'notrid'
-    });
-    htmlParentNode.appendChild(span);
-    this.passThrough(span, xmlnode);
-    return;
-  }
+  // the "regular" case: a cross-reference
   const anchor = this.createNode('a', '', {
     href: `#${rid}`,
     'data-ams-ref': refType
@@ -78,10 +86,8 @@ export default function (htmlParentNode, xmlnode) {
   } else {
     htmlParentNode.appendChild(anchor);
   }
-  // handle nested xref 
-  const linkChild = xmlnode.childNodes.find(node => node.tagName === 'xref' || node.tagName === 'ext-link');
-  if (linkChild) unnestLinks(this.recurseTheDom, this.createNode, xmlnode, anchor, linkChild)
-  else this.passThrough(anchor, xmlnode);
+  // Recursion
+  this.passThrough(anchor, xmlnode);
   // footonote ref gets wrapped in <sup>
   if (isFootnoteRef) {
     anchor.innerHTML = `<sup>${anchor.innerHTML}</sup>`;

package/lib/hacks.js

@@ -23,7 +23,7 @@ const phrasingContentTags = ['abbr', 'audio', 'b', 'bdo', 'br', 'button', 'canva
  */
 const sanitizeParagraph = node => {
     const childrenArray = [...node.children];
-    const maybeBadChild = childrenArray.find(child => !phrasingContentTags.includes(child.tagName.toLowerCase()));
+    const maybeBadChild = childrenArray.find(child => (!child.tagName.includes('-') && !phrasingContentTags.includes(child.tagName.toLowerCase())));  // check for content that is not phrasing conetnt and not a custom element name.
     if (!maybeBadChild) return;
     console.log(`Info: texml-to-html: fixing non-phrasing in paragraph, cf. texml#104, near ID ${node.closest('[id]')?.getAttribute('id')}`)
     const remainingChildren = childrenArray.slice(childrenArray.indexOf(maybeBadChild)).reverse();

package/lib/transformer.js

@@ -126,6 +126,8 @@ export class Transformer {
             'td',
             'pre',
             'hr',
+            'cite-group',
+            'cite-detail',
         ].forEach(mapTag.bind(null, this.copyElement));
         // passThrough elements
         [
@@ -144,7 +146,6 @@ export class Transformer {
             'back',
             'alternatives',
             'title-group',
-            'cite-group',
             'app-group',
             'book-title-group',
             'private-char',
@@ -201,7 +202,7 @@ export class Transformer {
         this.passThrough(span, xmlnode);
         return span.innerHTML.trim();
     }
-    
+
     // extract contrib-groups into json data
     extractContribGroups = extractContribGroups.bind(this);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amermathsoc/texml-to-html",
-  "version": "15.2.1",
+  "version": "16.1.1",
   "type": "module",
   "description": "A NodeJS library for converting AMS-style JATS XML to HTML",
   "scripts": {

package/test/article.xml

@@ -420,9 +420,11 @@
                 </target>
             </disp-formula>
         </sec>
-        <!-- inline-formula, disp-formula, tex-math -->
+        <!-- citegroup, cite-detail-->
         <sec disp-level="1" id="citegroup" specific-use="section">
-            <cite-group><x>[</x><xref ref-type="type" rid="rid1">ref</xref><x>, </x><xref ref-type="fn" rid="rid2">ref</xref><x>]</x></cite-group>
+         <p>
+         <cite-group><x>[</x><xref ref-type="bibr" rid="bibr-AEG0" specific-use="cite">AEG08<cite-detail><x>, </x>Section 5</cite-detail></xref><x>; </x><xref ref-type="bibr" rid="bibr-AEG0" specific-use="cite">AEG08</xref><x>]</x></cite-group>
+         </p>
         </sec>
 
         <!-- alt-title -->

package/test/book-meta-snapshot.json

@@ -18,6 +18,9 @@
                 "print": "isbn print",
                 "epub": "isbn epub"
             },
+            "loc": {
+                "lccn": "0123456789"
+            },
             "basename": "seriesvolume"
         },
         "title": "title",

package/test/book.xml

@@ -24,6 +24,7 @@
         <book-id assigning-authority="AMS" book-id-type="publisher">series</book-id>
         <book-id assigning-authority="AMS" book-id-type="volume_id">volume</book-id>
         <book-id assigning-authority="crossref" book-id-type="doi">doi</book-id>
+        <book-id assigning-authority="Library of Congress" book-id-type="lccn">0123456789</book-id>
         <book-title-group>
             <book-title>title</book-title>
             <subtitle>subtitle</subtitle>
@@ -85,7 +86,7 @@
             <title-group>
             <title>Contents</title>
             </title-group>
-            <toc-entry>
+            <toc-entry specific-use="chapter">
             <title>Chunk</title>
             <nav-pointer rid="tocid1"/>
             </toc-entry>
@@ -266,6 +267,11 @@
                         <line indent="1">Indented line.</line>
                     </simpletabbing>
                 </sec>
+                <!-- citegroup, cite-detail-->
+                <sec disp-level="1" id="citegroup" specific-use="section">
+                    <cite-group><x>[</x><xref ref-type="bibr" rid="bibr-AEG0" specific-use="cite">AEG08<cite-detail><x>, </x>Section 5</cite-detail></xref><x>; </x><xref ref-type="bibr" rid="bibr-AEG0" specific-use="cite">AEG08</xref><x>]</x></cite-group>
+                </sec>
+
             </body>
         </book-part>
     </book-body>

package/test/{element-citegroup.js → element-cite-detail.js}

@@ -18,8 +18,8 @@ import { article } from './helper.js';
 import tape from 'tape';
 
 
-tape('Template: cite-group', async function(t) {
+tape('Template: cite-detail', async function(t) {
   t.plan(1);
-  const document = article;
-  t.equal(document.querySelectorAll('section#citegroup a').length, 2, 'cite-group passed through, leaving two anchors');
+
+  t.equal(article.querySelector('cite-detail').outerHTML, '<cite-detail>, Section 5</cite-detail>', 'cite-detail');
 });

package/test/element-cite-group.js

@@ -0,0 +1,27 @@
+/*!
+ *  Copyright (c) 2023 American Mathematical Society
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+import { article, book } from './helper.js';
+import tape from 'tape';
+
+
+tape('Template: cite-group', async function (t) {
+  t.plan(2);
+
+  t.equal(article.querySelector('cite-group').outerHTML, '<cite-group><cite><a role="doc-biblioref" data-ams-ref="bibr" href="#bibr-AEG0">AEG08<cite-detail>, Section 5</cite-detail></a></cite><cite><a role="doc-biblioref" data-ams-ref="bibr" href="#bibr-AEG0">AEG08</a></cite></cite-group>', 'cite-group in article');
+  t.equal(book.querySelector('cite-group').outerHTML, '<cite-group>[<cite><a role="doc-biblioref" data-ams-ref="bibr" href="#bibr-AEG0">AEG08<cite-detail>, Section 5</cite-detail></a></cite>; <cite><a role="doc-biblioref" data-ams-ref="bibr" href="#bibr-AEG0">AEG08</a></cite>]</cite-group>', 'cite-group in book');
+
+});

package/test/element-ext-link.js

@@ -20,11 +20,10 @@ import tape from 'tape';
 
 
 tape('Template: ext-link', async function (t) {
-  t.plan(3);
+  t.plan(2);
   const document = article;
   const extlink = document.querySelector('a[href="https://"]');
   t.ok(extlink, 'Element ext-link becomes a with href');
-  t.notOk(document.querySelector('a[href="https://nested2"] a'), 'ext-link with xref inside does not produce nested link');
-  t.ok(document.querySelector('a[href="https://nested2"]+span').querySelector('a[data-ams-ref="nested"]'), 'xref inside ext-link moved after ext-link');
+  t.equal(document.querySelector('a[href="https://nested2"]').outerHTML, '<a href="https://nested2"><span data-ams-href="rid6"></span></a>', 'xref inside ext-link flattened');
 });
 

package/test/element-toc-toc-entry.js

@@ -29,9 +29,9 @@ tape('Template: (book) toc, toc-entry', async function(t) {
   t.ok(list, 'toc: ordered list');
   t.equal(list.children.length, 6, 'Nested toc-entries remain nested')
   t.equal(
-    list.querySelector('li a[href="#tocid1"]').innerHTML,
+    list.querySelector('li a[href="#tocid1"][data-ams-ref="chapter"]').innerHTML,
     'Chunk',
-    'toc-entry and nav-pointer'
+    'toc-entry and nav-pointer with href and data-ams-ref'
   );
   t.equal(
     list.querySelector('li a[href="#tocid2"]').innerHTML,
@@ -46,7 +46,7 @@ tape('Template: (book) toc, toc-entry', async function(t) {
   );
   t.equal(
     list.querySelector('li a[href="#tocid4"]').innerHTML,
-    '1. SubSubChunk with Link',
+    '1. SubSubChunk with <span data-ams-href="chapter">Link</span>',
     'toc-entry with xref in title'
   );
   t.equal(

package/test/element-xref.js

@@ -20,13 +20,12 @@ import tape from 'tape';
 
 
 tape('Template: xref', async function(t) {
-  t.plan(7);
+  t.plan(6);
   const document = article;
   t.ok(document.querySelector('a[href="#rid1"][data-ams-ref="type"]'), 'xref as anchor with href, data-ams-ref');
   t.ok(document.querySelector('a[href="#rid2"][data-ams-ref="fn"][role="doc-noteref"]'), 'xref with ref-type fn has role doc-noteref');
   t.equal(document.querySelector('a[data-ams-ref="fn"]').firstElementChild.tagName, 'SUP', 'xref with ref-type fn has firstChild sup');
   t.ok(document.querySelector('cite a[href="#rid3"][data-ams-ref="bibr"][role="doc-biblioref"]'), 'xref with ref-type bibr a cite with anchor with href, data-ams-ref, role doc-biblioref');
   t.ok(document.querySelector('span[data-ams-ref="notrid"]'), 'xref without rid as span with data-ams-ref notrid');
-  t.notOk(document.querySelector('a[data-ams-ref="nested"] a'), 'xref with ext-link inside does not have nested link');
-  t.ok(document.querySelector('a[data-ams-ref="nested"]+span').querySelector('a[href="https://nested"]'), 'ext-link inside xref moved after xref');
+  t.equal(document.querySelector('a[data-ams-ref="nested"]').outerHTML, '<a data-ams-ref="nested" href="#rid6"><span data-ams-href="https://nested"></span></a>', 'xref with ext-link inside: nested link flattened');
 });

package/test/hacks.js

@@ -19,7 +19,7 @@ import tape from 'tape';
 
 
 tape('Hacks', async function (t) {
-    t.plan(4);
+    t.plan(5);
     const document = article;
 
     // moved from test/element-def-list-def-item-def-term.js (for the old def-list.js hack of "move DL after its P parent")
@@ -33,5 +33,9 @@ tape('Hacks', async function (t) {
     t.equal(firstDT.innerHTML, '1', 'DLs moved out of paragraph appear in the correct oder');
 
     t.equal(document.querySelectorAll('#hacks > p').length, 1, 'If paragraph is empty after postprocessing, it is removed.')
+    
+    console.log(article.querySelector('cite-group').parentNode.outerHTML)
+
+    t.equal(document.querySelector('cite-group').parentNode.tagName, 'P', 'Custom elements remain in paragraph');
 });
 

package/lib/helpers/unnest.js

@@ -1,34 +0,0 @@
-/*!
- *  Copyright (c) 2023 American Mathematical Society
- *
- *  Licensed under the Apache License, Version 2.0 (the "License");
- *  you may not use this file except in compliance with the License.
- *  You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the License is distributed on an "AS IS" BASIS,
- *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *  See the License for the specific language governing permissions and
- *  limitations under the License.
- */
-
-/**
- * moves links into subsequent span
- * @param {Function} recurseTheDom 
- * @param {Function} createNode 
- * @param {Node} xmlnode  XML DOM node
- * @param {Node} htmlnode HTML Dom Node
- * @param {Node} linkChild XML Dom Node, child of xmlnode
- * @returns {Boolean} 
- */
-export const unnestLinks = (recurseTheDom, createNode, xmlnode, htmlnode, linkChild) => {
-    const siblings = [...xmlnode.childNodes];
-    const precedingSiblings = siblings.slice(0, siblings.indexOf(linkChild));
-    const followingSiblings = siblings.slice(siblings.indexOf(linkChild));
-    const span = createNode('span');
-    htmlnode.insertAdjacentElement('afterend', span);
-    precedingSiblings.forEach(recurseTheDom.bind(null, htmlnode));
-    followingSiblings.forEach(recurseTheDom.bind(null, span));
-}