281 | 282 | y = \sum_{n=0}^{\infty} a_n x^n 283 | 284 | 286 | (1) 287 | 288 |

289 | ~~~ 290 | 291 | The equation and its number are wrapped in a `

` with an `id` for linking and with class `eqnos` to allow for css styling. The number is in a separate span from the equation and is positioned right. 292 | 293 | 294 | ### Docx Output ### 295 | 296 | Docx OOXML output is under development and subject to change. Native capabilities will be used wherever possible. 297 | 298 | 299 | Getting Help 300 | ------------ 301 | 302 | If you have any difficulties with pandoc-eqnos, or would like to see a new feature, then please submit a report to our [Issues tracker]. 303 | 304 | 305 | Development 306 | ----------- 307 | 308 | Pandoc-eqnos will continue to support pandoc 1.15-onward and python 2 & 3 for the foreseeable future. The reasons for this are that a) some users cannot upgrade pandoc and/or python; and b) supporting all versions tends to make pandoc-eqnos more robust. 309 | 310 | Developer notes are maintained in [DEVELOPERS.md]. 311 | 312 | 313 | What's New 314 | ---------- 315 | 316 | **New in 2.5.0:** Allow reference numbers to be set in brackets ([Issue #57](https://github.com/tomduck/pandoc-eqnos/issues/57)). 317 | 318 | **New in 2.4.0:** Updated to work with pandoc 2.11. 319 | 320 | **New in 2.3.0:** Allow LaTeX equation environment customization ([Pull Request #44](https://github.com/tomduck/pandoc-eqnos/pull/44)). 321 | 322 | **New in 2.2.3:** Fixed XHTML Transitional validation error ([Issue #50](https://github.com/tomduck/pandoc-eqnos/issues/50)). 323 | 324 | **New in 2.2.1:** Updated for pandoc 2.10.1. 325 | 326 | **New in 2.1.1:** Warnings are now given for duplicate reference targets. 327 | 328 | **New in 2.0.0:** This version represents a major revision of pandoc-eqnos. While the interface is similar to that of the 1.x series, some users may encounter minor compatibility issues. 329 | 330 | Warning messages are a new feature of pandoc-eqnos. The meta variable `eqnos-warning-level` may be set to `0`, `1`, or `2` depending on the degree of warnings desired. Warning level `1` will alert users to bad references, malformed attributes, and unknown meta variables. Warning level `2` (the default) adds informational messages that should be helpful with debugging. Level `0` turns all messages off. 331 | 332 | Meta variable names have been updated. Deprecated names have been removed, and new variables have been added. Note in particular that the `eqnos-number-sections` and `xnos-number-sections` variables have been renamed to `eqnos-number-by-section` and `xnos-number-by-section`, respectively. 333 | 334 | The basic filter and library codes have been refactored and improved with a view toward maintainability. While extensive tests have been performed, some problems may have slipped through unnoticed. Bug reports should be submitted to our [Issues tracker]. 335 | 336 | 337 | *LaTeX/PDF:* 338 | 339 | LaTeX codes produced by pandoc-eqnos are massively improved. The hacks used before were causing some users problems. The new approach provides more flexibility and better compatibility with the LaTeX system. 340 | 341 | Supporting LaTeX is now written to the `header-includes` meta data. Users no longer need to include LaTeX commands in the `header-includes` to get basic pandoc-eqnos functions to work. Use `eqnos-warning-level: 2` to see what pandoc-eqnos adds to the `header-includes`. 342 | 343 | A word of warning: Pandoc-eqnos's additions to the `header-includes` are overridden when pandoc's `--include-in-header` option is used. This is owing to a [design choice](https://github.com/jgm/pandoc/issues/3139) in pandoc. Users may choose to deliberately override pandoc-eqnos's `header-includes` by providing their own LaTeX through `--include-in-header`. If a user needs to include other bits of LaTeX in this way, then they will need to do the same for the LaTeX that pandoc-eqnos needs. 344 | 345 | 346 | *Html/Epub:* 347 | 348 | The equation is now enclosed in a `

` which contains the `id` and class `eqnos`. This change was made to facilitate styling, and for consistency with pandoc-fignos and pandoc-tablenos. An inline-block `` was formerly used instead. 349 | 350 | Epub support is generally improved. 351 | 352 | 353 | ---- 354 | 355 | **Footnotes** 356 | 357 | 1: Pandoc 2.4 [broke](https://github.com/jgm/pandoc/issues/5099) how references are parsed, and so is not supported. 358 | 359 | 2: For MacOS, my preferred install method is to use the package [available from python.org](https://www.python.org/downloads/). 360 | 361 | 3: Anaconda users may be tempted to use `conda` instead. This is not advised. The packages distributed on the Anaconda cloud are unofficial, are not posted by me, and in some cases are ancient. Some tips on using `pip` in a `conda` environment may be found [here](https://www.anaconda.com/using-pip-in-a-conda-environment/). 362 | 363 | 4: The disabling modifier "!" is used instead of "-" because [pandoc drops minus signs] in front of references. 364 | 365 | [pandoc drops minus signs]: https://github.com/jgm/pandoc/issues/2901 366 | -------------------------------------------------------------------------------- /demos/Makefile: -------------------------------------------------------------------------------- 1 | 2 | extensions = .pdf .html .epub .tex .docx 3 | 4 | dest = $(addprefix out/demo,$(extensions)) \ 5 | $(addprefix out/demo2,$(extensions)) \ 6 | $(addprefix out/demo3,$(extensions)) 7 | 8 | 9 | all: $(dest) 10 | 11 | 12 | $(filter out/demo.%,$(dest)): demo.md 13 | $(filter out/demo2.%,$(dest)): demo2.md 14 | $(filter out/demo3.%,$(dest)): demo3.md 15 | 16 | 17 | out/%.pdf: %.md 18 | @if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi 19 | pandoc $< --filter pandoc-eqnos --variable urlcolor=blue -o $@ 20 | 21 | out/%.html: %.md headers/header.html 22 | @if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi 23 | cp katex/katex* out 24 | pandoc $< --filter pandoc-eqnos --include-in-header=headers/header.html --katex="" -o $@ 25 | 26 | out/%.epub: %.md 27 | @if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi 28 | pandoc $< -t epub3 --filter pandoc-eqnos --include-in-header=headers/header.html -o $@ 29 | 30 | out/%: 31 | @if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi 32 | pandoc $^ --filter pandoc-eqnos -o $@ 33 | 34 | 35 | restore: clean 36 | for num in "" 2 3 ; do \ 37 | for ext in $(extensions) ; do \ 38 | git checkout out/demo$$num$$ext ; \ 39 | done ; \ 40 | done 41 | 42 | 43 | .PHONY: clean 44 | 45 | clean: 46 | rm -rf out 47 | -------------------------------------------------------------------------------- /demos/demo.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Pandoc-eqnos Demo 3 | ... 4 | 5 | The equation for a straight line is 6 | $$ y = mx + b $$ {#eq:line} 7 | and the equation for a polynomial is 8 | $$ y = \sum_{n=0}^{\infty} a_n x^n $$ {#eq:polynomial} 9 | 10 | Equation @eq:line and eq. @eq:polynomial are known to all first-year math students. 11 | 12 | The Fourier series is a little more advanced: 13 | $$ y = \frac{1}{2}a_0 + \sum_{n=1}^{\infty}a_n\cos(nx) 14 | + \sum_{n=1}^{\infty}b_n\cos(nx) 15 | $$ {#eq:fourier} 16 | 17 | Equations {@eq:line}--{@eq:fourier} are used throughout science and engineering. 18 | 19 | Equations can be left unnumbered if we do not need to refer to them: 20 | $$ y = A e^{-\gamma t}\cos(2\pi f t) $$ 21 | 22 | It is also possible to number equations generically without planning to refer to them; e.g.: 23 | $$ \pi = 3.141592653589793238462643 \ldots $$ {#eq:} 24 | -------------------------------------------------------------------------------- /demos/demo2.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Pandoc-eqnos Demo 3 | ... 4 | 5 | The equation for a straight line is 6 | $$ y = mx + b $$ {#eq:line} 7 | and the equation for a polynomial is 8 | $$ y = \sum_{n=0}^{\infty} a_n x^n $$ {#eq:polynomial} 9 | 10 | *@eq:line and +@eq:polynomial are known to all first-year math students. 11 | 12 | The Fourier series is a little more advanced: 13 | $$ y = \frac{1}{2}a_0 + \sum_{n=1}^{\infty}a_n\cos(nx) 14 | + \sum_{n=1}^{\infty}b_n\cos(nx) 15 | $$ {#eq:fourier} 16 | 17 | Equations {@eq:line}--{@eq:fourier} are used throughout science and engineering. 18 | 19 | Equations can be left unnumbered if we do not need to refer to them: 20 | $$ y = A e^{-\gamma t}\cos(2\pi f t) $$ 21 | 22 | It is also possible to number equations generically without planning to refer to them; e.g.: 23 | $$ \pi = 3.141592653589793238462643 \ldots $$ {#eq:} 24 | -------------------------------------------------------------------------------- /demos/demo3.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Pandoc-eqnos Demo 3 | eqnos-cleveref: True 4 | eqnos-plus-name: Eq. 5 | ... 6 | 7 | The equation for a straight line is 8 | $$ y = mx + b $$ {#eq:line} 9 | and the equation for a polynomial is 10 | $$ y = \sum_{n=0}^{\infty} a_n x^n $$ {#eq:polynomial} 11 | 12 | *@eq:line and @eq:polynomial are known to all first-year math students. 13 | 14 | The Fourier series is a little more advanced: 15 | 16 | $$ y = \frac{1}{2}a_0 + \sum_{n=1}^{\infty}a_n\cos(nx) 17 | + \sum_{n=1}^{\infty}b_n\cos(nx) 18 | $$ {#eq:fourier} 19 | 20 | Equations {!@eq:line}--{!@eq:fourier} are used throughout science and engineering. 21 | 22 | Equations can be left unnumbered if we do not need to refer to them: 23 | $$ y = A e^{-\gamma t}\cos(2\pi f t) $$ 24 | 25 | It is also possible to number equations generically without planning to refer to them; e.g.: 26 | $$ \pi = 3.141592653589793238462643 \ldots $$ {#eq:} 27 | -------------------------------------------------------------------------------- /demos/headers/header.html: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /demos/katex/katex.min.css: -------------------------------------------------------------------------------- 1 | @font-face{font-family:KaTeX_AMS;src:url(fonts/KaTeX_AMS-Regular.woff2) format("woff2"),url(fonts/KaTeX_AMS-Regular.woff) format("woff"),url(fonts/KaTeX_AMS-Regular.ttf) format("truetype");font-weight:400;font-style:normal}@font-face{font-family:KaTeX_Caligraphic;src:url(fonts/KaTeX_Caligraphic-Bold.woff2) format("woff2"),url(fonts/KaTeX_Caligraphic-Bold.woff) format("woff"),url(fonts/KaTeX_Caligraphic-Bold.ttf) format("truetype");font-weight:700;font-style:normal}@font-face{font-family:KaTeX_Caligraphic;src:url(fonts/KaTeX_Caligraphic-Regular.woff2) format("woff2"),url(fonts/KaTeX_Caligraphic-Regular.woff) format("woff"),url(fonts/KaTeX_Caligraphic-Regular.ttf) format("truetype");font-weight:400;font-style:normal}@font-face{font-family:KaTeX_Fraktur;src:url(fonts/KaTeX_Fraktur-Bold.woff2) format("woff2"),url(fonts/KaTeX_Fraktur-Bold.woff) format("woff"),url(fonts/KaTeX_Fraktur-Bold.ttf) format("truetype");font-weight:700;font-style:normal}@font-face{font-family:KaTeX_Fraktur;src:url(fonts/KaTeX_Fraktur-Regular.woff2) format("woff2"),url(fonts/KaTeX_Fraktur-Regular.woff) format("woff"),url(fonts/KaTeX_Fraktur-Regular.ttf) format("truetype");font-weight:400;font-style:normal}@font-face{font-family:KaTeX_Main;src:url(fonts/KaTeX_Main-Bold.woff2) format("woff2"),url(fonts/KaTeX_Main-Bold.woff) format("woff"),url(fonts/KaTeX_Main-Bold.ttf) format("truetype");font-weight:700;font-style:normal}@font-face{font-family:KaTeX_Main;src:url(fonts/KaTeX_Main-BoldItalic.woff2) format("woff2"),url(fonts/KaTeX_Main-BoldItalic.woff) format("woff"),url(fonts/KaTeX_Main-BoldItalic.ttf) format("truetype");font-weight:700;font-style:italic}@font-face{font-family:KaTeX_Main;src:url(fonts/KaTeX_Main-Italic.woff2) format("woff2"),url(fonts/KaTeX_Main-Italic.woff) format("woff"),url(fonts/KaTeX_Main-Italic.ttf) format("truetype");font-weight:400;font-style:italic}@font-face{font-family:KaTeX_Main;src:url(fonts/KaTeX_Main-Regular.woff2) format("woff2"),url(fonts/KaTeX_Main-Regular.woff) format("woff"),url(fonts/KaTeX_Main-Regular.ttf) format("truetype");font-weight:400;font-style:normal}@font-face{font-family:KaTeX_Math;src:url(fonts/KaTeX_Math-BoldItalic.woff2) format("woff2"),url(fonts/KaTeX_Math-BoldItalic.woff) format("woff"),url(fonts/KaTeX_Math-BoldItalic.ttf) format("truetype");font-weight:700;font-style:italic}@font-face{font-family:KaTeX_Math;src:url(fonts/KaTeX_Math-Italic.woff2) format("woff2"),url(fonts/KaTeX_Math-Italic.woff) format("woff"),url(fonts/KaTeX_Math-Italic.ttf) format("truetype");font-weight:400;font-style:italic}@font-face{font-family:"KaTeX_SansSerif";src:url(fonts/KaTeX_SansSerif-Bold.woff2) format("woff2"),url(fonts/KaTeX_SansSerif-Bold.woff) format("woff"),url(fonts/KaTeX_SansSerif-Bold.ttf) format("truetype");font-weight:700;font-style:normal}@font-face{font-family:"KaTeX_SansSerif";src:url(fonts/KaTeX_SansSerif-Italic.woff2) format("woff2"),url(fonts/KaTeX_SansSerif-Italic.woff) format("woff"),url(fonts/KaTeX_SansSerif-Italic.ttf) format("truetype");font-weight:400;font-style:italic}@font-face{font-family:"KaTeX_SansSerif";src:url(fonts/KaTeX_SansSerif-Regular.woff2) format("woff2"),url(fonts/KaTeX_SansSerif-Regular.woff) format("woff"),url(fonts/KaTeX_SansSerif-Regular.ttf) format("truetype");font-weight:400;font-style:normal}@font-face{font-family:KaTeX_Script;src:url(fonts/KaTeX_Script-Regular.woff2) format("woff2"),url(fonts/KaTeX_Script-Regular.woff) format("woff"),url(fonts/KaTeX_Script-Regular.ttf) format("truetype");font-weight:400;font-style:normal}@font-face{font-family:KaTeX_Size1;src:url(fonts/KaTeX_Size1-Regular.woff2) format("woff2"),url(fonts/KaTeX_Size1-Regular.woff) format("woff"),url(fonts/KaTeX_Size1-Regular.ttf) format("truetype");font-weight:400;font-style:normal}@font-face{font-family:KaTeX_Size2;src:url(fonts/KaTeX_Size2-Regular.woff2) format("woff2"),url(fonts/KaTeX_Size2-Regular.woff) format("woff"),url(fonts/KaTeX_Size2-Regular.ttf) format("truetype");font-weight:400;font-style:normal}@font-face{font-family:KaTeX_Size3;src:url(fonts/KaTeX_Size3-Regular.woff2) format("woff2"),url(fonts/KaTeX_Size3-Regular.woff) format("woff"),url(fonts/KaTeX_Size3-Regular.ttf) format("truetype");font-weight:400;font-style:normal}@font-face{font-family:KaTeX_Size4;src:url(fonts/KaTeX_Size4-Regular.woff2) format("woff2"),url(fonts/KaTeX_Size4-Regular.woff) format("woff"),url(fonts/KaTeX_Size4-Regular.ttf) format("truetype");font-weight:400;font-style:normal}@font-face{font-family:KaTeX_Typewriter;src:url(fonts/KaTeX_Typewriter-Regular.woff2) format("woff2"),url(fonts/KaTeX_Typewriter-Regular.woff) format("woff"),url(fonts/KaTeX_Typewriter-Regular.ttf) format("truetype");font-weight:400;font-style:normal}.katex{font:normal 1.21em KaTeX_Main,Times New Roman,serif;line-height:1.2;text-indent:0;text-rendering:auto}.katex *{-ms-high-contrast-adjust:none!important}.katex .katex-version:after{content:"0.10.2"}.katex .katex-mathml{position:absolute;clip:rect(1px,1px,1px,1px);padding:0;border:0;height:1px;width:1px;overflow:hidden}.katex .katex-html>.newline{display:block}.katex .base{position:relative;white-space:nowrap;width:min-content}.katex .base,.katex .strut{display:inline-block}.katex .textbf{font-weight:700}.katex .textit{font-style:italic}.katex .textrm{font-family:KaTeX_Main}.katex .textsf{font-family:KaTeX_SansSerif}.katex .texttt{font-family:KaTeX_Typewriter}.katex .mathdefault{font-family:KaTeX_Math;font-style:italic}.katex .mathit{font-family:KaTeX_Main;font-style:italic}.katex .mathrm{font-style:normal}.katex .mathbf{font-family:KaTeX_Main;font-weight:700}.katex .boldsymbol{font-family:KaTeX_Math;font-weight:700;font-style:italic}.katex .amsrm,.katex .mathbb,.katex .textbb{font-family:KaTeX_AMS}.katex .mathcal{font-family:KaTeX_Caligraphic}.katex .mathfrak,.katex .textfrak{font-family:KaTeX_Fraktur}.katex .mathtt{font-family:KaTeX_Typewriter}.katex .mathscr,.katex .textscr{font-family:KaTeX_Script}.katex .mathsf,.katex .textsf{font-family:KaTeX_SansSerif}.katex .mathboldsf,.katex .textboldsf{font-family:KaTeX_SansSerif;font-weight:700}.katex .mathitsf,.katex .textitsf{font-family:KaTeX_SansSerif;font-style:italic}.katex .mainrm{font-family:KaTeX_Main;font-style:normal}.katex .vlist-t{display:inline-table;table-layout:fixed}.katex .vlist-r{display:table-row}.katex .vlist{display:table-cell;vertical-align:bottom;position:relative}.katex .vlist>span{display:block;height:0;position:relative}.katex .vlist>span>span{display:inline-block}.katex .vlist>span>.pstrut{overflow:hidden;width:0}.katex .vlist-t2{margin-right:-2px}.katex .vlist-s{display:table-cell;vertical-align:bottom;font-size:1px;width:2px;min-width:2px}.katex .msupsub{text-align:left}.katex .mfrac>span>span{text-align:center}.katex .mfrac .frac-line{display:inline-block;width:100%;border-bottom-style:solid}.katex .hdashline,.katex .hline,.katex .mfrac .frac-line,.katex .overline .overline-line,.katex .rule,.katex .underline .underline-line{min-height:1px}.katex .mspace{display:inline-block}.katex .clap,.katex .llap,.katex .rlap{width:0;position:relative}.katex .clap>.inner,.katex .llap>.inner,.katex .rlap>.inner{position:absolute}.katex .clap>.fix,.katex .llap>.fix,.katex .rlap>.fix{display:inline-block}.katex .llap>.inner{right:0}.katex .clap>.inner,.katex .rlap>.inner{left:0}.katex .clap>.inner>span{margin-left:-50%;margin-right:50%}.katex .rule{display:inline-block;border:0 solid;position:relative}.katex .hline,.katex .overline .overline-line,.katex .underline .underline-line{display:inline-block;width:100%;border-bottom-style:solid}.katex .hdashline{display:inline-block;width:100%;border-bottom-style:dashed}.katex .sqrt>.root{margin-left:.27777778em;margin-right:-.55555556em}.katex .fontsize-ensurer,.katex .sizing{display:inline-block}.katex .fontsize-ensurer.reset-size1.size1,.katex .sizing.reset-size1.size1{font-size:1em}.katex .fontsize-ensurer.reset-size1.size2,.katex .sizing.reset-size1.size2{font-size:1.2em}.katex .fontsize-ensurer.reset-size1.size3,.katex .sizing.reset-size1.size3{font-size:1.4em}.katex .fontsize-ensurer.reset-size1.size4,.katex .sizing.reset-size1.size4{font-size:1.6em}.katex .fontsize-ensurer.reset-size1.size5,.katex .sizing.reset-size1.size5{font-size:1.8em}.katex .fontsize-ensurer.reset-size1.size6,.katex .sizing.reset-size1.size6{font-size:2em}.katex .fontsize-ensurer.reset-size1.size7,.katex .sizing.reset-size1.size7{font-size:2.4em}.katex .fontsize-ensurer.reset-size1.size8,.katex .sizing.reset-size1.size8{font-size:2.88em}.katex .fontsize-ensurer.reset-size1.size9,.katex .sizing.reset-size1.size9{font-size:3.456em}.katex .fontsize-ensurer.reset-size1.size10,.katex .sizing.reset-size1.size10{font-size:4.148em}.katex .fontsize-ensurer.reset-size1.size11,.katex .sizing.reset-size1.size11{font-size:4.976em}.katex .fontsize-ensurer.reset-size2.size1,.katex .sizing.reset-size2.size1{font-size:.83333333em}.katex .fontsize-ensurer.reset-size2.size2,.katex .sizing.reset-size2.size2{font-size:1em}.katex .fontsize-ensurer.reset-size2.size3,.katex .sizing.reset-size2.size3{font-size:1.16666667em}.katex .fontsize-ensurer.reset-size2.size4,.katex .sizing.reset-size2.size4{font-size:1.33333333em}.katex .fontsize-ensurer.reset-size2.size5,.katex .sizing.reset-size2.size5{font-size:1.5em}.katex .fontsize-ensurer.reset-size2.size6,.katex .sizing.reset-size2.size6{font-size:1.66666667em}.katex .fontsize-ensurer.reset-size2.size7,.katex .sizing.reset-size2.size7{font-size:2em}.katex .fontsize-ensurer.reset-size2.size8,.katex .sizing.reset-size2.size8{font-size:2.4em}.katex .fontsize-ensurer.reset-size2.size9,.katex .sizing.reset-size2.size9{font-size:2.88em}.katex .fontsize-ensurer.reset-size2.size10,.katex .sizing.reset-size2.size10{font-size:3.45666667em}.katex .fontsize-ensurer.reset-size2.size11,.katex .sizing.reset-size2.size11{font-size:4.14666667em}.katex .fontsize-ensurer.reset-size3.size1,.katex .sizing.reset-size3.size1{font-size:.71428571em}.katex .fontsize-ensurer.reset-size3.size2,.katex .sizing.reset-size3.size2{font-size:.85714286em}.katex .fontsize-ensurer.reset-size3.size3,.katex .sizing.reset-size3.size3{font-size:1em}.katex .fontsize-ensurer.reset-size3.size4,.katex .sizing.reset-size3.size4{font-size:1.14285714em}.katex .fontsize-ensurer.reset-size3.size5,.katex .sizing.reset-size3.size5{font-size:1.28571429em}.katex .fontsize-ensurer.reset-size3.size6,.katex .sizing.reset-size3.size6{font-size:1.42857143em}.katex .fontsize-ensurer.reset-size3.size7,.katex .sizing.reset-size3.size7{font-size:1.71428571em}.katex .fontsize-ensurer.reset-size3.size8,.katex .sizing.reset-size3.size8{font-size:2.05714286em}.katex .fontsize-ensurer.reset-size3.size9,.katex .sizing.reset-size3.size9{font-size:2.46857143em}.katex .fontsize-ensurer.reset-size3.size10,.katex .sizing.reset-size3.size10{font-size:2.96285714em}.katex .fontsize-ensurer.reset-size3.size11,.katex .sizing.reset-size3.size11{font-size:3.55428571em}.katex .fontsize-ensurer.reset-size4.size1,.katex .sizing.reset-size4.size1{font-size:.625em}.katex .fontsize-ensurer.reset-size4.size2,.katex .sizing.reset-size4.size2{font-size:.75em}.katex .fontsize-ensurer.reset-size4.size3,.katex .sizing.reset-size4.size3{font-size:.875em}.katex .fontsize-ensurer.reset-size4.size4,.katex .sizing.reset-size4.size4{font-size:1em}.katex .fontsize-ensurer.reset-size4.size5,.katex .sizing.reset-size4.size5{font-size:1.125em}.katex .fontsize-ensurer.reset-size4.size6,.katex .sizing.reset-size4.size6{font-size:1.25em}.katex .fontsize-ensurer.reset-size4.size7,.katex .sizing.reset-size4.size7{font-size:1.5em}.katex .fontsize-ensurer.reset-size4.size8,.katex .sizing.reset-size4.size8{font-size:1.8em}.katex .fontsize-ensurer.reset-size4.size9,.katex .sizing.reset-size4.size9{font-size:2.16em}.katex .fontsize-ensurer.reset-size4.size10,.katex .sizing.reset-size4.size10{font-size:2.5925em}.katex .fontsize-ensurer.reset-size4.size11,.katex .sizing.reset-size4.size11{font-size:3.11em}.katex .fontsize-ensurer.reset-size5.size1,.katex .sizing.reset-size5.size1{font-size:.55555556em}.katex .fontsize-ensurer.reset-size5.size2,.katex .sizing.reset-size5.size2{font-size:.66666667em}.katex .fontsize-ensurer.reset-size5.size3,.katex .sizing.reset-size5.size3{font-size:.77777778em}.katex .fontsize-ensurer.reset-size5.size4,.katex .sizing.reset-size5.size4{font-size:.88888889em}.katex .fontsize-ensurer.reset-size5.size5,.katex .sizing.reset-size5.size5{font-size:1em}.katex .fontsize-ensurer.reset-size5.size6,.katex .sizing.reset-size5.size6{font-size:1.11111111em}.katex .fontsize-ensurer.reset-size5.size7,.katex .sizing.reset-size5.size7{font-size:1.33333333em}.katex .fontsize-ensurer.reset-size5.size8,.katex .sizing.reset-size5.size8{font-size:1.6em}.katex .fontsize-ensurer.reset-size5.size9,.katex .sizing.reset-size5.size9{font-size:1.92em}.katex .fontsize-ensurer.reset-size5.size10,.katex .sizing.reset-size5.size10{font-size:2.30444444em}.katex .fontsize-ensurer.reset-size5.size11,.katex .sizing.reset-size5.size11{font-size:2.76444444em}.katex .fontsize-ensurer.reset-size6.size1,.katex .sizing.reset-size6.size1{font-size:.5em}.katex .fontsize-ensurer.reset-size6.size2,.katex .sizing.reset-size6.size2{font-size:.6em}.katex .fontsize-ensurer.reset-size6.size3,.katex .sizing.reset-size6.size3{font-size:.7em}.katex .fontsize-ensurer.reset-size6.size4,.katex .sizing.reset-size6.size4{font-size:.8em}.katex .fontsize-ensurer.reset-size6.size5,.katex .sizing.reset-size6.size5{font-size:.9em}.katex .fontsize-ensurer.reset-size6.size6,.katex .sizing.reset-size6.size6{font-size:1em}.katex .fontsize-ensurer.reset-size6.size7,.katex .sizing.reset-size6.size7{font-size:1.2em}.katex .fontsize-ensurer.reset-size6.size8,.katex .sizing.reset-size6.size8{font-size:1.44em}.katex .fontsize-ensurer.reset-size6.size9,.katex .sizing.reset-size6.size9{font-size:1.728em}.katex .fontsize-ensurer.reset-size6.size10,.katex .sizing.reset-size6.size10{font-size:2.074em}.katex .fontsize-ensurer.reset-size6.size11,.katex .sizing.reset-size6.size11{font-size:2.488em}.katex .fontsize-ensurer.reset-size7.size1,.katex .sizing.reset-size7.size1{font-size:.41666667em}.katex .fontsize-ensurer.reset-size7.size2,.katex .sizing.reset-size7.size2{font-size:.5em}.katex .fontsize-ensurer.reset-size7.size3,.katex .sizing.reset-size7.size3{font-size:.58333333em}.katex .fontsize-ensurer.reset-size7.size4,.katex .sizing.reset-size7.size4{font-size:.66666667em}.katex .fontsize-ensurer.reset-size7.size5,.katex .sizing.reset-size7.size5{font-size:.75em}.katex .fontsize-ensurer.reset-size7.size6,.katex .sizing.reset-size7.size6{font-size:.83333333em}.katex .fontsize-ensurer.reset-size7.size7,.katex .sizing.reset-size7.size7{font-size:1em}.katex .fontsize-ensurer.reset-size7.size8,.katex .sizing.reset-size7.size8{font-size:1.2em}.katex .fontsize-ensurer.reset-size7.size9,.katex .sizing.reset-size7.size9{font-size:1.44em}.katex .fontsize-ensurer.reset-size7.size10,.katex .sizing.reset-size7.size10{font-size:1.72833333em}.katex .fontsize-ensurer.reset-size7.size11,.katex .sizing.reset-size7.size11{font-size:2.07333333em}.katex .fontsize-ensurer.reset-size8.size1,.katex .sizing.reset-size8.size1{font-size:.34722222em}.katex .fontsize-ensurer.reset-size8.size2,.katex .sizing.reset-size8.size2{font-size:.41666667em}.katex .fontsize-ensurer.reset-size8.size3,.katex .sizing.reset-size8.size3{font-size:.48611111em}.katex .fontsize-ensurer.reset-size8.size4,.katex .sizing.reset-size8.size4{font-size:.55555556em}.katex .fontsize-ensurer.reset-size8.size5,.katex .sizing.reset-size8.size5{font-size:.625em}.katex .fontsize-ensurer.reset-size8.size6,.katex .sizing.reset-size8.size6{font-size:.69444444em}.katex .fontsize-ensurer.reset-size8.size7,.katex .sizing.reset-size8.size7{font-size:.83333333em}.katex .fontsize-ensurer.reset-size8.size8,.katex .sizing.reset-size8.size8{font-size:1em}.katex .fontsize-ensurer.reset-size8.size9,.katex .sizing.reset-size8.size9{font-size:1.2em}.katex .fontsize-ensurer.reset-size8.size10,.katex .sizing.reset-size8.size10{font-size:1.44027778em}.katex .fontsize-ensurer.reset-size8.size11,.katex .sizing.reset-size8.size11{font-size:1.72777778em}.katex .fontsize-ensurer.reset-size9.size1,.katex .sizing.reset-size9.size1{font-size:.28935185em}.katex .fontsize-ensurer.reset-size9.size2,.katex .sizing.reset-size9.size2{font-size:.34722222em}.katex .fontsize-ensurer.reset-size9.size3,.katex .sizing.reset-size9.size3{font-size:.40509259em}.katex .fontsize-ensurer.reset-size9.size4,.katex .sizing.reset-size9.size4{font-size:.46296296em}.katex .fontsize-ensurer.reset-size9.size5,.katex .sizing.reset-size9.size5{font-size:.52083333em}.katex .fontsize-ensurer.reset-size9.size6,.katex .sizing.reset-size9.size6{font-size:.5787037em}.katex .fontsize-ensurer.reset-size9.size7,.katex .sizing.reset-size9.size7{font-size:.69444444em}.katex .fontsize-ensurer.reset-size9.size8,.katex .sizing.reset-size9.size8{font-size:.83333333em}.katex .fontsize-ensurer.reset-size9.size9,.katex .sizing.reset-size9.size9{font-size:1em}.katex .fontsize-ensurer.reset-size9.size10,.katex .sizing.reset-size9.size10{font-size:1.20023148em}.katex .fontsize-ensurer.reset-size9.size11,.katex .sizing.reset-size9.size11{font-size:1.43981481em}.katex .fontsize-ensurer.reset-size10.size1,.katex .sizing.reset-size10.size1{font-size:.24108004em}.katex .fontsize-ensurer.reset-size10.size2,.katex .sizing.reset-size10.size2{font-size:.28929605em}.katex .fontsize-ensurer.reset-size10.size3,.katex .sizing.reset-size10.size3{font-size:.33751205em}.katex .fontsize-ensurer.reset-size10.size4,.katex .sizing.reset-size10.size4{font-size:.38572806em}.katex .fontsize-ensurer.reset-size10.size5,.katex .sizing.reset-size10.size5{font-size:.43394407em}.katex .fontsize-ensurer.reset-size10.size6,.katex .sizing.reset-size10.size6{font-size:.48216008em}.katex .fontsize-ensurer.reset-size10.size7,.katex .sizing.reset-size10.size7{font-size:.57859209em}.katex .fontsize-ensurer.reset-size10.size8,.katex .sizing.reset-size10.size8{font-size:.69431051em}.katex .fontsize-ensurer.reset-size10.size9,.katex .sizing.reset-size10.size9{font-size:.83317261em}.katex .fontsize-ensurer.reset-size10.size10,.katex .sizing.reset-size10.size10{font-size:1em}.katex .fontsize-ensurer.reset-size10.size11,.katex .sizing.reset-size10.size11{font-size:1.19961427em}.katex .fontsize-ensurer.reset-size11.size1,.katex .sizing.reset-size11.size1{font-size:.20096463em}.katex .fontsize-ensurer.reset-size11.size2,.katex .sizing.reset-size11.size2{font-size:.24115756em}.katex .fontsize-ensurer.reset-size11.size3,.katex .sizing.reset-size11.size3{font-size:.28135048em}.katex .fontsize-ensurer.reset-size11.size4,.katex .sizing.reset-size11.size4{font-size:.32154341em}.katex .fontsize-ensurer.reset-size11.size5,.katex .sizing.reset-size11.size5{font-size:.36173633em}.katex .fontsize-ensurer.reset-size11.size6,.katex .sizing.reset-size11.size6{font-size:.40192926em}.katex .fontsize-ensurer.reset-size11.size7,.katex .sizing.reset-size11.size7{font-size:.48231511em}.katex .fontsize-ensurer.reset-size11.size8,.katex .sizing.reset-size11.size8{font-size:.57877814em}.katex .fontsize-ensurer.reset-size11.size9,.katex .sizing.reset-size11.size9{font-size:.69453376em}.katex .fontsize-ensurer.reset-size11.size10,.katex .sizing.reset-size11.size10{font-size:.83360129em}.katex .fontsize-ensurer.reset-size11.size11,.katex .sizing.reset-size11.size11{font-size:1em}.katex .delimsizing.size1{font-family:KaTeX_Size1}.katex .delimsizing.size2{font-family:KaTeX_Size2}.katex .delimsizing.size3{font-family:KaTeX_Size3}.katex .delimsizing.size4{font-family:KaTeX_Size4}.katex .delimsizing.mult .delim-size1>span{font-family:KaTeX_Size1}.katex .delimsizing.mult .delim-size4>span{font-family:KaTeX_Size4}.katex .nulldelimiter{display:inline-block;width:.12em}.katex .delimcenter,.katex .op-symbol{position:relative}.katex .op-symbol.small-op{font-family:KaTeX_Size1}.katex .op-symbol.large-op{font-family:KaTeX_Size2}.katex .op-limits>.vlist-t{text-align:center}.katex .accent>.vlist-t{text-align:center}.katex .accent .accent-body{position:relative}.katex .accent .accent-body:not(.accent-full){width:0}.katex .overlay{display:block}.katex .mtable .vertical-separator{display:inline-block;margin:0 -.025em;border-right:.05em solid;min-width:1px}.katex .mtable .vs-dashed{border-right:.05em dashed}.katex .mtable .arraycolsep{display:inline-block}.katex .mtable .col-align-c>.vlist-t{text-align:center}.katex .mtable .col-align-l>.vlist-t{text-align:left}.katex .mtable .col-align-r>.vlist-t{text-align:right}.katex .svg-align{text-align:left}.katex svg{display:block;position:absolute;width:100%;height:inherit;fill:currentColor;stroke:currentColor;fill-rule:nonzero;fill-opacity:1;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1}.katex svg path{stroke:none}.katex img{border-style:none;min-width:0;min-height:0;max-width:none;max-height:none}.katex .stretchy{width:100%;display:block;position:relative;overflow:hidden}.katex .stretchy:after,.katex .stretchy:before{content:""}.katex .hide-tail{width:100%;position:relative;overflow:hidden}.katex .halfarrow-left{position:absolute;left:0;width:50.2%;overflow:hidden}.katex .halfarrow-right{position:absolute;right:0;width:50.2%;overflow:hidden}.katex .brace-left{position:absolute;left:0;width:25.1%;overflow:hidden}.katex .brace-center{position:absolute;left:25%;width:50%;overflow:hidden}.katex .brace-right{position:absolute;right:0;width:25.1%;overflow:hidden}.katex .x-arrow-pad{padding:0 .5em}.katex .mover,.katex .munder,.katex .x-arrow{text-align:center}.katex .boxpad{padding:0 .3em}.katex .fbox,.katex .fcolorbox{box-sizing:border-box;border:.04em solid}.katex .cancel-pad{padding:0 .2em}.katex .cancel-lap{margin-left:-.2em;margin-right:-.2em}.katex .sout{border-bottom-style:solid;border-bottom-width:.08em}.katex-display{display:block;margin:1em 0;text-align:center}.katex-display>.katex{display:block;text-align:center;white-space:nowrap}.katex-display>.katex>.katex-html{display:block;position:relative}.katex-display>.katex>.katex-html>.tag{position:absolute;right:0}.katex-display.leqno>.katex>.katex-html>.tag{left:0;right:auto}.katex-display.fleqn>.katex{text-align:left} 2 | -------------------------------------------------------------------------------- /pandoc_eqnos.py: -------------------------------------------------------------------------------- 1 | #! /usr/bin/env python 2 | 3 | """pandoc-eqnos: a pandoc filter that inserts equation nos. and refs.""" 4 | 5 | 6 | __version__ = '2.5.0' 7 | 8 | 9 | # Copyright 2015-2020 Thomas J. Duck. 10 | # All rights reserved. 11 | # 12 | # This program is free software: you can redistribute it and/or modify 13 | # it under the terms of the GNU General Public License as published by 14 | # the Free Software Foundation, version 3. 15 | # 16 | # This program is distributed in the hope that it will be useful, 17 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 | # GNU General Public License for more details. 20 | # 21 | # You should have received a copy of the GNU General Public License 22 | # along with this program. If not, see . 23 | 24 | 25 | # OVERVIEW 26 | # 27 | # The basic idea is to scan the document twice in order to: 28 | # 29 | # 1. Insert text for the equation number in each equation. 30 | # For LaTeX, change to a numbered equation and use \label{...} 31 | # instead. The equation labels and associated equation numbers 32 | # are stored in the global targets tracker. 33 | # 34 | # 2. Replace each reference with an equation number. For LaTeX, 35 | # replace with \ref{...} instead. 36 | # 37 | # This is followed by injecting header code as needed for certain output 38 | # formats. 39 | 40 | # pylint: disable=invalid-name 41 | 42 | import re 43 | import functools 44 | import argparse 45 | import json 46 | import copy 47 | import textwrap 48 | import uuid 49 | 50 | from pandocfilters import walk 51 | from pandocfilters import Math, RawInline, Str, Span 52 | 53 | import pandocxnos 54 | from pandocxnos import PandocAttributes 55 | from pandocxnos import STRTYPES, STDIN, STDOUT, STDERR 56 | from pandocxnos import elt, check_bool, get_meta 57 | from pandocxnos import repair_refs, process_refs_factory, replace_refs_factory 58 | from pandocxnos import attach_attrs_factory, detach_attrs_factory 59 | from pandocxnos import insert_secnos_factory, delete_secnos_factory 60 | from pandocxnos import version 61 | 62 | # Patterns for matching labels and references 63 | LABEL_PATTERN = re.compile(r'(eq:[\w/-]*)') 64 | 65 | # Meta variables; may be reset elsewhere 66 | cleveref = False # Flags that clever references should be used 67 | capitalise = False # Flags that plusname should be capitalised 68 | plusname = ['eq.', 'eqs.'] # Sets names for mid-sentence references 69 | starname = ['Equation', 'Equations'] # Sets names for refs at sentence start 70 | numbersections = False # Flags that equations should be numbered by section 71 | secoffset = 0 # Section number offset 72 | eqref = False # Flags that \eqref should be used 73 | warninglevel = 2 # 0 - no warnings; 1 - some warnings; 2 - all warnings 74 | default_env = 'equation' 75 | 76 | # Processing state variables 77 | cursec = None # Current section 78 | Ntargets = 0 # Number of targets in current section (or document) 79 | targets = {} # Global targets tracker 80 | 81 | # Processing flags 82 | plusname_changed = False # Flags that the plus name changed 83 | starname_changed = False # Flags that the star name changed 84 | has_unnumbered_equations = False # Flags unnumbered equations were found 85 | 86 | PANDOCVERSION = None 87 | AttrMath = None 88 | 89 | 90 | # Actions -------------------------------------------------------------------- 91 | 92 | # pylint: disable=too-many-branches 93 | def _process_equation(value, fmt): 94 | """Processes the equation. Returns a dict containing eq properties.""" 95 | 96 | # pylint: disable=global-statement 97 | global Ntargets # Global targets counter 98 | global cursec # Current section 99 | global has_unnumbered_equations # Flags that unnumbered eqs were found 100 | 101 | # Initialize the return value 102 | eq = {'is_unnumbered': False, 103 | 'is_unreferenceable': False, 104 | 'is_tagged': False} 105 | 106 | # Parse the equation 107 | attrs = eq['attrs'] = PandocAttributes(value[0], 'pandoc') 108 | 109 | # Bail out if the label does not conform to expectations 110 | if not LABEL_PATTERN.match(attrs.id): 111 | eq.update({'is_unnumbered':True, 'is_unreferenceable':True}) 112 | return eq 113 | 114 | # Identify unreferenceable equations 115 | if attrs.id == 'eq:': # Make up a unique description 116 | attrs.id += str(uuid.uuid4()) 117 | eq['is_unreferenceable'] = True 118 | 119 | # Update the current section number 120 | if attrs['secno'] != cursec: # The section number changed 121 | cursec = attrs['secno'] # Update the global section tracker 122 | if numbersections: 123 | Ntargets = 0 # Resets the global targets counter 124 | 125 | # Increment the targets counter 126 | if 'tag' not in attrs: 127 | Ntargets += 1 128 | 129 | # Pandoc's --number-sections supports section numbering latex/pdf, html, 130 | # epub, and docx 131 | if numbersections: 132 | # Latex/pdf supports equation numbers by section natively. For the 133 | # other formats we must hard-code in equation numbers by section as 134 | # tags. 135 | if fmt in ['html', 'html4', 'html5', 'epub', 'epub2', 'epub3', 'docx'] and \ 136 | 'tag' not in attrs: 137 | attrs['tag'] = str(cursec+secoffset) + '.' + str(Ntargets) 138 | 139 | # Save reference information 140 | eq['is_tagged'] = 'tag' in attrs 141 | if eq['is_tagged']: # ... then save the tag 142 | # Remove any surrounding quotes 143 | if attrs['tag'][0] == '"' and attrs['tag'][-1] == '"': 144 | attrs['tag'] = attrs['tag'].strip('"') 145 | elif attrs['tag'][0] == "'" and attrs['tag'][-1] == "'": 146 | attrs['tag'] = attrs['tag'].strip("'") 147 | targets[attrs.id] = pandocxnos.Target(attrs['tag'], cursec, 148 | attrs.id in targets) 149 | else: 150 | targets[attrs.id] = pandocxnos.Target(Ntargets, cursec, 151 | attrs.id in targets) 152 | 153 | return eq 154 | 155 | 156 | def _adjust_equation(fmt, eq, value): 157 | """Adjusts the equation depending on the output format.""" 158 | attrs = eq['attrs'] 159 | num = targets[attrs.id].num 160 | 161 | if fmt in ['latex', 'beamer']: 162 | if not eq['is_unreferenceable']: # Code in the tags 163 | if eq['is_tagged']: 164 | value[-1] += r'\tag{%s}\label{%s}' % \ 165 | (num.replace(' ', r'\ '), attrs.id) 166 | else: 167 | value[-1] += r'\label{%s}'%attrs.id 168 | elif fmt in ('html', 'html4', 'html5', 'epub', 'epub2', 'epub3'): 169 | pass # Insert html in _add_markup() instead 170 | else: # Hard-code in the number/tag 171 | if isinstance(num, int): # Numbered reference 172 | value[-1] += r'\qquad (%d)' % num 173 | else: # Tagged reference 174 | assert isinstance(num, STRTYPES) 175 | num = num.replace(' ', r'\ ') 176 | value[-1] += r'\qquad (%s)' % \ 177 | (num[1:-1] if num.startswith('$') and num.endswith('$') else 178 | r'\text{%s}' % num) 179 | 180 | 181 | def _add_markup(fmt, eq, value): 182 | """Adds markup to the output.""" 183 | 184 | attrs = eq['attrs'] 185 | 186 | # Context-dependent output 187 | if eq['is_unnumbered']: # Unnumbered is also unreferenceable 188 | ret = None 189 | elif fmt in ['latex', 'beamer']: 190 | if 'env' in attrs: 191 | env = attrs['env'] 192 | else: 193 | env = default_env 194 | env, _, arg = env.partition('.') 195 | ret = RawInline('tex', 196 | r'\begin{%s}%s%s\end{%s}'% \ 197 | (env, '{%s}'%arg if arg else '', value[-1], env)) 198 | elif fmt in ('html', 'html4', 'html5', 'epub', 'epub2', 'epub3') and \ 199 | LABEL_PATTERN.match(attrs.id): 200 | # Present equation and its number in a span 201 | num = str(targets[attrs.id].num) 202 | outer = RawInline('html', 203 | '' % \ 204 | (' ' if eq['is_unreferenceable'] else 205 | ' id="%s" '%attrs.id)) 206 | inner = RawInline('html', '') 207 | eqno = Math({"t":"InlineMath"}, '(%s)' % num[1:-1]) \ 208 | if num.startswith('$') and num.endswith('$') \ 209 | else Str('(%s)' % num) 210 | endtags = RawInline('html', '') 211 | ret = [outer, AttrMath(*value), inner, eqno, endtags] 212 | elif fmt == 'docx': 213 | # As per http://officeopenxml.com/WPhyperlink.php 214 | bookmarkstart = \ 215 | RawInline('openxml', 216 | '' 217 | %attrs.id) 218 | bookmarkend = \ 219 | RawInline('openxml', 220 | '') 221 | ret = [bookmarkstart, AttrMath(*value), bookmarkend] 222 | else: 223 | ret = None 224 | return ret 225 | 226 | 227 | def process_equations(key, value, fmt, meta): # pylint: disable=unused-argument 228 | """Processes the attributed equations.""" 229 | 230 | # Process attributed equations and add markup 231 | if key == 'Math' and len(value) == 3: 232 | eq = _process_equation(value, fmt) 233 | if eq['attrs'].id: 234 | _adjust_equation(fmt, eq, value) 235 | return _add_markup(fmt, eq, value) 236 | 237 | return None 238 | 239 | 240 | # TeX blocks ----------------------------------------------------------------- 241 | 242 | # Define some tex to number equations by section 243 | NUMBER_BY_SECTION_TEX = r""" 244 | %% pandoc-eqnos: number equations by section 245 | \numberwithin{equation}{section} 246 | """ 247 | 248 | # Section number offset 249 | SECOFFSET_TEX = r""" 250 | %% pandoc-eqnos: section number offset 251 | \setcounter{section}{%s} 252 | """ 253 | 254 | # Define some tex to disable brackets around cleveref numbers 255 | DISABLE_CLEVEREF_BRACKETS_TEX = r""" 256 | %% pandoc-eqnos: disable brackets around cleveref numbers 257 | \creflabelformat{equation}{#2#1#3} 258 | """ 259 | 260 | 261 | # Html blocks ---------------------------------------------------------------- 262 | 263 | # Equation css 264 | # Valid XHTML 1.0 Transitional (called html4 in pandoc) requires type="text/css" 265 | # See also https://github.com/tomduck/pandoc-eqnos/issues/50 266 | EQUATION_STYLE_HTML = """ 267 | 268 | 269 | .eqnos { display: inline-block; position: relative; width: 100%%; } 270 | .eqnos br { display: none; } 271 | .eqnos-number { position: absolute; right: 0em; top: 50%%; line-height: 0; } 272 | 273 | """ 274 | 275 | 276 | # Main program --------------------------------------------------------------- 277 | 278 | # pylint: disable=too-many-statements 279 | def process(meta): 280 | """Saves metadata fields in global variables and returns a few 281 | computed fields.""" 282 | 283 | # pylint: disable=global-statement 284 | global cleveref # Flags that clever references should be used 285 | global capitalise # Flags that plusname should be capitalised 286 | global plusname # Sets names for mid-sentence references 287 | global starname # Sets names for references at sentence start 288 | global numbersections # Flags that sections should be numbered by section 289 | global secoffset # Section number offset 290 | global warninglevel # 0 - no warnings; 1 - some; 2 - all 291 | global plusname_changed # Flags that the plus name changed 292 | global starname_changed # Flags that the star name changed 293 | global eqref # Flags that \eqref should be used 294 | global default_env # Default equations environment 295 | 296 | # Read in the metadata fields and do some checking 297 | 298 | for name in ['eqnos-warning-level', 'xnos-warning-level']: 299 | if name in meta: 300 | warninglevel = int(get_meta(meta, name)) 301 | pandocxnos.set_warning_level(warninglevel) 302 | break 303 | 304 | metanames = ['eqnos-warning-level', 'xnos-warning-level', 305 | 'eqnos-cleveref', 'xnos-cleveref', 306 | 'xnos-capitalise', 'xnos-capitalize', 307 | 'xnos-caption-separator', # Used by pandoc-fignos/tablenos 308 | 'eqnos-plus-name', 'eqnos-star-name', 309 | 'eqnos-number-by-section', 'xnos-number-by-section', 310 | 'xnos-number-offset', 311 | 'eqnos-eqref', 312 | 'eqnos-default-env'] 313 | 314 | if warninglevel: 315 | for name in meta: 316 | if (name.startswith('eqnos') or name.startswith('xnos')) and \ 317 | name not in metanames: 318 | msg = textwrap.dedent(""" 319 | pandoc-eqnos: unknown meta variable "%s"\n 320 | """ % name) 321 | STDERR.write(msg) 322 | 323 | for name in ['eqnos-cleveref', 'xnos-cleveref']: 324 | # 'xnos-cleveref' enables cleveref in all 3 of fignos/eqnos/tablenos 325 | if name in meta: 326 | cleveref = check_bool(get_meta(meta, name)) 327 | break 328 | 329 | for name in ['xnos-capitalise', 'xnos-capitalize']: 330 | # 'xnos-capitalise' enables capitalise in all 3 of 331 | # fignos/eqnos/tablenos. Since this uses an option in the caption 332 | # package, it is not possible to select between the three (use 333 | # 'eqnos-plus-name' instead. 'xnos-capitalize' is an alternative 334 | # spelling 335 | if name in meta: 336 | capitalise = check_bool(get_meta(meta, name)) 337 | break 338 | 339 | if 'eqnos-plus-name' in meta: 340 | tmp = get_meta(meta, 'eqnos-plus-name') 341 | old_plusname = copy.deepcopy(plusname) 342 | if isinstance(tmp, list): # The singular and plural forms were given 343 | plusname = tmp 344 | else: # Only the singular form was given 345 | plusname[0] = tmp 346 | plusname_changed = plusname != old_plusname 347 | assert len(plusname) == 2 348 | for name in plusname: 349 | assert isinstance(name, STRTYPES) 350 | if plusname_changed: 351 | starname = [name.title() for name in plusname] 352 | 353 | if 'eqnos-star-name' in meta: 354 | tmp = get_meta(meta, 'eqnos-star-name') 355 | old_starname = copy.deepcopy(starname) 356 | if isinstance(tmp, list): 357 | starname = tmp 358 | else: 359 | starname[0] = tmp 360 | starname_changed = starname != old_starname 361 | assert len(starname) == 2 362 | for name in starname: 363 | assert isinstance(name, STRTYPES) 364 | 365 | for name in ['eqnos-number-by-section', 'xnos-number-by-section']: 366 | if name in meta: 367 | numbersections = check_bool(get_meta(meta, name)) 368 | break 369 | 370 | if 'xnos-number-offset' in meta: 371 | secoffset = int(get_meta(meta, 'xnos-number-offset')) 372 | 373 | if 'eqnos-eqref' in meta: 374 | eqref = check_bool(get_meta(meta, 'eqnos-eqref')) 375 | # Note: Eqref and cleveref are mutually exclusive. If both are 376 | # enabled, then cleveref will be used but with bracketed equation 377 | # numbers. 378 | 379 | if 'eqnos-default-env' in meta: 380 | default_env = get_meta(meta, 'eqnos-default-env') 381 | 382 | def add_tex(meta): 383 | """Adds tex to the meta data.""" 384 | 385 | warnings = warninglevel == 2 and targets and \ 386 | (pandocxnos.cleveref_required() or 387 | plusname_changed or starname_changed or numbersections or secoffset) 388 | if warnings: 389 | msg = textwrap.dedent("""\ 390 | pandoc-eqnos: Wrote the following blocks to 391 | header-includes. If you use pandoc's 392 | --include-in-header option then you will need to 393 | manually include these yourself. 394 | """) 395 | STDERR.write('\n') 396 | STDERR.write(textwrap.fill(msg)) 397 | STDERR.write('\n') 398 | 399 | # Update the header-includes metadata. Pandoc's 400 | # --include-in-header option will override anything we do here. This 401 | # is a known issue and is owing to a design decision in pandoc. 402 | # See https://github.com/jgm/pandoc/issues/3139. 403 | 404 | if pandocxnos.cleveref_required() and targets: 405 | tex = """ 406 | %%%% pandoc-eqnos: required package 407 | \\usepackage%s{cleveref} 408 | """ % ('[capitalise]' if capitalise else '') 409 | pandocxnos.add_to_header_includes( 410 | meta, 'tex', tex, 411 | regex=r'\\usepackage(\[[\w\s,]*\])?\{cleveref\}') 412 | 413 | if not eqref: 414 | pandocxnos.add_to_header_includes( 415 | meta, 'tex', DISABLE_CLEVEREF_BRACKETS_TEX) 416 | 417 | if plusname_changed and targets: 418 | tex = """ 419 | %%%% pandoc-eqnos: change cref names 420 | \\crefname{equation}{%s}{%s} 421 | """ % (plusname[0], plusname[1]) 422 | pandocxnos.add_to_header_includes(meta, 'tex', tex) 423 | 424 | if starname_changed and targets: 425 | tex = """ 426 | %%%% pandoc-eqnos: change Cref names 427 | \\Crefname{equation}{%s}{%s} 428 | """ % (starname[0], starname[1]) 429 | pandocxnos.add_to_header_includes(meta, 'tex', tex) 430 | 431 | if numbersections and targets: 432 | pandocxnos.add_to_header_includes(meta, 'tex', NUMBER_BY_SECTION_TEX) 433 | 434 | if secoffset and targets: 435 | pandocxnos.add_to_header_includes( 436 | meta, 'tex', SECOFFSET_TEX % secoffset, 437 | regex=r'\\setcounter\{section\}') 438 | 439 | if warnings: 440 | STDERR.write('\n') 441 | 442 | def add_html(meta, fmt): 443 | """Adds html to the meta data.""" 444 | 445 | warnings = warninglevel == 2 and targets 446 | 447 | if warnings: 448 | msg = textwrap.dedent("""\ 449 | pandoc-eqnos: Wrote the following blocks to 450 | header-includes. If you use pandoc's 451 | --include-in-header option then you will need to 452 | manually include these yourself. 453 | """) 454 | STDERR.write('\n') 455 | STDERR.write(textwrap.fill(msg)) 456 | STDERR.write('\n') 457 | 458 | # Update the header-includes metadata. Pandoc's 459 | # --include-in-header option will override anything we do here. This 460 | # is a known issue and is owing to a design decision in pandoc. 461 | # See https://github.com/jgm/pandoc/issues/3139. 462 | 463 | if targets: 464 | cond = fmt == 'html4' or \ 465 | (fmt == 'html' and version(PANDOCVERSION) < version('2.0')) 466 | attr = ' type="text/css"' if cond else '' 467 | pandocxnos.add_to_header_includes(meta, 'html', 468 | EQUATION_STYLE_HTML%attr) 469 | 470 | # pylint: disable=too-many-locals, unused-argument 471 | def main(stdin=STDIN, stdout=STDOUT, stderr=STDERR): 472 | """Filters the document AST.""" 473 | 474 | # pylint: disable=global-statement 475 | global PANDOCVERSION 476 | global AttrMath 477 | 478 | # Read the command-line arguments 479 | parser = argparse.ArgumentParser(\ 480 | description='Pandoc equations numbers filter.') 481 | parser.add_argument(\ 482 | '--version', action='version', 483 | version='%(prog)s {version}'.format(version=__version__)) 484 | parser.add_argument('fmt') 485 | parser.add_argument('--pandocversion', help='The pandoc version.') 486 | args = parser.parse_args() 487 | 488 | # Get the output format and document 489 | fmt = args.fmt 490 | doc = json.loads(stdin.read()) 491 | 492 | # Initialize pandocxnos 493 | PANDOCVERSION = pandocxnos.init(args.pandocversion, doc) 494 | 495 | # Element primitives 496 | AttrMath = elt('Math', 3) 497 | 498 | # Chop up the doc 499 | meta = doc['meta'] if version(PANDOCVERSION) >= version('1.18') \ 500 | else doc[0]['unMeta'] 501 | blocks = doc['blocks'] if version(PANDOCVERSION) >= version('1.18') \ 502 | else doc[1:] 503 | 504 | # Process the metadata variables 505 | process(meta) 506 | 507 | # First pass 508 | attach_attrs_math = attach_attrs_factory(Math, allow_space=True) 509 | detach_attrs_math = detach_attrs_factory(Math) 510 | insert_secnos = insert_secnos_factory(Math) 511 | delete_secnos = delete_secnos_factory(Math) 512 | altered = functools.reduce(lambda x, action: walk(x, action, fmt, meta), 513 | [attach_attrs_math, insert_secnos, 514 | process_equations, delete_secnos, 515 | detach_attrs_math], blocks) 516 | 517 | # Second pass 518 | process_refs = process_refs_factory(LABEL_PATTERN, targets.keys()) 519 | replace_refs = replace_refs_factory(targets, 520 | cleveref, eqref, 521 | plusname if not capitalise or \ 522 | plusname_changed else 523 | [name.title() for name in plusname], 524 | starname) 525 | attach_attrs_span = attach_attrs_factory(Span, replace=True) 526 | altered = functools.reduce(lambda x, action: walk(x, action, fmt, meta), 527 | [repair_refs, process_refs, replace_refs, 528 | attach_attrs_span], 529 | altered) 530 | 531 | if fmt in ['latex', 'beamer']: 532 | add_tex(meta) 533 | elif fmt in ['html', 'html4', 'html5', 'epub', 'epub2', 'epub3']: 534 | add_html(meta, fmt) 535 | 536 | # Update the doc 537 | if version(PANDOCVERSION) >= version('1.18'): 538 | doc['blocks'] = altered 539 | else: 540 | doc = doc[:1] + altered 541 | 542 | # Dump the results 543 | json.dump(doc, stdout) 544 | 545 | # Flush stdout 546 | stdout.flush() 547 | 548 | if __name__ == '__main__': 549 | main() 550 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | description-file = README.md 3 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | """setup.py - install script for pandoc-eqnos.""" 2 | 3 | # Copyright 2015-2020 Thomas J. Duck. 4 | # All rights reserved. 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, version 3. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with this program. If not, see . 17 | 18 | import re 19 | import io 20 | 21 | from setuptools import setup 22 | 23 | # pylint: disable=invalid-name 24 | 25 | DESCRIPTION = """\ 26 | A pandoc filter for numbering equations and their references 27 | when converting markdown to other formats. 28 | """ 29 | 30 | # From https://stackoverflow.com/a/39671214 31 | __version__ = re.search( 32 | r'__version__\s*=\s*[\'"]([^\'"]*)[\'"]', 33 | io.open('pandoc_eqnos.py', encoding='utf_8_sig').read() 34 | ).group(1) 35 | 36 | setup( 37 | name='pandoc-eqnos', 38 | version=__version__, 39 | 40 | author='Thomas J. Duck', 41 | author_email='tomduck@tomduck.ca', 42 | description='Equation number filter for pandoc', 43 | long_description=DESCRIPTION, 44 | license='GPL', 45 | keywords='pandoc equation numbers filter', 46 | url='https://github.com/tomduck/pandoc-eqnos', 47 | download_url='https://github.com/tomduck/pandoc-eqnos/tarball/' + \ 48 | __version__, 49 | 50 | install_requires=['pandoc-xnos >= 2.5.0, < 3.0'], 51 | 52 | py_modules=['pandoc_eqnos'], 53 | entry_points={'console_scripts':['pandoc-eqnos = pandoc_eqnos:main']}, 54 | 55 | classifiers=[ 56 | 'Development Status :: 5 - Production/Stable', 57 | 'Intended Audience :: End Users/Desktop', 58 | 'Environment :: Console', 59 | 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', 60 | 'Programming Language :: Python' 61 | ] 62 | ) 63 | -------------------------------------------------------------------------------- /test/Makefile: -------------------------------------------------------------------------------- 1 | 2 | # Note: pandoc-2.4 broke citation parsing, and so is not supported. 3 | 4 | v2.11 = 2.11.1.1 5 | v2.10 = 2.10.1 6 | v2.9 = 2.9.2.1 7 | v2.8 = 2.8.1 8 | v2.7 = 2.7.3 9 | v2.6 = 2.6 10 | v2.5 = 2.5 11 | v2.3 = 2.3.1 12 | v2.2 = 2.2.3.2 13 | v2.1 = 2.1.3 14 | v2.0 = 2.0.6 15 | v1.19 = 1.19.2 16 | v1.18 = 1.18 17 | v1.17 = 1.17.2 18 | v1.16 = 1.16.0.2 19 | v1.15 = 1.15.2 20 | 21 | PANDOC-2.11 = pandoc-$(v2.11) 22 | PANDOC-2.10 = pandoc-$(v2.10) 23 | PANDOC-2.9 = pandoc-$(v2.9) 24 | PANDOC-2.8 = pandoc-$(v2.8) 25 | PANDOC-2.7 = pandoc-$(v2.7) 26 | PANDOC-2.6 = pandoc-$(v2.6) 27 | PANDOC-2.5 = pandoc-$(v2.5) 28 | PANDOC-2.3 = pandoc-$(v2.3) 29 | PANDOC-2.2 = pandoc-$(v2.2) 30 | PANDOC-2.1 = pandoc-$(v2.1) 31 | PANDOC-2.0 = pandoc-$(v2.0) 32 | PANDOC-1.19 = pandoc-$(v1.19) 33 | PANDOC-1.18 = pandoc-$(v1.18) 34 | PANDOC-1.17 = pandoc-$(v1.17) 35 | PANDOC-1.16 = pandoc-$(v1.16) 36 | PANDOC-1.15 = pandoc-$(v1.15) 37 | 38 | PYTHON-2.7 = python2.7 39 | 40 | # mathml needed for \mathrm{} 41 | PDFFLAGS = --variable geometry:margin=1in --standalone --variable urlcolor=blue 42 | HTMLFLAGS = --standalone --mathml --variable urlcolor=blue 43 | 44 | 45 | all: pdf html epub docx 46 | 47 | pdf: out/test-2.11.pdf \ 48 | out/test-2.11-py2.7.pdf \ 49 | out/test-2.10.pdf \ 50 | out/test-2.9.pdf \ 51 | out/test-2.8.pdf \ 52 | out/test-2.7.pdf \ 53 | out/test-2.6.pdf \ 54 | out/test-2.5.pdf \ 55 | out/test-2.3.pdf \ 56 | out/test-2.2.pdf \ 57 | out/test-2.1.pdf \ 58 | out/test-2.0.pdf \ 59 | out/test-1.19.pdf \ 60 | out/test-1.18.pdf \ 61 | out/test-1.17.pdf \ 62 | out/test-1.16.pdf \ 63 | out/test-1.15.pdf 64 | 65 | html: out/test-2.11.html 66 | 67 | epub: out/test-2.11.epub 68 | 69 | docx: out/test-2.11.docx 70 | 71 | 72 | out/test-%.html: test.md 73 | @if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi 74 | $(PANDOC-$*) $< --filter pandoc-eqnos $(HTMLFLAGS) -o $@ 75 | 76 | out/test-%-py2.7.pdf: test.md 77 | @if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi 78 | $(PANDOC-$*) $< -t json | $(PYTHON-2.7) ../pandoc_eqnos.py latex --pandocversion=$(v$*) | $(PANDOC-$*) -f json $(PDFFLAGS) -o $@ 79 | 80 | out/test-%.pdf: test.md 81 | @if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi 82 | $(PANDOC-$*) $< --filter pandoc-eqnos $(PDFFLAGS) -o $@ 83 | 84 | out/test-%.epub: test.md 85 | @if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi 86 | $(PANDOC-$*) $< --filter pandoc-eqnos -o $@ 87 | 88 | out/test-%.docx: test.md 89 | @if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi 90 | $(PANDOC-$*) $< --filter pandoc-eqnos -o $@ 91 | 92 | .PHONY: clean 93 | 94 | clean: 95 | rm -rf out 96 | -------------------------------------------------------------------------------- /test/README.md: -------------------------------------------------------------------------------- 1 | 2 | This directory contains regression tests. Running `make` produces out/demo-* files that may be inspected and compared. Note that the Makefile expects specific numbered pandoc executables (e.g., pandoc-2.7.3) to be available. You will need to adapt the Makefile to use what is available on your system. 3 | -------------------------------------------------------------------------------- /test/test.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Pandoc-eqnos Test 3 | eqnos-plus-name: EQ. 4 | eqnos-star-name: EQUATION 5 | header-includes: | 6 | 9 | ... 10 | 11 | $$ y = f(x) $$ {#eq:1} 12 | 13 | $$ y = g(x) $${#eq:2} 14 | 15 | *@eq:1 and +@eq:2, Eqs. {@eq:1}-{@eq:3} and Eqs. {@eq:1}-{@eq:2}-{@eq:3}. 16 | 17 | [Equation @eq:1.]{style="color:red"} 18 | 19 | Equations and references in lists: 20 | 21 | * Equation {@eq:3}: 22 | $$ 23 | y = h(x) 24 | $$ {#eq:3} 25 | * Equations {@eq:1} and @eq:2, Eqs. {@eq:1}-{@eq:3} and 26 | Eqs. {@eq:1}-{@eq:2}-{@eq:3}. 27 | 28 | Equations @eq:4 and @eq:5 are tagged equations (with and without quotes, respectively): 29 | $$ 30 | y = F(x) 31 | $$ {#eq:4 tag="B.1"} 32 | $$ 33 | y = G(x) 34 | $$ {#eq:5 tag=B.2} 35 | 36 | @eq:6 has a single-quoted tag with space: 37 | $$ 38 | y = H(x) 39 | $$ {#eq:6 tag='Eq. B.3'} 40 | Equation @eq:7 has a primed tag: 41 | $$ 42 | y = H'(x) 43 | $$ {#eq:7 tag="$\mathrm{B.3'}$"} 44 | 45 | Here is an unreferenceable numbered equation: 46 | $$ 47 | E = mc^2 48 | $$ {#eq:} 49 | 50 | A [regular link](http://example.com/), an [*italicized link*](http://example.com/) and an email.address@mailinator.com. 51 | 52 | 53 | \newpage 54 | 55 | More Tests 56 | ---------- 57 | 58 | ### Unnumbered equations ### 59 | 60 | An equation with empty attributes: 61 | $$ 62 | E = mc^2 63 | $$ {} 64 | 65 | 66 | An equation with no attributes: 67 | $$ 68 | E = mc^2 69 | $$ 70 | 71 | 72 | ### Unreferenceable numbered equations ### 73 | 74 | $$ 75 | y = F(x) 76 | $$ {#eq:} 77 | $$ 78 | y = G(x) 79 | $$ {#eq:} 80 | $$ 81 | y = H(x) 82 | $$ {#eq:} 83 | --------------------------------------------------------------------------------