Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tomduck/pandoc-tablenos

A pandoc filter for numbering tables and table references.
https://github.com/tomduck/pandoc-tablenos

Last synced: 3 months ago
JSON representation

A pandoc filter for numbering tables and table references.

Awesome Lists containing this project

README 

        

**New in 2.3.0:** Updated for pandoc 2.11. 



[more...](#whats-new)



pandoc-tablenos 2.3.0

=====================



*pandoc-tablenos* is a [pandoc] filter for numbering tables and their references when converting markdown to other formats.  It is part of the [pandoc-xnos] filter suite.  LaTeX/pdf, html, and epub output have native support.  Native support for docx output is a work in progress.



Demonstration: Processing [demo3.md] with pandoc + pandoc-tablenos gives numbered tables and references in [pdf][pdf3], [tex][tex3], [html][html3], [epub][epub3], [docx][docx3] and other formats (including beamer slideshows).



This version of pandoc-tablenos was tested using pandoc 1.15.2 - 2.11.1.1,[1](#footnote1) and may be used with linux, macOS, and Windows.  Bug reports and feature requests may be posted on the project's [Issues tracker].  If you find pandoc-tablenos useful, then please kindly give it a star [on GitHub].



See also: [pandoc-fignos], [pandoc-eqnos], [pandoc-secnos] \

Other filters: [pandoc-comments], [pandoc-latex-extensions]



[pandoc]: http://pandoc.org/

[pandoc-xnos]: https://github.com/tomduck/pandoc-xnos

[Issues tracker]: https://github.com/tomduck/pandoc-tablenos/issues

[on GitHub]: https://github.com/tomduck/pandoc-tablenos

[pandoc-fignos]: https://github.com/tomduck/pandoc-fignos

[pandoc-eqnos]: https://github.com/tomduck/pandoc-eqnos

[pandoc-secnos]: https://github.com/tomduck/pandoc-secnos

[pandoc-comments]: https://github.com/tomduck/pandoc-comments

[pandoc-latex-extensions]: https://github.com/tomduck/pandoc-latex-extensions



Contents

--------



 1. [Installation](#installation)

 2. [Usage](#usage)

 3. [Markdown Syntax](#markdown-syntax)

 4. [Customization](#customization)

 5. [Technical Details](#technical-details)

 6. [Getting Help](#getting-help)

 7. [Development](#development)

 8. [What's New](#whats-new)



Installation

------------



Pandoc-tablenos requires [python].  It is easily installed -- see [here](https://realpython.com/installing-python/).[2](#footnote2)  Either python 2.7 or 3.x will do.



Pandoc-tablenos may be installed using the shell command



    pip install pandoc-tablenos --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].  It normally comes installed with a python distribution.[3](#footnote3)



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



[python]: https://www.python.org/

[PyPI]: https://pypi.python.org/pypi

[DEVELOPERS.md]: DEVELOPERS.md



Usage

-----



Pandoc-tablenos is activated by using the



    --filter pandoc-tablenos



option with pandoc.  Alternatively, use



    --filter pandoc-xnos



to activate all of the filters in the [pandoc-xnos] suite (if installed).



Any use of `--filter pandoc-citeproc` or `--bibliography=FILE` should come *after* the `pandoc-tablenos` or `pandoc-xnos` filter calls.



Markdown Syntax

---------------



The cross-referencing syntax used by pandoc-tablenos was worked out in [pandoc Issue #813] -- see [this post] by [@scaramouche1].



To mark a table for numbering, add an id to its attributes:



    A B

    - -

    0 1



    Table: Caption. {#tbl:id}



The prefix `#tbl:` is required. `id` should be replaced with a unique identifier composed of letters, numbers, dashes and underscores.  If `id` is omitted then the table will be numbered but unreferenceable.



To reference the table, use



    @tbl:id



or



    {@tbl:id}



Curly braces protect a reference and are stripped from the output.



Demonstration: Processing [demo.md] with pandoc + pandoc-tablenos gives numbered tables and references in [pdf], [tex], [html], [epub], [docx] and other formats.



[pandoc Issue #813]: https://github.com/jgm/pandoc/issues/813

[this post]: https://github.com/jgm/pandoc/issues/813#issuecomment-70423503

[@scaramouche1]: https://github.com/scaramouche1

[demo.md]: https://raw.githubusercontent.com/tomduck/pandoc-tablenos/master/demos/demo.md

[pdf]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo.pdf

[tex]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo.tex

[html]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo.html

[epub]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo.epub

[docx]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo.docx



### Clever References ###



Writing markdown like



    See table @tbl:id.



seems a bit redundant.  Pandoc-tablenos supports "clever references" via single-character modifiers in front of a reference.  Users may write



     See +@tbl:id.



to have the reference name (i.e., "table") automatically generated.  The above form is used mid-sentence.  At the beginning of a sentence, use



     *@tbl:id



instead.  If clever references are enabled by default (see [Customization](#customization), below), then users may disable it for a given reference using[4](#footnote4)



    !@tbl:id



Demonstration: Processing [demo2.md] with pandoc + pandoc-tablenos gives numbered tables and references in [pdf][pdf2], [tex][tex2], [html][html2], [epub][epub2], [docx][docx2] and other formats.



Note: When using `*@tbl:id` and emphasis (e.g., `*italics*`) in the same sentence, the `*` in the clever reference must be backslash-escaped; e.g., `\*@tbl:id`.



[demo2.md]: https://raw.githubusercontent.com/tomduck/pandoc-tablenos/master/demos/demo2.md

[pdf2]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo2.pdf

[tex2]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo2.tex

[html2]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo2.html

[epub2]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo2.epub

[docx2]: https://github.com/tomduck/pandoc-tablenos/blob/demos/demo2.docx



### Tagged Tables ###



The table number may be overridden by placing a tag in the table's attributes block as follows:



    A B

    - -

    0 1



    Table: Caption. {#tbl:id tag="B.1"}



The tag may be arbitrary text, or an inline equation such as `$\text{B.1}'$`.  Mixtures of the two are not currently supported.



### Disabling Links ###



To disable a link on a reference, set `nolink=True` in the reference's attributes:



    @tbl:id{nolink=True}



Customization

-------------



Pandoc-tablenos may be customized by setting variables in the [metadata block] or on the command line (using `-M KEY=VAL`).  The following variables are supported:



  * `tablenos-warning-level` or `xnos-warning-level` - Set to `0` for

    no warnings, `1` for critical warnings, or `2` (default) for

    all warnings.  Warning level 2 should be used when

    troubleshooting.



  * `tablenos-cleveref` or just `cleveref` - Set to `True` to assume

    "+" clever references by default;



  * `xnos-capitalise` - Capitalises the names of "+" references

    (e.g., change from "table" to "Table");



  * `tablenos-plus-name` - Sets the name of a "+" reference 

    (e.g., change it from "table" to "tab.").  Settings here take

    precedence over `xnos-capitalise`;



  * `tablenos-star-name` - Sets the name of a "*" reference 

    (e.g., change it from "Table" to "Tab.");



  * `tablenos-caption-name` - Sets the name at the beginning of a

    caption (e.g., change it from "Table to "Tab.");



  * `tablenos-caption-separator` or `xnos-caption-separator` - Sets 

    the caption separator (e.g., the colon in "Table 1:") to

    something else.  It must be one of `none`, `colon`,

    `period`, `space`, `quad`, or `newline`; and



  * `tablenos-number-by-section` or `xnos-number-by-section` - Set to

    `True` to number tables by section (i.e. Table 1.1, 1.2, etc in

    Section 1, and Table 2.1, 2.2, etc in Section 2).  For LaTeX/pdf,

    html, and epub output, this feature should be used together with

    pandoc's `--number-sections`

    [option](https://pandoc.org/MANUAL.html#option--number-sections)

    enabled.  For docx, use [docx custom styles] instead.



    This option should not be set for numbering by chapter in

    LaTeX/pdf book document classes.



  * `xnos-number-offset` - Set to an integer to offset the section

    numbers when numbering tables by section.  For html and epub

    output, this feature should be used together with pandoc's

    `--number-offset`

    [option](https://pandoc.org/MANUAL.html#option--number-sections)

    set to the same integer value.  For LaTeX/pdf, this option

    offsets the actual section numbers as required.



Note that variables beginning with `tablenos-` apply to only pandoc-tablenos, whereas variables beginning with `xnos-` apply to all of the pandoc-fignos/eqnos/tablenos/secnos.



Demonstration: Processing [demo3.md] with pandoc + pandoc-tablenos gives numbered tables and references in [pdf][pdf3], [tex][tex3], [html][html3], [epub][epub3], [docx][docx3] and other formats.



[metadata block]: http://pandoc.org/README.html#extension-yaml_metadata_block

[docx custom styles]: https://pandoc.org/MANUAL.html#custom-styles

[demo3.md]: https://raw.githubusercontent.com/tomduck/pandoc-tablenos/master/demos/demo3.md

[pdf3]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo3.pdf

[tex3]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo3.tex

[html3]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo3.html

[epub3]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo3.epub

[docx3]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo3.docx



Technical Details

-----------------



### LaTeX/pdf Output ###



During processing, pandoc-tablenos inserts packages and supporting LaTeX into the `header-includes` metadata field.  To see what is inserted, set the `tablenos-warning-level` meta variable to `2`.  Note that any use of pandoc's `--include-in-header` option [overrides](https://github.com/jgm/pandoc/issues/3139) all `header-includes`.



An example reference in LaTeX looks like



~~~latex

See \cref{tbl:1}.

~~~



An example table looks like



~~~latex

\begin{longtable}[]{@{}rlcl@{}}

  \caption{Demonstration of a simple table.

  \label{tbl:1}}\tabularnewline

  \toprule

  Right & Left & Center & Default\tabularnewline

  \midrule

  \endfirsthead

  \toprule

  Right & Left & Center & Default\tabularnewline

  \midrule

  \endhead

  12  & 12  & 12  & 12  \tabularnewline

  123 & 123 & 123 & 123 \tabularnewline

  \bottomrule

\end{longtable}

~~~



Other details:



  * The `cleveref` and `caption` packages are used for clever

    references and caption control, respectively; 

  * The `\label` and `\ref` macros are used for table labels and

    references, respectively (`\Cref` and `\cref` are used for

    clever references);

  * Clever reference names are set with `\Crefname` and `\crefname`;

  * The caption name is set with`\tablename`;

  * Tags are supported by way of a custom environment that

    temporarily redefines `\thetable`; and

  * Caption prefixes (e.g., "Table 1:") are disabled for

    unnumbered tables by way of a custom environment that uses

    `\captionsetup`.



### Other Output Formats ###



An example reference in html looks like



~~~html

See table 1.

~~~



An example table looks like



~~~html



  

    

      Table 1: Demonstration of a simple table.

    

    

      

        Right

        Left

        Center

        Default

      

    

    

      

        12

        12

        12

       12

      

      

        123

        123

        123

        123

      

    

  



~~~



The table is wrapped in a `
` with an `id` for linking and with class `tablenos` to allow for css styling.



### Docx Output ###



Docx OOXML output is under development and subject to change.  Native capabilities will be used wherever possible.



Getting Help

------------



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



Development

-----------



Pandoc-tablenos will continue to support pandoc 1.15-onward and python 2 & 3 for the foreseeable future.  The reasons for this are that a) some users cannot upgrade pandoc and/or python; and b) supporting all versions tends to make pandoc-tablenos more robust.



Developer notes are maintained in [DEVELOPERS.md].



What's New

----------



**New in 2.3.0:** Updated for pandoc 2.11. 



**New in 2.2.2:** Updated for pandoc 2.10.1.



**New in 2.1.1:** Warnings are now given for duplicate reference targets.



**New in 2.0.0:**  This version represents a major revision of pandoc-tablenos.  While the interface is similar to that of the 1.x series, some users may encounter minor compatibility issues.



Warning messages are a new feature of pandoc-tablenos.  The meta variable `tablenos-warning-level` may be set to `0`, `1`, or `2` depending on the degree of warnings desired.  Warning level `1` will alert users to bad references, malformed attributes, and unknown meta variables.  Warning level `2` (the default) adds informational messages that should be helpful with debugging.  Level `0` turns all messages off.



Meta variable names have been updated.  Deprecated names have been removed, and new variables have been added.  Note in particular that the `tablenos-number-sections` and `xnos-number-sections` variables have been renamed to `tablenos-number-by-section` and `xnos-number-by-section`, respectively.



The basic filter and library codes have been refactored and improved with a view toward maintainability.  While extensive tests have been performed, some problems may have slipped through unnoticed.  Bug reports should be submitted to our [Issues tracker].



*LaTeX/PDF:*



LaTeX codes produced by pandoc-tablenos are massively improved.  The hacks used before were causing some users problems.  The new approach provides more flexibility and better compatibility with the LaTeX system.



Supporting LaTeX is now written to the `header-includes` meta data.  Users no longer need to include LaTeX commands in the `header-includes` to get basic pandoc-tablenos functions to work.  Use `tablenos-warning-level: 2` to see what pandoc-tablenos adds to the `header-includes`.



A word of warning: Pandoc-tablenos's additions to the `header-includes` are overridden when pandoc's `--include-in-header` option is used.  This is owing to a [design choice](https://github.com/jgm/pandoc/issues/3139) in pandoc.  Users may choose to deliberately override pandoc-tablenos's `header-includes` by providing their own LaTeX through `--include-in-header`.  If a user needs to include other bits of LaTeX in this way, then they will need to do the same for the LaTeX that pandoc-tablenos needs.



Finally, the `\label` tags are now installed where pandoc chooses, which is currently outside the `\caption` field.  Pandoc-tablenos previously forced the `\label` to go inside `\caption`.



*Html/Epub:*



The table is now enclosed in a `
` which contains the `id` and class `tablenos`.  This change was made to facilitate styling.  The `id` was formerly contained in an anchor tag.



Epub support is generally improved.



----



**Footnotes**



1: Pandoc 2.4 [broke](https://github.com/jgm/pandoc/issues/5099) how references are parsed, and so is not supported.



2: For MacOS, my preferred install method is to use the package [available from python.org](https://www.python.org/downloads/).



3: Anaconda users may be tempted to use `conda` instead.  This is not advised.  The packages distributed on the Anaconda cloud are unofficial, are not posted by me, and in some cases are ancient.  Some tips on using `pip` in a `conda` environment may be found [here](https://www.anaconda.com/using-pip-in-a-conda-environment/).



4: The disabling modifier "!" is used instead of "-" because [pandoc drops minus signs] in front of references.



[pandoc drops minus signs]: https://github.com/jgm/pandoc/issues/2901