fix counts

Author: dmca-glasgow

packages/processor/src/input-to-markdown/mdast-transforms/add-frontmatter.ts

@@ -42,8 +42,7 @@ export function addFrontmatter(ctx: Context) {
         ctx.frontmatter['reference-location'];
     }
 
-    const { theorems } = ctx.frontmatter;
-    const theoremsYaml = theoremsToFrontmatter(theorems);
+    const theoremsYaml = theoremsToFrontmatter(ctx);
     if (Object.keys(theoremsYaml).length > 0) {
       toExport.theorems = theoremsYaml;
     }

packages/processor/src/markdown-to-mdx/context.ts

@@ -28,6 +28,8 @@ export type Frontmatter = {
   date: string;
   author: Author | Author[];
   abstract: string;
+  documentClass?: string;
+  hasPart?: boolean;
   theorems: RefObjectsYaml;
   'reference-location': string;
 };
@@ -41,6 +43,8 @@ export type Context = {
     theorems: RefObjectsYaml;
     refMap: Record<string, Reference>;
     referenceLocation: string;
+    documentClass?: string;
+    hasPart?: boolean;
   };
   hasSideNotes: boolean;
 };

packages/processor/src/markdown-to-mdx/hast-transforms/index.ts

@@ -12,8 +12,9 @@ import { footNotesToSideNotes } from '../../plugins/footnotes/footnotes-to-siden
 import { replaceFootnoteRefDefs } from '../../plugins/footnotes/replace-ref-def';
 import { addDefaultAltText } from '../../plugins/images/default-image-alt';
 import { addMathsRefsAndCount } from '../../plugins/maths/add-maths-refs-and-count';
+import { mathTagToRefLabel } from '../../plugins/maths/math-tag-to-ref-label';
 import { missingMathsImageToSvg } from '../../plugins/missing-maths/missing-maths-img-to-svg';
-import atReferenceToLink from '../../plugins/refs-and-counts/at-reference-to-link';
+import { atReferenceToLink } from '../../plugins/refs-and-counts/at-reference-to-link';
 import { addCounts } from '../../plugins/refs-and-counts/hast-add-counts';
 import { Context } from '../context';
 import { Options } from '../options';
@@ -85,6 +86,7 @@ function createRehypeFragmentPlugins(
     // ],
 
     // should be last
+    [mathTagToRefLabel, ctx],
     [addCounts, ctx],
     [atReferenceToLink, ctx], // depends on addCounts
 

packages/processor/src/markdown-to-mdx/mdast-transforms/extract-frontmatter.ts

@@ -3,6 +3,7 @@ import { Root } from 'mdast';
 import { visit } from 'unist-util-visit';
 import { parse } from 'yaml';
 
+import { createHeadingDepths } from '../../plugins/headings/heading-depths';
 import {
   RefObjectsYaml,
   createDefaultObjectsYaml,
@@ -39,6 +40,15 @@ export function extractFrontmatter(ctx: Context) {
       if (fm.abstract) {
         ctx.frontmatter.abstract = fm.abstract;
       }
+
+      if (fm.documentClass) {
+        ctx.frontmatter.documentClass = fm.documentClass;
+      }
+
+      if (fm.hasPart) {
+        ctx.frontmatter.hasPart = fm.hasPart;
+      }
+
       if (fm.theorems) {
         const { custom = [], ...theorems } = fm.theorems;
         const customObj = custom.reduce(
@@ -48,6 +58,21 @@ export function extractFrontmatter(ctx: Context) {
           },
           {},
         );
+
+        // convert section to heading in theorem.numberWithin
+        const { documentClass, hasPart } = ctx.frontmatter;
+        const depths = createHeadingDepths(documentClass, hasPart);
+        Object.entries(ctx.frontmatter.theorems).forEach(
+          ([name, theorem]) => {
+            if (!Array.isArray(theorem)) {
+              if (theorem.numberWithin) {
+                const thm = ctx.frontmatter.theorems[name];
+                thm.numberWithin = depths[theorem.numberWithin];
+              }
+            }
+          },
+        );
+
         ctx.frontmatter.theorems = merge(
           ctx.frontmatter.theorems,
           theorems || {},

packages/processor/src/plugins/headings/adjust-heading-depth.ts

@@ -2,6 +2,7 @@ import { Root } from 'hast';
 import { visit } from 'unist-util-visit';
 
 import { Context } from '../../input-to-markdown/context';
+import { createHeadingDepths } from './heading-depths';
 
 export function adjustHeadingDepth(ctx: Context) {
   return (tree: Root) => {
@@ -31,16 +32,6 @@ export function adjustHeadingDepth(ctx: Context) {
         }
       }
     });
-
-    // swap sections to headings in theorem definitions
-    Object.entries(ctx.frontmatter.theorems).forEach(([name, theorem]) => {
-      if (!Array.isArray(theorem)) {
-        if (theorem.numberWithin) {
-          const thm = ctx.frontmatter.theorems[name];
-          thm.numberWithin = ctx.sectionToHeading[theorem.numberWithin];
-        }
-      }
-    });
   };
 }
 
@@ -64,39 +55,3 @@ function hasPartHeading(tree: Root) {
   });
   return hasPart;
 }
-
-function createHeadingDepths(
-  documentClass: string,
-  hasPart: boolean,
-): Context['sectionToHeading'] {
-  if (['report', 'book'].includes(documentClass)) {
-    if (hasPart) {
-      return {
-        title: 'h1',
-        part: 'h2',
-        chapter: 'h3',
-        section: 'h4',
-        subsection: 'h5',
-        subsubsection: 'h6',
-      };
-    } else {
-      return {
-        title: 'h1',
-        chapter: 'h2',
-        section: 'h3',
-        subsection: 'h4',
-        subsubsection: 'h5',
-        paragraph: 'h6',
-      };
-    }
-  } else {
-    return {
-      title: 'h1',
-      section: 'h2',
-      subsection: 'h3',
-      subsubsection: 'h4',
-      paragraph: 'h5',
-      subparagraph: 'h6',
-    };
-  }
-}

packages/processor/src/plugins/headings/heading-depths.ts

@@ -0,0 +1,37 @@
+import { Context } from '../../input-to-markdown/context';
+
+export function createHeadingDepths(
+  documentClass?: string,
+  hasPart?: boolean,
+): Context['sectionToHeading'] {
+  if (['report', 'book'].includes(documentClass || '')) {
+    if (hasPart) {
+      return {
+        title: 'h1',
+        part: 'h2',
+        chapter: 'h3',
+        section: 'h4',
+        subsection: 'h5',
+        subsubsection: 'h6',
+      };
+    } else {
+      return {
+        title: 'h1',
+        chapter: 'h2',
+        section: 'h3',
+        subsection: 'h4',
+        subsubsection: 'h5',
+        paragraph: 'h6',
+      };
+    }
+  } else {
+    return {
+      title: 'h1',
+      section: 'h2',
+      subsection: 'h3',
+      subsubsection: 'h4',
+      paragraph: 'h5',
+      subparagraph: 'h6',
+    };
+  }
+}

packages/processor/src/plugins/maths/__test__/maths.test.ts

@@ -358,3 +358,82 @@ test('expand newcommand inside newcommand', async () => {
   // const quartoHtml = await markdownToQuartoHtml(markdown);
   // console.log(quartoHtml);
 });
+
+test('maths equations with labels and tags', async () => {
+  const latex = String.raw`
+    \documentclass{article}
+    \usepackage{amsmath}
+    \usepackage[noabbrev, capitalise, nameinlink]{cleveref}
+    \begin{document}
+
+    \begin{equation}\label{eq:einstein1}
+      E=mc^2
+    \end{equation}
+
+    Hello, \cref{eq:einstein1}.
+
+    \begin{equation}\label{eq:einstein2}
+      E=mc^2\tag{hello $E$}
+    \end{equation}
+
+    Hello, \cref{eq:einstein2}.
+
+    \begin{equation}\label{eq:einstein3}
+      E=mc^2
+    \end{equation}
+
+    Hello, \cref{eq:einstein3}.
+
+    \end{document}
+  `;
+
+  const markdown = await testProcessor.latex(latex);
+  // console.log(markdown);
+
+  const expectedMarkdown = unindentStringAndTrim(String.raw`
+    $$
+    \begin{equation}E=mc^{2}\end{equation}
+    $$ {#eq-einstein-1}
+
+    Hello, @eq-einstein-1.
+
+    $$
+    \begin{equation}E=mc^{2}\tag{hello $E$}\end{equation}
+    $$ {#eq-einstein-2}
+
+    Hello, @eq-einstein-2.
+
+    $$
+    \begin{equation}E=mc^{2}\end{equation}
+    $$ {#eq-einstein-3}
+
+    Hello, @eq-einstein-3.
+  `);
+
+  expect(markdown).toBe(expectedMarkdown);
+
+  const html = await testProcessor.md(markdown, {
+    // state: {
+    //   maths: {
+    //     mathsAsTex: false,
+    //     mathsFontName: 'computerModern',
+    //     syntaxHighlight: false,
+    //   },
+    // },
+  });
+  // console.log(html);
+
+  const expectedHtml = unindentStringAndTrim(String.raw`
+    <p id="eq-einstein-1" class="maths env-equation"><code class="latex">\begin{equation}E=mc^{2}\end{equation}</code><span class="eq-count">(1)</span></p>
+    <p>Hello, <a href="#eq-einstein-1" class="ref">Equation 1</a>.</p>
+    <p id="eq-einstein-2" class="maths env-equation"><code class="latex">\begin{equation}E=mc^{2}\end{equation}</code><span class="eq-count"><span class="eq-count">(hello <code class="latex">E</code>)</span></span></p>
+    <p>Hello, <a href="#eq-einstein-2" class="ref">Equation (hello <code class="latex">E</code>)</a>.</p>
+    <p id="eq-einstein-3" class="maths env-equation"><code class="latex">\begin{equation}E=mc^{2}\end{equation}</code><span class="eq-count">(2)</span></p>
+    <p>Hello, <a href="#eq-einstein-3" class="ref">Equation 2</a>.</p>
+  `);
+
+  expect(html).toBe(expectedHtml);
+
+  // const quartoHtml = await markdownToQuartoHtml(markdown);
+  // console.log(quartoHtml);
+});

packages/processor/src/plugins/maths/equation-label-to-id.ts

@@ -3,50 +3,47 @@ import { getArgsContent } from '@unified-latex/unified-latex-util-arguments';
 import { visit } from '@unified-latex/unified-latex-util-visit';
 import kebabCase from 'lodash.kebabcase';
 
-import { printRaw } from '../../../../../unified-latex-forks/unified-latex-util-print-raw/libs/print-raw';
+import { printRaw } from '@isos/unified-latex-util-print-raw';
 
 export function equationLabelToId() {
   return (tree: Ast.Root) => {
     visit(tree, (node) => {
       if (node.type === 'mathenv') {
         const env = (node.env || {}) as Ast.Node;
-        const label = extractLabel(node);
+        const id = extractMacro(node, 'label');
 
         if (
           env.type === 'string' &&
           ['equation', 'align'].includes(env.content)
         ) {
-          if (label) {
-            Object.assign(node, {
-              data: {
-                id: extractLabelText(label),
-              },
-            });
+          const data: Record<string, string> = {};
+          if (id) {
+            data.id = kebabCase(extractText(id));
           }
+          Object.assign(node, { data });
         }
       }
     });
   };
 }
 
-function extractLabel(mathEnv: Ast.Node): Ast.Macro | null {
-  let label = null;
+function extractMacro(mathEnv: Ast.Node, name: string): Ast.Macro | null {
+  let macro = null;
   visit(mathEnv, (node, info) => {
-    if (node.type === 'macro' && node.content === 'label') {
-      label = node;
+    if (node.type === 'macro' && node.content === name) {
+      macro = node;
 
-      // remove label
+      // remove macro
       const parent = info.parents[0];
       if (parent && parent.type === 'mathenv') {
         parent.content.splice(info.index || 0, 1);
       }
     }
   });
-  return label;
+  return macro;
 }
 
-function extractLabelText(label: Ast.Macro) {
-  const args = getArgsContent(label);
-  const text = printRaw(args[args.length - 1] || []).trim();
-  return kebabCase(text);
+function extractText(macro: Ast.Macro) {
+  const args = getArgsContent(macro);
+  return printRaw(args[args.length - 1] || []).trim();
 }

packages/processor/src/plugins/maths/math-meta-to-id.ts

@@ -14,11 +14,15 @@ export function mathMetaToId() {
         const attr = parseAttr(meta).prop;
 
         if (attr) {
+          const properties = {
+            'data-id': attr.id,
+          };
+
           node.data = {
             ...(node.data || {}),
             hProperties: {
               ...(node.data?.hProperties || {}),
-              'data-id': attr.id,
+              ...properties,
             },
           };
         }