/pandoc-xnos

Library code for pandoc-fignos/eqnos/tablenos/secnos.

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

pandoc-xnos

The pandoc-xnos filter suite provides facilities for cross-referencing in markdown documents processed by pandoc. Individual filters are maintained in separate projects. They are:

Click on the above links to access documentation for each filter. LaTeX/pdf, html, and epub output have native support. Native support for docx output is a work in progress.

This project provides library code for the suite and a pandoc-xnos filter that applies all of the above filters in sequence.

See also: pandoc-comments, pandoc-latex-extensions

Contents

  1. Installation
  2. Usage
  3. Getting Help

Installation

The Pandoc-xnos filters require python. It is easily installed -- see here. 1 Either python 2.7 or 3.x will do.

The pandoc-xnos filter suite may be installed using the shell command

pip install pandoc-fignos pandoc-eqnos pandoc-tablenos \
            pandoc-secnos --user

and upgraded by appending --upgrade to the above command.

Pip is a program that downloads and installs software from the Python Package Index, PyPI.

Instructions for installing from source are given in DEVELOPERS.md.

Usage

The pandoc-xnos filter suite may be applied using the

--filter pandoc-xnos

option with pandoc. It is also possible to apply the filters individually.

Any use of --filter pandoc-citeproc or --bibliography=FILE should come after the pandoc-xnos filter call.

Getting Help

If you have any difficulties with pandoc-xnos, or would like to see a new feature, then please submit a report to our Issues tracker.


Footnotes

1: For MacOS, my preferred install method is to use the Installer package available from python.org.