#pandoc #acronym #pandoc-filter

bin+lib pandoc-ac

A simple pandoc filter for converting acronym codes to LaTeX

3 releases (breaking)

0.3.0 Jun 10, 2021
0.2.0 Feb 19, 2019
0.1.0 Nov 21, 2018

#666 in Text processing

36 downloads per month

MIT/Apache

16KB
134 lines

Pandoc acronym

Latest Version Minimum Rust Version 1.31 Minimum Pandoc Version 2.13 Build Status dependency status

This filter provides a slightly cleaner syntax for LaTeX acronyms.

What it does:

Code Description Translates to
(+x) basic acronym instruction \ac{x}
(+~x) full form of the acronym \acf{x}
(+.x) always short form \acs{x}
(+-x) always expand acronym \acl{x}
(+*x), (+.*x), (+-*x), (+~*x) plural form of the above \acp{x}, \acsp{x}, \aclp{x}, \acfp{x} respectively
(+^x), (+.^x), (+-^x), (+~^x) plural form, alternate syntax \acp{x}, \acsp{x}, \aclp{x}, \acfp{x}

Using

The binary pandoc-ac is a standard pandoc filter. It is currently compatible with the Pandoc AST API v1.22.

pandoc mytext.md -F pandoc-ac -o out.pdf

Moreover, the filter is accessible programmatically from Rust with the pandoc_ac library.

use pandoc_ast::Pandoc;
use pandoc_ac::make_acronym_formatting;
use serde_json::from_reader;
use std::fs::File;

let input_file = "resources/test.md";

let text_json: Pandoc = from_reader(File::open(input_file)?)?;
let result: Pandoc = make_acronym_formatting(text_json);

License

Licensed under either of

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~2.8–4.5MB
~86K SLoC