v1.3.2

Support specifying the multiple reference style in the metadata, so that you can get "equation 1, equation 2 and equation 3" instead of "equations 1, 2 and 3" in the multiple references.

Fix some bugs:

• Fix the bug that files containing levels beyond max_level cause crash.
• Fix the bug that the \label command outside the \section command is not processed correctly.

v1.3.1

Support specifying the numbering offset of any type of numbering.

Some minor bug fixes and improvements:

• Remove the \listoffigures and \listoftables command searching process, such that the feature of customizable lot/lof location is no longer supported. This is because: to enable latex command searching, we need to a raw_tex input, which in many cases will lead much more errors.
• Remove some typing for the backward compatibility consideration.

v1.3.0

Support various custom numbering styles in a more clear and flexible way:

• support various and auto-extend numbering symbols: arabic numbers, roman numbers, latin/greek/cyrillic letters (both upper and lower case), Chinese numbers, etc.
• support custom numbering symbols for anything: any level of section, figure, table, equation, theorem, etc.

Support appendix numbering.

Metadata {item_type}-symbols and fields {item_type}_sym are no longer supported.

Migration Guide

For people who are using 1.2.x version, there are some removals:

The following metadata keys have already marked as deprecated in the previous version, and they are now removed:

• metadata keys section-format-source-i and section-format-ref-i for the i-the level section numbering formatting are now removed. You should use the new section-src-format-i and section-cref-format-i keys instead.

The following features are now removed, and you should use the new API instead:

• metadata keys {item_type}-symbols and formatting fields {item_type}_sym are now removed. Now you can simply use {item_type}-numstyle to specify the numbering style directly.

v1.2.5

Support theorem numbering. Also refer to a StackExchange question.

v1.2.4

Support customizable spacing command in the equation-src-format field (default now is "\\quad({num})"). Also refer to issue #11.

v1.2.3

Fix type casting problem when inputting the metadata from the command line.

Announce stable status in the project classifiers.

v1.2.2

Support multiple references in the same ref command, such as \cref{fig1,fig2,fig3}.

v1.2.1

Fix a severe numbering logic bug in the previous version. Now the numbering system should work as expected.

v1.2.0

Rewrite the low-level numbering system (switch to a OOP design). Now we support:

• Full-featured formatting for the numbering system
• OOP designed API for the numbering system, which is much easier to extend

Migration Guide

For people who are using 1.1.x version, there are some deprecations and removals:

The following metadata keys are now deprecated, and you are recommended to use the new keys instead (the old keys are still supported until v1.3.0):

• metadata keys section-format-source-i and section-format-ref-i for the i-the level section numbering formatting are now deprecated. You should use the new section-src-format-i and section-cref-format-i keys instead. For backward compatibility, the old keys are still supported until the next major release (1.3.0).

The following features are now removed, and you should use the new API instead:

• metadata keys subfigure-format is now removed considering its ambiguity. You should use the new unified metadata keys subfigure-src-format and subfigure-cref-format instead.
• fields num and sym in subfigure-format are (of course) now removed. The new fields subfig_id and subfig_sym should be used instead.

v1.1.2

Fix #7: support compatibility with python >=3.8