@amermathsoc/texml-to-html 16.1.1 → 17.0.1

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 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.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)
+
+
+### ⚠ BREAKING CHANGES
+
+* Expects role instead author-comment
+
+### Features
+
+* adjust to texml renaming author-comment to role ([c46822b](https://github.com/AmerMathSoc/texml-to-html/commit/c46822b9e6cbd96de1893c8e138f3f14df48492c)), closes [#449](https://github.com/AmerMathSoc/texml-to-html/issues/449)
+
 ### [16.1.1](https://github.com/AmerMathSoc/texml-to-html/compare/v16.1.0...v16.1.1) (2024-06-03)
 
 

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/helpers/extractContribGroups.js

@@ -75,14 +75,14 @@ export function extractContribGroups(articleMetaNode) {
         contributor.orcid = contrib.querySelector('contrib-id[contrib-id-type="orcid"]')?.textContent;
 
         contributor.uri = contrib.querySelector('uri')?.textContent;
-        // author-comment (NOTE: child of contrib-group but it's easier if we copy it to each contributor)
-        const authorComment = contrib.parentNode.querySelector('author-comment')?.textContent;
-        if (index === 0 && authorComment) contributor.byline = authorComment;
+        // role (NOTE: child of contrib-group but it's easier if we copy it to each contributor)
+        const role = contrib.parentNode.querySelector('role')?.textContent;
+        if (index === 0 && role) contributor.byline = role;
         contributorsArray.push(contributor);
     }
 
     const extractContribGroup = function (contributors, contribGroup) {
-        contributors[contribGroup.getAttribute('content-type')] ??= []; // NOTE: jams410 has 2 contrib-groups with content-type=contributors (but different author-comments); cf. #408
+        contributors[contribGroup.getAttribute('content-type')] ??= []; // NOTE: jams410 has 2 contrib-groups with content-type=contributors (but different roles); cf. #408
         contribGroup.querySelectorAll('contrib').forEach(extractContrib.bind(this, contributors[contribGroup.getAttribute('content-type')]));
     };
 

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": "16.1.1",
+  "version": "17.0.1",
   "type": "module",
   "description": "A NodeJS library for converting AMS-style JATS XML to HTML",
   "scripts": {

package/test/article--alttitle.xml

@@ -18,7 +18,7 @@
             <bio>Some biographical info with <email>email</email></bio>
           </contrib>
           <aff id="aff">aff</aff>
-          <author-comment>comment</author-comment>
+          <role>comment</role>
        </contrib-group>
        <contrib-group content-type="contribBs">
           <contrib contrib-type="contribB">
@@ -36,7 +36,7 @@
           </contrib>
           <aff id="aff1" specific-use="current">Aff1</aff>
           <aff id="aff2">Aff2</aff>
-          <author-comment>comment</author-comment>
+          <role>comment</role>
        </contrib-group>
       <funding-group>
           <funding-statement/>
@@ -118,7 +118,7 @@
           </contrib>
         </contrib-group>
         <contrib-group content-type="contributors">
-          <author-comment>with</author-comment>
+          <role>with</role>
           <contrib contrib-type="contributor">
             <string-name>Author 2</string-name>
             <bio>Author 2 Bio</bio>

package/test/article.xml

@@ -47,7 +47,7 @@
                     <uri>uri</uri>
                 </contrib>
                 <aff id="aff">aff</aff>
-                <author-comment>comment</author-comment>
+                <role>comment</role>
             </contrib-group>
             <contrib-group content-type="contribBs">
                 <contrib contrib-type="contribB">
@@ -66,7 +66,7 @@
                 </contrib>
                 <aff id="aff1" specific-use="current">Aff1</aff>
                 <aff id="aff2">Aff2</aff>
-                <author-comment>comment</author-comment>
+                <role>comment</role>
             </contrib-group>
             <funding-group>
                 <funding-statement>Funding 1</funding-statement>
@@ -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/book.xml

@@ -51,7 +51,7 @@
                 <uri>uri</uri>
             </contrib>
             <aff id="aff1">aff</aff>
-            <author-comment>comment</author-comment>
+            <role>comment</role>
         </contrib-group>
         <contrib-group content-type="contrib-group-type2">
             <contrib contrib-type="contrib-type2">
@@ -62,7 +62,7 @@
             </contrib>
         </contrib-group>
         <contrib-group content-type="contrib-group-type3">
-            <author-comment>comment</author-comment>
+            <role>comment</role>
             <contrib contrib-type="contrib-type3">
                 <name name-style="given-only">
                     <given-names>should be ignored</given-names>
@@ -218,9 +218,9 @@
                     <sec-meta>
                         <contrib-group>
                         <!-- NOTE: this contrib-group example is for MCL 1, 14 only; intentionally broken via #254 -->
-                        <author-comment>
+                        <role>
                             comment 
-                        </author-comment>
+                        </role>
                         </contrib-group>
                         <abstract>
                             <title>Abstract</title>

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-sec-meta.js

@@ -17,7 +17,7 @@
 import { article, articleAlttitle, book } from './helper.js';
 import tape from 'tape';
 
-tape('Template: sec-meta => contrib-group, author-comment, abstract/title', async function (t) {
+tape('Template: sec-meta => contrib-group, role, abstract/title', async function (t) {
   t.plan(10);
 
   const document = book;

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');
 });