Improve comments, refactor numbering context

NASA-IMPACT · Oct 19, 2023 · 116a543 · 116a543
1 parent aa09225
commit 116a543
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 68 deletions.
diff --git a/app/assets/scripts/context/numbering.js b/app/assets/scripts/context/numbering.js
@@ -1,9 +1,10 @@
 import { createContext, useCallback, useMemo, useState } from 'react';
 
+/**
+ *  Provides a context for equation numbering.
+ */
 export function useNumberingProviderValue() {
   const [registeredEquations, setRegisteredEquations] = useState({});
-  const [registeredImages, setRegisteredImages] = useState({});
-  const [registeredTables, setRegisteredTables] = useState({});
 
   const registerEquation = useCallback((key) => {
     setRegisteredEquations((prevElements) => {
@@ -19,34 +20,6 @@ export function useNumberingProviderValue() {
     });
   }, []);
 
-  const registerImage = useCallback((key) => {
-    setRegisteredImages((prevElements) => {
-      if (prevElements[key]) {
-        return prevElements;
-      }
-
-      const numElements = Object.keys(prevElements).length;
-      return {
-        ...prevElements,
-        [key]: numElements + 1
-      };
-    });
-  }, []);
-
-  const registerTable = useCallback((key) => {
-    setRegisteredTables((prevElements) => {
-      if (prevElements[key]) {
-        return prevElements;
-      }
-
-      const numElements = Object.keys(prevElements).length;
-      return {
-        ...prevElements,
-        [key]: numElements + 1
-      };
-    });
-  }, []);
-
   const getEquationNumbering = useCallback(
     (key) => {
       const numbering = registeredEquations[key];
@@ -59,47 +32,12 @@ export function useNumberingProviderValue() {
     [registeredEquations]
   );
 
-  const getTableNumbering = useCallback(
-    (key) => {
-      const numbering = registeredTables[key];
-      if (!numbering) {
-        return '';
-      }
-
-      return `Table ${numbering}: `;
-    },
-    [registeredTables]
-  );
-
-  const getImageNumbering = useCallback(
-    (key) => {
-      const numbering = registeredImages[key];
-      if (!numbering) {
-        return '';
-      }
-
-      return `Figure ${numbering}: `;
-    },
-    [registeredImages]
-  );
-
   return useMemo(
     () => ({
       getEquationNumbering,
-      getTableNumbering,
-      getImageNumbering,
-      registerEquation,
-      registerTable,
-      registerImage
+      registerEquation
     }),
-    [
-      getEquationNumbering,
-      getTableNumbering,
-      getImageNumbering,
-      registerEquation,
-      registerTable,
-      registerImage
-    ]
+    [getEquationNumbering, registerEquation]
   );
 }
 

diff --git a/app/assets/scripts/utils/apply-number-captions-to-document.js b/app/assets/scripts/utils/apply-number-captions-to-document.js
@@ -5,7 +5,10 @@ import {
 } from '../components/slate/plugins/constants';
 
 /**
- * Include table numbers and move captions before the table in the document.
+ * Include tables and figures numbers to their captions. We don't use a
+ * numbering context (like equation numbering) because we also need to change
+ * the position of the caption in the document, which is not possible with the
+ * current implementation of equation numbering context.
  */
 export function applyNumberCaptionsToDocument(document) {
   // Section id list in the order they should appear in the document