@amermathsoc/texml-to-html 17.0.0 → 17.1.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 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.
 
+## [17.1.0](https://github.com/AmerMathSoc/texml-to-html/compare/v17.0.1...v17.1.0) (2024-07-04)
+
+
+### Features
+
+* **toc-entry.js:** add label/title wrappers ([2165072](https://github.com/AmerMathSoc/texml-to-html/commit/2165072dc60ff9fd7c40ad6f65221eaa6f0924a2)), closes [#451](https://github.com/AmerMathSoc/texml-to-html/issues/451)
+
+### [17.0.1](https://github.com/AmerMathSoc/texml-to-html/compare/v17.0.0...v17.0.1) (2024-06-07)
+
+
+### Bug Fixes
+
+* handle cite-group, cite-detail inside tex-math ([0df8528](https://github.com/AmerMathSoc/texml-to-html/commit/0df85280d892ee33572f0923f6e56197bbb26a34)), closes [#450](https://github.com/AmerMathSoc/texml-to-html/issues/450)
+
 ## [17.0.0](https://github.com/AmerMathSoc/texml-to-html/compare/v16.1.1...v17.0.0) (2024-06-07)
 
 

package/lib/elements/cite-detail.js

@@ -0,0 +1,30 @@
+/*!
+ *  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.
+ */
+
+/**
+ * sc element
+ * @param {HTMLElement} htmlParentNode 
+ * @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/cite-group.js

@@ -0,0 +1,31 @@
+/*!
+ *  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.
+ */
+
+/**
+ * sc element
+ * @param {HTMLElement} htmlParentNode 
+ * @param {Element} xmlnode 
+ */
+export default function (htmlParentNode, xmlnode) {
+  if (xmlnode.closest('tex-math')) {
+    this.passThrough(htmlParentNode, xmlnode);
+    return;
+  }
+  const citeGroup = this.createNode('cite-group');
+  htmlParentNode.appendChild(citeGroup);
+  this.passThrough(citeGroup, xmlnode);
+
+};

package/lib/elements/toc-entry.js

@@ -27,13 +27,14 @@ export default function (htmlParentNode, xmlnode) {
     "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
-  // NOTE [...].find() HACK for bug with ':scope > ...', jsdom/jsdom#2998
+  // NOTE: label/title handling must stay aligned with other cases
   const label = xmlnode.querySelector(':scope>label');
   const title = xmlnode.querySelector(':scope>title');
   const altTitle = xmlnode.querySelector(':scope>alt-title');
   if (label && label.innerHTML.trim() !== '') {
-    this.passThrough(anchor, label);
+    const labelSpan = this.createNode('span', '', { 'data-ams-doc': 'label' });
+    anchor.appendChild(labelSpan);
+    this.passThrough(labelSpan, label);
     anchor.insertAdjacentText('beforeend', '. ');
   }
   if (altTitle) {
@@ -43,7 +44,11 @@ export default function (htmlParentNode, xmlnode) {
       anchor.textContent + altTitleContent
     );
   }
-  if (title) this.passThrough(anchor, title);
+  if (title) {
+    const titleSpan = this.createNode('span', '', { 'data-ams-doc': 'title' });
+    anchor.appendChild(titleSpan);
+    this.passThrough(titleSpan, title);
+  }
   // NOTE we expect very simple markup: one contrib group, string-names only
   const contribGroup = xmlnode.querySelector(':scope>contrib-group');
   if (contribGroup) {

package/lib/transformer.js

@@ -80,6 +80,8 @@ import * as algorithm from './elements/algorithm.js';
 import Tag from './elements/tag.js';
 import Xrefgroup from './elements/xref-group.js';
 import TexMath from './elements/tex-math.js';
+import CiteGroup from './elements/cite-group.js';
+import CiteDetail from './elements/cite-detail.js';
 
 import copyElement from './helpers/copyElement.js';
 import { extractContribGroups } from './helpers/extractContribGroups.js';
@@ -126,8 +128,6 @@ export class Transformer {
             'td',
             'pre',
             'hr',
-            'cite-group',
-            'cite-detail',
         ].forEach(mapTag.bind(null, this.copyElement));
         // passThrough elements
         [
@@ -275,6 +275,8 @@ export class Transformer {
     tag = Tag.bind(this)
     'xref-group' = Xrefgroup.bind(this)
     'tex-math' = TexMath.bind(this)
+    'cite-group' = CiteGroup.bind(this)
+    'cite-detail' = CiteDetail.bind(this)
 
     // one-off reuse of imported elements
     // NOTE if RHS gets re-used more than once, use mapTag in the constructor

package/package.json

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

package/test/article.xml

@@ -419,6 +419,12 @@
                   <tag parens="yes">T</tag>
                 </target>
             </disp-formula>
+            <!-- Formula with cite-group and cite-detail -->
+            <disp-formula>
+            <tex-math>
+            <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></cite-group>
+            </tex-math>
+            </disp-formula>
         </sec>
         <!-- citegroup, cite-detail-->
         <sec disp-level="1" id="citegroup" specific-use="section">

package/test/element-inline-formula-disp-formula-tex-math.js

@@ -18,7 +18,7 @@ import { article } from './helper.js';
 import tape from 'tape';
 
 tape('inline-formula, disp-formula, tex-math', async function (t) {
-  t.plan(19);
+  t.plan(20);
   const document = article;
   const inlineformula = document.querySelector(
     '#equations [data-ams-doc="math inline"]'
@@ -93,4 +93,6 @@ tape('inline-formula, disp-formula, tex-math', async function (t) {
   t.ok(document.querySelector('div[data-ams-doc="math text"]'), 'Display Formula of content-type=text');
   t.equal(document.querySelector('div[data-ams-doc="math text"] > span[data-ams-doc="label"]#textEquation+p').previousElementSibling.innerHTML, '(T)', 'Display Formula of content-type=text, label and paragraph');
 
+  // formula with cite-group and cite-detail
+  t.equal(dispWithText[9].innerHTML, ' \\xhref[bibr]{#bibr-AEG0}{AEG08, Section 5} ', 'Formula with cite-group, cite-detail')
 });

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

@@ -17,7 +17,7 @@
 import { book } from './helper.js';
 import tape from 'tape';
 
-tape('Template: (book) toc, toc-entry', async function(t) {
+tape('Template: (book) toc, toc-entry', async function (t) {
   t.plan(14);
   const document = book;
 
@@ -30,28 +30,28 @@ tape('Template: (book) toc, toc-entry', async function(t) {
   t.equal(list.children.length, 6, 'Nested toc-entries remain nested')
   t.equal(
     list.querySelector('li a[href="#tocid1"][data-ams-ref="chapter"]').innerHTML,
-    'Chunk',
+    '<span data-ams-doc="title">Chunk</span>',
     'toc-entry and nav-pointer with href and data-ams-ref'
   );
   t.equal(
     list.querySelector('li a[href="#tocid2"]').innerHTML,
-    '2. Chunk',
+    '<span data-ams-doc="label">2</span>. <span data-ams-doc="title">Chunk</span>',
     'toc-entry, label, nav-pointer'
   );
   t.equal(list.querySelector('ol').children.length, 1, 'Doubly nested toc-entries remain nested');
   t.equal(
     list.querySelector('li a[href="#tocid2"]+ol li a[href="#tocid3"]').innerHTML,
-    '1. SubChunk',
+    '<span data-ams-doc="label">1</span>. <span data-ams-doc="title">SubChunk</span>',
     'Nested toc-entry, label, nav-pointer'
   );
   t.equal(
     list.querySelector('li a[href="#tocid4"]').innerHTML,
-    '1. SubSubChunk with <span data-ams-href="chapter">Link</span>',
+    '<span data-ams-doc="label">1</span>. <span data-ams-doc="title">SubSubChunk with <span data-ams-href="chapter">Link</span></span>',
     'toc-entry with xref in title'
   );
   t.equal(
     list.querySelector('li a[href="#tocid5"]').innerHTML,
-    'Chunk with alt title',
+    '<span data-ams-doc="title">Chunk with alt title</span>',
     'toc-entry with alt-title: content'
   );
   t.equal(
@@ -61,7 +61,7 @@ tape('Template: (book) toc, toc-entry', async function(t) {
   );
   t.equal(
     list.querySelector('li a[href="#tocid6"]').innerHTML,
-    'Chunk without label but subchunk with label',
+    '<span data-ams-doc="title">Chunk without label but subchunk with label</span>',
     'toc-entry without label but sub-entry with label'
   );
   t.equal(

package/test/hacks.js

@@ -34,8 +34,6 @@ tape('Hacks', async function (t) {
 
     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');
 });