- Definition of CriticMarkup
- Installation
- Usage: pancritic as a markdown wrapper (including but not limited to pandoc)
- Caveats
- Credits
Using CriticMarkup with pandoc. It serves both as a wrapper and a pre-processor.
- Deletions: This is {--is --}a test.
- Additions: This {++is ++}a test.
- Substitutions: This {~~isn’t~>is~~} a test.
- Highlighting: This is a {==test==}.
- Comments: This is a test{>>What is a test for?<<}.
Install using
pip install pancriticpancritic provides a pandoc-like cli. Pandoc users will feel right at home. See help from
pancritic -hA typical use of pancritic will be like
pancritic -s -o index.html index.md-
--engine
The default engine ismarkdown. Valid options aremarkdown,markdown2,panflute,pypandoc. You need to install the respective package in order to use them.markdownandmarkdown2are pure Python, hence useful for other CPU architechture.panfluteandpypandocboth uses pandoc as backend. -
-m|--critic-mode
a/accept, r/reject: accept/reject changes.d/diff: generates a diff. In HTML output, JS is used for toggling between diff, accept, reject.
m/markup: treat the CriticMarkup as Markup. i.e. in HTML output there isn’t any toggles but the diff view only. In LaTeX output, diff and markup modes are identical except for an additional nav.
-m mshould be used with LaTeX output.
This is completely rewritten in Python. The cli has been completely
changed too. The former options of -a, -r, -d are replaced with
-m a, -m r, -m d, and added a -m m.
This is a heavy fork of criticParser_CLI.py, with these differences:
- CLI has changed, with a more pandoc-like interface.
- Python 3 (and 2) compatible.
- Bug fixes (formerly hightlight without comment are parsed incorrectly).
- It has much more input/output format options as well as engines.
Examples,
criticParser_CLI.py input.md -m2 -o output.html --css css.html
# is equivalent to
pancritic -o output.html input.md --critic-template css.html --engine markdown2A somewhat surprising behavior is when the to-format and output extension is different. In pancritic, the to-format indicates the CriticMarkup parsing behavior (mainly tex vs. html). And the output extension controls the final output’s format (e.g. markdown, html, etc.)
An interesting use of this is to use pancritic as a pandoc preprocessor instead, like this
pancritic input.md -t markdown -m m | pandoc -s -o output.htmlThis will be useful if more advanced pandoc args are needed.
-
Nesting CriticMarkup might have unexpected behavior, especially in LaTeX output. See the caveats section in the spec of CriticMarkup.
-
mainly tested with HTML and LaTeX output. RST output almost works, but injecting CSS/JS into the output causes some problems. Currently, it can be get arround with
--critic-templateand injecting the CSS/JS manually. Seepancritic/template.pyfor the template used.
Note that the LaTeX output requires the LaTeX packages
changes>=3.[1]
One can tell pandoc to use this package by either using a custom
template or --include-in-header option. Or you can use the trick of
putting the following in your YAML front matter, like this file:
---
fontfamily: lmodern,changes
...Markdown within the CriticMarkup will not be rendered in LaTeX output. If you want to change this behavior, you can take a look at: LaTeX Argument Parser.
| CriticMarkup | LaTeX |
|---|---|
{--[text]--} |
\deleted{[text]} |
{++[text]++} |
\added{[text]} |
{~~[text1]~>[text2]~~} |
\replaced{[text2]}{[text1]} |
{==[text]==} |
\highlight{[text]} |
{>>[text]<<} |
\comment{[text]} |
Translation from CriticMarkup to LaTeX.
- Heavily modified from CriticMarkup Toolkit’s criticParser_CLI.py
- tests.md is modified from MMD-Test-Suite/Critic.text at master · fletcher/MMD-Test-Suite
-
The version of the package in TeXLive 2018 is still v2. TeXLive 2019 should be available on 2019-4-30, meanwhile you need to
# sudo is needed in most cases, depending on where you put it sudo tlmgr update --self sudo tlmgr update changes # check it is >=3 tlmgr info changes
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent