ickc / pandoc-amsthm Goto Github PK

View Code? Open in Web Editor NEW

20.0 5.0 6.0 2.85 MB

provide a syntax to use amsthm environments in pandoc, with output in LaTeX and HTML

Home Page: https://ickc.github.io/pandoc-amsthm/

License: BSD 3-Clause "New" or "Revised" License

Python 83.06% TeX 7.68% Makefile 9.25%

pandoc markdown latex pandoc-filter pandoc-filters

pandoc-amsthm's Introduction

amsthm—provide a syntax to use amsthm environments in pandoc, with output in LaTeX and HTML

Date:	January 26, 2022

Contents

Introduction
Usage
Syntax
Tips
Supported pandoc versions

Introduction

amsthm provide a syntax to use amsthm environments in pandoc, with output in LaTeX and HTML.

Usage

From makefile:

tests/model-target.md: tests/model-source.md
    pandoc -F amsthm $< -o $@
tests/model-latex.tex: tests/model-source.md
    pandoc -F amsthm $< -o $@ --top-level-division=chapter --toc -N
tests/model-latex.pdf: tests/model-source.md
    pandoc -F amsthm $< -o $@ --top-level-division=chapter --toc -N
tests/model-html.html: tests/model-source.md
    pandoc -F amsthm $< -o $@ --toc -N -s

Syntax

See tests/model-source.md (or next page in documentation site) for an example.

Tips

Use -N, --number-sections to enable numbering in pandoc. This is mandatory for LaTeX output.
To match LaTeX and non-LaTeX output numbering scheme, match these 2 settings manually
- LaTeX output: pandoc’s cli flag --top-level-division=[section|chapter|part] and the use of parent_counter in pandoc-amsthm
- non-LaTeX output: counter_depth in pandoc-amsthm

pandoc versioning semantics is MAJOR.MAJOR.MINOR.PATCH and panflute’s is MAJOR.MINOR.PATCH. Below we shows matching versions of pandoc that panflute supports, in descending order. Only major version is shown as long as the minor versions doesn’t matter.

Version Matching [1]

pandoc-amsthm	panflute version	supported pandoc versions	supported pandoc API versions
2.0.0	2.1.3	2.14.0.3–2.17.x	1.22–1.22.1

[1]	For pandoc API verion, check https://hackage.haskell.org/package/pandoc for pandoc-types, which is the same thing.

pandoc-amsthm's People

Contributors

Stargazers

Watchers

Forkers

robwalton pbt001 alanzchen cyrilbouvier gavinmcwhinnie alfredholmes

pandoc-amsthm's Issues

is label useless in latexdivs.py?

Do you really need \label in https://github.com/ickc/pandoc-amsthm/blob/gh-pages/py/latexdivs.py#L25 since pandoc generates a \hypertargetin LaTeX mode?

<div id="myid">test</div>

See [here](#myid)

is rendered in LaTeX as:

\hypertarget{myid}{}
test

See \protect\hyperlink{myid}{here}

`parentcounter` should control where the counter in the CSS is reset in HTML output

Bug in pandoc-latex-environment

In my code https://github.com/chdemko/pandoc-latex-environment, the test currentClasses <= definedClasses was incorrect. It should be currentClasses >= definedClasses

PS: thanks to cite my code as stated in the CeCILL-B lience. See https://github.com/chdemko/pandoc-latex-environment/blob/master/README.md

Integrating the templates into the filter

Currently the filter is not "self-contained". A few templates are distributed and are required to use together for it to function properly.

@jgm suggested in jgm/pandoc#3138:

If you include Text.Pandoc.Templates in your filter, you can use its functions to resolve your custom template, and then insert the result into header-includes.

Complete rewrite using panflute

In light of issue #12 and #13, both requires a complete rewrite of the templates. Given @jgm recommended panflute, and Haskell has a tighter integration (allows the use of Text.Pandoc.Templates). It seems pandocfilters should be abandoned.

Either way requires some extra installations. panflute still seems to have a lower barrier since it is a scripting language (and cabal/stack install could be intimidating).

Edit: Todo list:

revert 330768e (at least partially): not a good idea to check output format and branching from there. Reason: panflute autofilter calls the main function, and may not pass the arg as the output format.

Default latex definitions

I have been writing plenty of maths and physics docs and I liked this filter and wanted to use it.
However what I do not like is to use the YAML block repeatedly in my every document.

I wonder if it is possible for the current YAML block specified in the README to be set as default in the filter in order to remove the need to define the environments in YAML of every document I write.
And since the defaults are set, it should be possible to override them within the YAML block.

But good job!