Skip to content

Latest commit

 

History

History
37 lines (20 loc) · 2.58 KB

File metadata and controls

37 lines (20 loc) · 2.58 KB

Roadmap

High-level direction (feature gaps, platforms, performance) should be tracked here as the project grows. This file is intentionally short; detailed design lives in docs/.

KaTeX command-level gaps (summary)

The canonical list of KaTeX commands that RaTeX does not support or does not treat equivalently (e.g. \includegraphics, \htmlClass / \htmlData / \htmlId, and notes on \htmlStyle) lives in the README:

  • English: README.md — section “KaTeX differences (commands & DOM)”.
  • 中文: README.zh-CN.md — section 「与 KaTeX 的差异(命令 / DOM)」.

Rendering vs KaTeX reference PNGs is tracked separately via golden / support-table scores, not only by that list.

Golden tests: mostly unnumbered display math

tests/golden/test_cases.txt is mostly starred AMS environments (equation*, gather*, align*, alignat*, …) so KaTeX reference PNGs stay a stable baseline for ink-based comparison.

A small set of lines exercises automatic numbering (equation, align, gather, alignat), \tag, and \nonumber / \notag (see near the end of the file). RaTeX implements these; KaTeX reference shots for multiline numbered rows can still show tags overlapping ink, which is a weaker baseline for strict pixel diffs—use those lines mainly for regression coverage.

After editing test_cases.txt, keep indices aligned:

  • KaTeX PNGs: node tools/golden_compare/generate_reference.mjs (see script header).
  • RaTeX PNGs: scripts/update_golden_output.sh.

与 KaTeX 命令级差异(摘要)

与 KaTeX 在命令 / DOM 层仍不一致或缺失的条目(如 \includegraphics\htmlClass / \htmlData / \htmlId、以及 \htmlStyle 的说明),以 README 「与 KaTeX 的差异(命令 / DOM)」 为准;与参考 PNG 的版式差异另见 golden / 支持表分数。

Golden 测试:以无编号环境为主

tests/golden/test_cases.txt 主体仍为带星号的环境(equation*gather*align*alignat* 等),以便 KaTeX 对照图作为稳定的像素/墨量基准。

文件末尾附近保留少量用例,覆盖 自动编号equationaligngatheralignat)以及 \tag\nonumber / \notag。RaTeX 已支持这些特性;KaTeX 在多行编号场景下参考图仍可能出现编号与笔迹重叠,不适合作为严苛像素对比的权威基准,以功能回归为主。

修改 test_cases.txt 后请重跑 generate_reference.mjsupdate_golden_output.sh,以同步 fixtures/output/