Skip to content

Commit

Permalink
Release 1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
marhop committed Apr 9, 2019
1 parent 70d7a2f commit e0dfed0
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 10 deletions.
16 changes: 16 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Release 1.1.0

2019-04-09

A second filter `pandoc-unicode-math-from-latex` was added that replaces
"regular" Latex math commands by equivalent Unicode symbols. This is more or
less the inverse of the existing filter `pandoc-unicode-math`. Idea by Anish
Mittal.

Several new symbols were added. Partly contributed by Eric Hanson.

# Release 1.0.0

2018-02-27

Initial release.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2017-2018, Martin Hoppenheit
Copyright (c) 2017-2019, Martin Hoppenheit

All rights reserved.

Expand Down
29 changes: 22 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ If you prefer the Unicode variant, this filter is for you!
A complete list of symbols that are replaced by this filter can be found in the
[`src/Symbols.hs`](src/Symbols.hs) file.

[Pandoc]: https://pandoc.org/
[filter]: https://pandoc.org/filters.html

## Usage

1. Get binaries [here][releases] and put them in your [PATH]. If necessary, you
Expand All @@ -42,6 +45,9 @@ A complete list of symbols that are replaced by this filter can be found in the

$ pandoc example.md --filter pandoc-unicode-math -o example.pdf

[releases]: https://github.com/marhop/pandoc-unicode-math/releases
[PATH]: https://en.wikipedia.org/wiki/PATH_(variable)

## But my keyboard has no "α" and "∃" keys!

The `pandoc-unicode-math` filter will not make *writing* math expressions
Expand All @@ -59,6 +65,9 @@ be ambiguous. This filter can be used like this:

$ pandoc latex-math.md --filter pandoc-unicode-math-from-latex -o unicode-math.md

[digraphs]: http://vimdoc.sourceforge.net/htmldoc/digraph.html
[characterize plugin]: https://github.com/tpope/vim-characterize

## Limitations

For more complex math containing fractions like `\frac{2}{3+5}` or lots of
Expand All @@ -69,6 +78,18 @@ expression:

∃ x ∈ ℕ : \frac{x}{2} = 21

## Alternatives

Instead of writing Unicode symbols in your source file and applying this filter,
you can write regular Latex math commands and use an editor that displays them
in a more readable way. For example, using Vim and the [Markdown plugin], these
settings have the desired effect:

let g:vim_markdown_math=1
set conceallevel=2

[Markdown plugin]: https://github.com/plasticboy/vim-markdown

## Building from source

These filters are written in Haskell. It is recommended to use [Stack] for
Expand Down Expand Up @@ -96,13 +117,7 @@ Pandoc 1.17 (shipped with Debian 9) or `resolver: lts-9.21` for Pandoc 1.19 and
later, including Pandoc 2 (there was an API change between 1.17 and 1.19, so you
need different binaries).

[Pandoc]: https://pandoc.org/
[filter]: https://pandoc.org/filters.html
[releases]: https://github.com/marhop/pandoc-unicode-math/releases
[PATH]: https://en.wikipedia.org/wiki/PATH_(variable)
[digraphs]: http://vimdoc.sourceforge.net/htmldoc/digraph.html
[characterize plugin]: https://github.com/tpope/vim-characterize
[Stack]: https://docs.haskellstack.org/
[Stackage]: https://www.stackage.org/
[pkg-config]: https://www.freedesktop.org/wiki/Software/pkg-config/
[PCRE]: https://pcre.org/
[Stackage]: https://www.stackage.org/
4 changes: 2 additions & 2 deletions pandoc-unicode-math.cabal
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: pandoc-unicode-math
version: 1.0.0
version: 1.1.0
synopsis: Replace Unicode symbols by equivalent Latex commands
description: A Pandoc filter that replaces Unicode math symbols and
greek letters like ∀, ∈, →, λ, or Ω in math environments
Expand All @@ -12,7 +12,7 @@ license: BSD3
license-file: LICENSE
author: Martin Hoppenheit
maintainer: [email protected]
copyright: 2017-2018 Martin Hoppenheit
copyright: 2017-2019 Martin Hoppenheit
category: Text
build-type: Simple
cabal-version: >=1.10
Expand Down

0 comments on commit e0dfed0

Please sign in to comment.