fix #11

Author: fncokg

CHANGELOG.md

@@ -1,3 +1,6 @@
+# 1.2.4 (2025-03-07)
+Support customizable spacing command in the `equation-src-format` field (default now is `"\\quad({num})"`). Also refer to issue #11.
+
 # 1.2.3 (2025-02-01)
 Fix type casting problem when inputting the metadata from the command line. 
 

README.md

@@ -113,6 +113,8 @@ By default, **if not specified**, the `Cref` format will be the capitalized vers
 
 For sections, every level has its own formatting. You can set the metadata, for example, `section-src-format-1`, `section-cref-format-2`, etc.
 
+For equations, the default `src` format (i.e. `equation-src-format`) is `"\\qquad({num})"`. `\qquad` is used to offer a little space between the equation and the number. You can customize it as you like.
+
 #### Metadata Values
 The metadata values are python f-string format strings. Various fields are provided for you to customize the format. For example, if you set the `number-reset-level` to 2, `figure-prefix` to `figure` and `prefix-space` to `True`. Then, the fifth figure under subsection 2.3 will have the following fields:
 - `num`: `2.3.5`
@@ -292,7 +294,7 @@ table-src-format: "Table {h1}-{h2}-{tab_id}"
 table-cref-format: "table {tab_id} (in Section {h1}.{h2})"
 figure-src-format: "Figure {h1}.{h2}:{fig_id}"
 figure-cref-format: "as shown in Fig. {num}"
-equation-src-format: "({h1}-{h2}-{eq_id})"
+equation-src-format: "\\qquad({h1}-{h2}-{eq_id})"
 subfigure-src-format: "[{subfig_sym}({subfig_id})]"
 subfigure-symbols: "αβγδεζηθικλμνξοπρστυφχψω"
 custom-lot: true
@@ -354,4 +356,5 @@ There are some known issues and possible improvements:
 - [x] Add empty caption for figures and tables without captions (currently, they have no caption and therefore links to them cannot be located).
 - [ ] Directly support `align*` and other non-numbered environments.
 - [x] Subfigure support.
-- [x] Support short captions in `docx` output.
+- [x] Support short captions in `docx` output.
+- [ ] Support right-aligned equation numbers.

pyproject.toml

@@ -7,7 +7,7 @@ packages = ["src/pandoc_tex_numbering"]
 
 [project]
 name = "pandoc-tex-numbering"
-version = "1.2.3"
+version = "1.2.4"
 dependencies = ["pylatexenc", "panflute"]
 requires-python = ">=3.8"
 authors = [{ name = "Chao Kong", email = "kongchao1998@gmail.com" }]

src/pandoc_tex_numbering/pandoc_tex_numbering.py

@@ -108,7 +108,7 @@ def prepare(doc):
             ["cref","{prefix}{num}"],
             ["Cref",None]
         ]:
-            if item == "eq" and preset == "src": default = "({num})"
+            if item == "eq" and preset == "src": default = "\\qquad({num})"
             fmt = doc.get_metadata(f"{aka[item]}-{preset}-format", default)
             fmt_presets[preset] = fmt
         formaters[item] = Formater(
@@ -251,7 +251,7 @@ def _parse_multiline_environment(root_node,doc):
                 is_label_this_line = False
             if node.macroname == "\\":
                 if is_label_this_line:
-                    environment_body += f"\\qquad{{{num_obj.src}}}"
+                    environment_body += f"{{{num_obj.src}}}"
                     if label_of_this_line:
                         labels[label_of_this_line] = num_obj
                     doc.num_state.next_eq()
@@ -261,7 +261,7 @@ def _parse_multiline_environment(root_node,doc):
         environment_body += node.latex_verbatim()
 
     if is_label_this_line:
-        environment_body += f"\\qquad{{{num_obj.src}}}"
+        environment_body += f"{{{num_obj.src}}}"
         if label_of_this_line:
             labels[label_of_this_line] = num_obj
     modified_math_str = f"\\begin{{{root_node.environmentname}}}{environment_body}\\end{{{root_node.environmentname}}}"
@@ -271,7 +271,7 @@ def _parse_plain_math(math_str:str,doc):
     labels = {}
     doc.num_state.next_eq()
     num_obj = doc.num_state.current_eq()
-    modified_math_str = f"{math_str}\\qquad{{{num_obj.src}}}"
+    modified_math_str = f"{math_str}{{{num_obj.src}}}"
     label_strings = re.findall(r"\\label\{(.*?)\}",math_str)
     if len(label_strings) >= 2:
         logger.warning(f"Multiple label_strings in one math block: {label_strings}")

tests/test.yaml

@@ -12,7 +12,7 @@ table-src-format: "Table {h1}-{h2}-{tab_id}"
 table-cref-format: "table {tab_id} (in Section {h1}.{h2})"
 figure-src-format: "Figure {h1}.{h2}:{fig_id}"
 figure-cref-format: "as shown in Fig. {num}"
-equation-src-format: "({h1}-{h2}-{eq_id})"
+equation-src-format: "\\qquad({h1}-{h2}-{eq_id})"
 subfigure-src-format: "[{subfig_sym}({subfig_id})]"
 subfigure-symbols: "αβγδεζηθικλμνξοπρστυφχψω"
 custom-lot: true