├── .gitignore
├── AUTHORS
├── ChangeLog
├── DEVELOPERS.md
├── LICENSE
├── MANIFEST.in
├── README.md
├── demos
    ├── Makefile
    ├── demo.md
    ├── demo2.md
    ├── demo3.md
    └── headers
    │   ├── header.epub
    │   └── header.html
├── pandoc_tablenos.py
├── setup.cfg
├── setup.py
└── test
    ├── Makefile
    ├── README.md
    ├── cleveref.tex
    └── test.md


/.gitignore:
--------------------------------------------------------------------------------
1 | build
2 | dist
3 | *.egg-info
4 | demos/out/*
5 | test/out/*
6 | 


--------------------------------------------------------------------------------
/AUTHORS:
--------------------------------------------------------------------------------
1 | 
2 | pandoc-tablenos was written an is maintained by Thomas J. Duck
3 | <tomduck@tomduck.ca>
4 | 


--------------------------------------------------------------------------------
/ChangeLog:
--------------------------------------------------------------------------------
  1 | pandoc-tablenos 2.3.0 (2020-11-10)
  2 | 
  3 |     * Require pandoc-xnos 2.5.0 (updated to work with pandoc 2.11;
  4 |       pandoc-tablenos Issue #23).
  5 | 
  6 | 
  7 | pandoc-tablenos 2.2.2 (2020-08-07)
  8 | 
  9 |     * Use nonbreaking space between ref name and number in caption
 10 |       (pandoc-xnos Issue #14).
 11 |     * Fixed unsupported operand type error with use of
 12 |       pandoc 2.10 (Issue #22).
 13 | 
 14 | 
 15 | pandoc-tablenos 2.2.1 (2020-07-31)
 16 | 
 17 |     * Require pandoc-xnos 2.4.2 (bug fix release).
 18 |     * Fixed processing of tables for pandoc 2.10.
 19 | 
 20 | 
 21 | pandoc-tablenos 2.2.0 (2020-07-30)
 22 | 
 23 |     * Updated to work with pandoc 2.10.
 24 |     * Fixed table number reset problem for html, docx (Issue #17).
 25 | 
 26 | 
 27 | pandoc-tablenos 2.1.1 (2019-09-26)
 28 | 
 29 |     * Warns about duplicate reference targets.
 30 | 
 31 | 
 32 | pandoc-tablenos 2.0.0 (2019-09-17)
 33 | 
 34 |     * A warnings system has been added.
 35 |     * Meta variable names have been updated.
 36 |     * TeX codes have been completely overhauled.
 37 |     * Html/epub tables are now enclosed in a `<div>`.
 38 |     * Epub support is generally improved.
 39 |     * Support section number offsets in table numbers
 40 |       (pandoc-fignos Issue #47).
 41 |     * Support for disabling links on selected references
 42 |       (pandoc-fignos Issue #54).
 43 |     * Support for custom caption separators (pandoc-fignos Issue #67).
 44 |     * Better handling of missing references.
 45 |     * Changed `tablenos-number-sections` and `xnos-number-sections`
 46 |       options to `tablenos-number-by-section` and
 47 |       `xnos-number-by-section`
 48 | 
 49 | 
 50 | pandoc-tablenos 1.4.2 (2019-05-17)
 51 | 
 52 |     * Support epub2 and epub3 targets; use id tag (Issue #13).
 53 | 
 54 | 
 55 | pandoc-tablenos 1.4.1 (2019-05-16)
 56 | 
 57 |     * Fixed links in epub output (pandoc-eqnos Issue #37).
 58 |     * Bug fix for table numbering by section for docx
 59 |       (pandoc-fignos Issue #58).
 60 |     * Can now use `pandoc-fignos --version` to get verson.
 61 | 
 62 | 
 63 | pandoc-tablenos 1.4.0 (2019-05-15)
 64 | 
 65 |     * Support for references in bracketed spans (pandoc-fignos
 66 |       Issue #58).
 67 | 
 68 | 
 69 | pandoc-tablenos 1.3.2 (2019-05-15)
 70 | 
 71 |     * Enabled table numbering by section for docx (addresses
 72 |       pandoc-fignos Issue #59).
 73 | 
 74 | 
 75 | pandoc-tablenos 1.3.1 (2019-05-08)
 76 | 
 77 |     * Maintenance release for pandoc 2.7.2.
 78 | 
 79 | 
 80 | pandoc-tablenos 1.3.0 (2018-08-09)
 81 | 
 82 |     * Require pandoc-xnos>=1.1,<2 to ensure API compatibility
 83 |       (pandoc-fignos Issue #46).
 84 |     * Gives more helpful error message regarding acceptable
 85 |       boolean metadata values (pandoc-fignos Issue #51).
 86 |     * Removed blank line before caption in docx output (Issue #6).
 87 | 
 88 | 
 89 | pandoc-tablenos 1.2.0 (2018-01-14)
 90 | 
 91 |     * Added `tablenos-capitalise` meta variable.
 92 | 
 93 | 
 94 | pandoc-tablenos 1.1.0 (2018-01-13)
 95 | 
 96 |     * Updated to use pandoc-xnos 0.15
 97 | 
 98 | 
 99 | pandoc-tablenos 1.0.0 (2018-01-07)
100 | 
101 |     * Version number bumped to 1.0.0.
102 |     * Put span around html caption label (e.g., "Table 1") to
103 |       allow styling.
104 | 
105 | 
106 | pandoc-tablenos 1.0.0rc3 (2017-12-16)
107 | 
108 |     * Removed dependency on pandoc-attributes
109 |       (pandoc-fignos Issue #42).
110 | 
111 | 
112 | pandoc-tablenos 1.0.0rc1 (2017-11-18)
113 | 
114 |     * Release candidate updated for pandoc 2.0.
115 | 
116 | 
117 | pandoc-tablenos 0.17.1 (2017-09-19)
118 | 
119 |     * Fixes for beamer (pandoc-fignos Issue #38).
120 | 
121 | 
122 | pandoc-tablenos 0.16.1 (2017-09-12)
123 | 
124 |     * Documentation updates.
125 | 
126 | 
127 | pandoc-tablenos 0.16 (2016-12-05)
128 | 
129 |     * Added numbering tables by section for html and pdf
130 |       (pandoc-eqnos Issue #15).
131 | 
132 | 
133 | pandoc-tablenos 0.15 (2016-11-30)
134 | 
135 |     * Clickable internal links for docx (pandoc-fignos Issue #25).
136 | 
137 | 
138 | pandoc-tablenos 0.14.1 (2016-11-17)
139 | 
140 |     * Use custom caption name for tagged tables.
141 |     * Python 2.7.3 bug addressed with pandoc-xnos 0.7.
142 |     * Clarified purpose of this filter in README.md (Issue #4).
143 | 
144 | 
145 | pandoc-tablenos 0.14 (2016-11-05)
146 | 
147 |     * Updated for pandoc 1.18 (pandoc-fignos Issue #30)
148 | 
149 | 
150 | pandoc-tablenos 0.13 (2016-10-22)
151 | 
152 |     * Fixed metadata corruption bug (pandoc-fignos Issue #23).
153 |     * Fixed python 2.7 install on Windows (pandoc-fignos Issue #27).
154 |     * Require pandoc-xnos >= 0.5.
155 | 
156 | 
157 | pandoc-tablenos 0.12.1 (2016-08-21)
158 | 
159 |     * Require pandoc-xnos >= 0.4.1.
160 | 
161 | 
162 | pandoc-tablenos 0.12 (2016-08-21)
163 | 
164 |     * Support for unnumbered figures in TeX/pdf.
165 | 
166 | 
167 | pandoc-tablenos 0.11 (2016-05-18)
168 | 
169 |     * Added tagged tables (Issue #3)
170 |     * Changed caption separator from period to colon for html output
171 |       to be consistent with TeX/pdf.
172 |     * Added option to change the caption name.
173 | 
174 | 
175 | pandoc-tablenos 0.10 (2016-05-15)
176 | 
177 |     * Added clever referencing.
178 |     * Moved library code to pandocxnos project.
179 |     * Fixed numbering of unreferenceable tables (Issue #1).
180 |     * Fixed broken attribute parsing (Issue #2).
181 |     * Improved pandoc version detection.
182 | 
183 | 
184 | pandoc-tablenos 0.9 (2016-04-19)
185 | 
186 |     * Better pandoc version detection.
187 |     * Significant refactoring.
188 | 
189 | 
190 | pandoc-tablenos 0.8 (2016-04-05)
191 | 
192 |     * Fixed broken installation in Win 10 (pandoc-eqnos Issue #6).
193 | 
194 | 
195 | pandoc-tablenos 0.7.1 (2016-01-24):
196 | 
197 |     * Added regression tests.
198 | 
199 |     * Fixed bug discovered during regression testing for pandoc 1.15.
200 | 
201 | 
202 | pandoc-tablenos 0.7 (2016-01-23)
203 | 
204 |     * Fixed AttributeError bug that occurred for links
205 |       emphasized [*like this*](http://example.com/).
206 | 
207 |     * More work on autolink_bare_uris processing.
208 | 
209 | 
210 | pandoc-tablenos 0.6.1 (2016-01-13)
211 | 
212 |     * Fixed AttributeError bug that occurred for links
213 |       emphasized [*like this*](http://example.com/)
214 | 
215 |     * Fixed TypeError bug that occurred with pandoc < 1.16.
216 | 
217 | 
218 | pandoc-tablenos 0.6 (2016-01-11)
219 | 
220 |     * Fixed problems when --autolink_bare_uris is used.
221 | 
222 | 
223 | pandoc-tablenos 0.5 (2016-01-01)
224 | 
225 |     * Flush stdout before exiting.
226 | 
227 | 
228 | pandoc-tablenos 0.4 (2015-12-30)
229 | 
230 |     * Fixed treatment of curly-braced references in lists.
231 | 
232 | 
233 | pandoc-tablenos 0.3 (2015-07-17)
234 | 
235 |     * Construct links for html.
236 | 
237 | 
238 | pandoc-tablenos 0.2 (2015-07-15)
239 | 
240 |     * Enforce pandoc's requirement of UTF-8.
241 | 
242 | 
243 | pandoc-tablenos 0.1.1 (2015-06-07)
244 | 
245 |     * Fixed README.
246 | 
247 | 
248 | pandoc-tablenos 0.1 (2015-06-07)
249 | 
250 |     * initial release.
251 | 
252 | 


--------------------------------------------------------------------------------
/DEVELOPERS.md:
--------------------------------------------------------------------------------
  1 | 
  2 | Developer Notes
  3 | ===============
  4 | 
  5 | Contributions
  6 | -------------
  7 | 
  8 | Contributions to pandoc-tablenos are welcome.  Before implementing a new feature, it is best to discuss it in an Issue so that any potential problems can be resolved.  Pull Requests should be linked into the Issue when ready.
  9 | 
 10 | 
 11 | Design Philosophy
 12 | -----------------
 13 | 
 14 | 1. This should be easy.
 15 | 
 16 | 2. Features should be supported for *ALL* output formats.
 17 | 
 18 | 3. The native capabilities of each output format should be employed.
 19 | 
 20 |     
 21 | Branches
 22 | --------
 23 | 
 24 | The next release is developed in the `nextrelease` branch.  When ready, the changes are merged into the `master` branch.
 25 | 
 26 | A copy of the 1.x release series is maintained in the 1.x branch.
 27 | 
 28 | Demo outputs are stored in the `demos` branch.
 29 | 
 30 | 
 31 | Install Alternatives
 32 | --------------------
 33 | 
 34 | Installing from source may require upgrading `setuptools` by executing
 35 | 
 36 |     pip install --upgrade setuptools
 37 | 
 38 | as root (or under sudo).
 39 | 
 40 | There are a few different options for installing from source:
 41 |     
 42 | 1) To install from the github `master` branch use:
 43 | 
 44 |        pip install git+https://github.com/tomduck/pandoc-tablenos.git --user
 45 | 
 46 |    (to upgrade append the `--upgrade` flag).
 47 | 
 48 | 2) To install from the `nextrelease` branch on github, use
 49 | 
 50 |        pip install git+https://github.com/tomduck/pandoc-tablenos.git@nextrelease --user
 51 | 
 52 |    (to upgrade use the --upgrade flag).
 53 | 
 54 | 3) To install from a local source distribution, `cd` into its root
 55 |    and use
 56 | 
 57 |        pip install -e . --user
 58 | 
 59 |    Note that any changes made to the source will be automatically
 60 |    reflected when the filter is run (which is useful for development).
 61 | 
 62 | 
 63 | Testing
 64 | -------
 65 | 
 66 | Regression tests for pandoc-tablenos are provided in `test/`.  Read the README.md in that directory for instructions.
 67 | 
 68 | 
 69 | Preparing a Release
 70 | -------------------
 71 | 
 72 | These are notes for release managers.
 73 | 
 74 | 
 75 | ### Merging ####
 76 | 
 77 | Merge the `nextrelease` branch into `master` using
 78 | 
 79 |     git checkout master
 80 |     git merge nextrelease
 81 |     git push
 82 | 
 83 | 
 84 | ### Updating Demos ###
 85 | 
 86 | Starting from the root of the `master` branch, update demos in the `demos` branch using
 87 | 
 88 |     cd demos
 89 |     make -B
 90 |     git checkout demos
 91 |     cp -rf out/* ..
 92 |     git commit --amend -am "Updated demos."
 93 |     git push --force
 94 | 
 95 | This procedure ensures that there will only be a single revision of each file (see https://stackoverflow.com/a/22827188).
 96 | 
 97 | 
 98 | ### Tagging ###
 99 | 
100 | See https://www.python.org/dev/peps/pep-0440/ for numbering conventions, including for pre-releases.
101 | 
102 | Check that you are in the `master` branch.
103 | 
104 | Tagging  (update the version number):
105 | 
106 |     git tag -a 2.3.0 -m "New release."
107 |     git push origin 2.3.0
108 | 
109 | 
110 | ### Distributing ###
111 | 
112 | Create source and binary distributions using
113 | 
114 |     python3 setup.py sdist bdist_wheel
115 | 
116 | (see https://packaging.python.org/tutorials/packaging-projects/).
117 |     
118 | Upload to pypi (update the version number) using
119 | 
120 |     twine upload dist/pandoc-tablenos-2.3.0.tar.gz \
121 |                  dist/pandoc_tablenos-2.3.0-py3-none-any.whl
122 | 
123 | (see https://pypi.python.org/pypi/twine).
124 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <http://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <http://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <http://www.gnu.org/philosophy/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------
/MANIFEST.in:
--------------------------------------------------------------------------------
1 | include README.md
2 | include DEVELOPERS.md
3 | include LICENSE
4 | include ChangeLog
5 | include AUTHORS
6 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | 
  2 | **New in 2.3.0:** Updated for pandoc 2.11. 
  3 | 
  4 | [more...](#whats-new)
  5 | 
  6 | 
  7 | pandoc-tablenos 2.3.0
  8 | =====================
  9 | 
 10 | *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.
 11 | 
 12 | 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).
 13 | 
 14 | This version of pandoc-tablenos was tested using pandoc 1.15.2 - 2.11.1.1,<sup>[1](#footnote1)</sup> 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].
 15 | 
 16 | See also: [pandoc-fignos], [pandoc-eqnos], [pandoc-secnos] \
 17 | Other filters: [pandoc-comments], [pandoc-latex-extensions]
 18 | 
 19 | [pandoc]: http://pandoc.org/
 20 | [pandoc-xnos]: https://github.com/tomduck/pandoc-xnos
 21 | [Issues tracker]: https://github.com/tomduck/pandoc-tablenos/issues
 22 | [on GitHub]: https://github.com/tomduck/pandoc-tablenos
 23 | [pandoc-fignos]: https://github.com/tomduck/pandoc-fignos
 24 | [pandoc-eqnos]: https://github.com/tomduck/pandoc-eqnos
 25 | [pandoc-secnos]: https://github.com/tomduck/pandoc-secnos
 26 | [pandoc-comments]: https://github.com/tomduck/pandoc-comments
 27 | [pandoc-latex-extensions]: https://github.com/tomduck/pandoc-latex-extensions
 28 | 
 29 | 
 30 | Contents
 31 | --------
 32 | 
 33 |  1. [Installation](#installation)
 34 |  2. [Usage](#usage)
 35 |  3. [Markdown Syntax](#markdown-syntax)
 36 |  4. [Customization](#customization)
 37 |  5. [Technical Details](#technical-details)
 38 |  6. [Getting Help](#getting-help)
 39 |  7. [Development](#development)
 40 |  8. [What's New](#whats-new)
 41 | 
 42 | 
 43 | Installation
 44 | ------------
 45 | 
 46 | Pandoc-tablenos requires [python].  It is easily installed -- see [here](https://realpython.com/installing-python/).<sup>[2](#footnote2)</sup>  Either python 2.7 or 3.x will do.
 47 | 
 48 | Pandoc-tablenos may be installed using the shell command
 49 | 
 50 |     pip install pandoc-tablenos --user
 51 | 
 52 | 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.<sup>[3](#footnote3)</sup>
 53 | 
 54 | Instructions for installing from source are given in [DEVELOPERS.md].
 55 | 
 56 | [python]: https://www.python.org/
 57 | [PyPI]: https://pypi.python.org/pypi
 58 | [DEVELOPERS.md]: DEVELOPERS.md
 59 | 
 60 | 
 61 | Usage
 62 | -----
 63 | 
 64 | Pandoc-tablenos is activated by using the
 65 | 
 66 |     --filter pandoc-tablenos
 67 | 
 68 | option with pandoc.  Alternatively, use
 69 | 
 70 |     --filter pandoc-xnos
 71 | 
 72 | to activate all of the filters in the [pandoc-xnos] suite (if installed).
 73 | 
 74 | Any use of `--filter pandoc-citeproc` or `--bibliography=FILE` should come *after* the `pandoc-tablenos` or `pandoc-xnos` filter calls.
 75 | 
 76 | 
 77 | Markdown Syntax
 78 | ---------------
 79 | 
 80 | The cross-referencing syntax used by pandoc-tablenos was worked out in [pandoc Issue #813] -- see [this post] by [@scaramouche1].
 81 | 
 82 | To mark a table for numbering, add an id to its attributes:
 83 | 
 84 |     A B
 85 |     - -
 86 |     0 1
 87 | 
 88 |     Table: Caption. {#tbl:id}
 89 | 
 90 | 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.
 91 | 
 92 | To reference the table, use
 93 | 
 94 |     @tbl:id
 95 | 
 96 | or
 97 | 
 98 |     {@tbl:id}
 99 | 
100 | Curly braces protect a reference and are stripped from the output.
101 | 
102 | Demonstration: Processing [demo.md] with pandoc + pandoc-tablenos gives numbered tables and references in [pdf], [tex], [html], [epub], [docx] and other formats.
103 | 
104 | [pandoc Issue #813]: https://github.com/jgm/pandoc/issues/813
105 | [this post]: https://github.com/jgm/pandoc/issues/813#issuecomment-70423503
106 | [@scaramouche1]: https://github.com/scaramouche1
107 | [demo.md]: https://raw.githubusercontent.com/tomduck/pandoc-tablenos/master/demos/demo.md
108 | [pdf]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo.pdf
109 | [tex]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo.tex
110 | [html]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo.html
111 | [epub]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo.epub
112 | [docx]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo.docx
113 | 
114 | 
115 | ### Clever References ###
116 | 
117 | Writing markdown like
118 | 
119 |     See table @tbl:id.
120 | 
121 | seems a bit redundant.  Pandoc-tablenos supports "clever references" via single-character modifiers in front of a reference.  Users may write
122 | 
123 |      See +@tbl:id.
124 | 
125 | to have the reference name (i.e., "table") automatically generated.  The above form is used mid-sentence.  At the beginning of a sentence, use
126 | 
127 |      *@tbl:id
128 | 
129 | instead.  If clever references are enabled by default (see [Customization](#customization), below), then users may disable it for a given reference using<sup>[4](#footnote4)</sup>
130 | 
131 |     !@tbl:id
132 | 
133 | 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.
134 | 
135 | 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`.
136 | 
137 | [demo2.md]: https://raw.githubusercontent.com/tomduck/pandoc-tablenos/master/demos/demo2.md
138 | [pdf2]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo2.pdf
139 | [tex2]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo2.tex
140 | [html2]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo2.html
141 | [epub2]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo2.epub
142 | [docx2]: https://github.com/tomduck/pandoc-tablenos/blob/demos/demo2.docx
143 | 
144 | 
145 | ### Tagged Tables ###
146 | 
147 | The table number may be overridden by placing a tag in the table's attributes block as follows:
148 | 
149 |     A B
150 |     - -
151 |     0 1
152 | 
153 |     Table: Caption. {#tbl:id tag="B.1"}
154 | 
155 | The tag may be arbitrary text, or an inline equation such as `$\text{B.1}'$`.  Mixtures of the two are not currently supported.
156 | 
157 | 
158 | ### Disabling Links ###
159 | 
160 | To disable a link on a reference, set `nolink=True` in the reference's attributes:
161 | 
162 |     @tbl:id{nolink=True}
163 | 
164 | 
165 | Customization
166 | -------------
167 | 
168 | 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:
169 | 
170 |   * `tablenos-warning-level` or `xnos-warning-level` - Set to `0` for
171 |     no warnings, `1` for critical warnings, or `2` (default) for
172 |     all warnings.  Warning level 2 should be used when
173 |     troubleshooting.
174 | 
175 |   * `tablenos-cleveref` or just `cleveref` - Set to `True` to assume
176 |     "+" clever references by default;
177 | 
178 |   * `xnos-capitalise` - Capitalises the names of "+" references
179 |     (e.g., change from "table" to "Table");
180 | 
181 |   * `tablenos-plus-name` - Sets the name of a "+" reference 
182 |     (e.g., change it from "table" to "tab.").  Settings here take
183 |     precedence over `xnos-capitalise`;
184 | 
185 |   * `tablenos-star-name` - Sets the name of a "*" reference 
186 |     (e.g., change it from "Table" to "Tab.");
187 | 
188 |   * `tablenos-caption-name` - Sets the name at the beginning of a
189 |     caption (e.g., change it from "Table to "Tab.");
190 | 
191 |   * `tablenos-caption-separator` or `xnos-caption-separator` - Sets 
192 |     the caption separator (e.g., the colon in "Table 1:") to
193 |     something else.  It must be one of `none`, `colon`,
194 |     `period`, `space`, `quad`, or `newline`; and
195 | 
196 |   * `tablenos-number-by-section` or `xnos-number-by-section` - Set to
197 |     `True` to number tables by section (i.e. Table 1.1, 1.2, etc in
198 |     Section 1, and Table 2.1, 2.2, etc in Section 2).  For LaTeX/pdf,
199 |     html, and epub output, this feature should be used together with
200 |     pandoc's `--number-sections`
201 |     [option](https://pandoc.org/MANUAL.html#option--number-sections)
202 |     enabled.  For docx, use [docx custom styles] instead.
203 | 
204 |     This option should not be set for numbering by chapter in
205 |     LaTeX/pdf book document classes.
206 | 
207 |   * `xnos-number-offset` - Set to an integer to offset the section
208 |     numbers when numbering tables by section.  For html and epub
209 |     output, this feature should be used together with pandoc's
210 |     `--number-offset`
211 |     [option](https://pandoc.org/MANUAL.html#option--number-sections)
212 |     set to the same integer value.  For LaTeX/pdf, this option
213 |     offsets the actual section numbers as required.
214 | 
215 | 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.
216 | 
217 | 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.
218 | 
219 | [metadata block]: http://pandoc.org/README.html#extension-yaml_metadata_block
220 | [docx custom styles]: https://pandoc.org/MANUAL.html#custom-styles
221 | [demo3.md]: https://raw.githubusercontent.com/tomduck/pandoc-tablenos/master/demos/demo3.md
222 | [pdf3]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo3.pdf
223 | [tex3]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo3.tex
224 | [html3]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo3.html
225 | [epub3]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo3.epub
226 | [docx3]: https://raw.githack.com/tomduck/pandoc-tablenos/demos/demo3.docx
227 | 
228 | 
229 | Technical Details
230 | -----------------
231 | 
232 | ### LaTeX/pdf Output ###
233 | 
234 | 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`.
235 | 
236 | An example reference in LaTeX looks like
237 | 
238 | ~~~latex
239 | See \cref{tbl:1}.
240 | ~~~
241 | 
242 | An example table looks like
243 | 
244 | ~~~latex
245 | \begin{longtable}[]{@{}rlcl@{}}
246 |   \caption{Demonstration of a simple table.
247 |   \label{tbl:1}}\tabularnewline
248 |   \toprule
249 |   Right & Left & Center & Default\tabularnewline
250 |   \midrule
251 |   \endfirsthead
252 |   \toprule
253 |   Right & Left & Center & Default\tabularnewline
254 |   \midrule
255 |   \endhead
256 |   12  & 12  & 12  & 12  \tabularnewline
257 |   123 & 123 & 123 & 123 \tabularnewline
258 |   \bottomrule
259 | \end{longtable}
260 | ~~~
261 | 
262 | Other details:
263 | 
264 |   * The `cleveref` and `caption` packages are used for clever
265 |     references and caption control, respectively; 
266 |   * The `\label` and `\ref` macros are used for table labels and
267 |     references, respectively (`\Cref` and `\cref` are used for
268 |     clever references);
269 |   * Clever reference names are set with `\Crefname` and `\crefname`;
270 |   * The caption name is set with`\tablename`;
271 |   * Tags are supported by way of a custom environment that
272 |     temporarily redefines `\thetable`; and
273 |   * Caption prefixes (e.g., "Table 1:") are disabled for
274 |     unnumbered tables by way of a custom environment that uses
275 |     `\captionsetup`.
276 | 
277 | 
278 | ### Other Output Formats ###
279 | 
280 | An example reference in html looks like
281 | 
282 | ~~~html
283 | See table <a href="#tbl:1">1</a>.
284 | ~~~
285 | 
286 | An example table looks like
287 | 
288 | ~~~html
289 | <div id="tbl:1" class="tablenos">
290 |   <table>
291 |     <caption>
292 |       <span>Table 1:</span> Demonstration of a simple table.
293 |     </caption>
294 |     <thead>
295 |       <tr class="header">
296 |         <th style="text-align: right;">Right</th>
297 |         <th style="text-align: left;">Left</th>
298 |         <th style="text-align: center;">Center</th>
299 |         <th>Default</th>
300 |       </tr>
301 |     </thead>
302 |     <tbody>
303 |       <tr class="odd">
304 |         <td style="text-align: right;">12</td>
305 |         <td style="text-align: left;">12</td>
306 |         <td style="text-align: center;">12</td>
307 |        <td>12</td>
308 |       </tr>
309 |       <tr class="even">
310 |         <td style="text-align: right;">123</td>
311 |         <td style="text-align: left;">123</td>
312 |         <td style="text-align: center;">123</td>
313 |         <td>123</td>
314 |       </tr>
315 |     </tbody>
316 |   </table>
317 | </div>
318 | ~~~
319 | 
320 | The table is wrapped in a `<div></div>` with an `id` for linking and with class `tablenos` to allow for css styling.
321 | 
322 | 
323 | ### Docx Output ###
324 | 
325 | Docx OOXML output is under development and subject to change.  Native capabilities will be used wherever possible.
326 | 
327 | 
328 | Getting Help
329 | ------------
330 | 
331 | 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].
332 | 
333 | 
334 | Development
335 | -----------
336 | 
337 | 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.
338 | 
339 | Developer notes are maintained in [DEVELOPERS.md].
340 | 
341 | 
342 | What's New
343 | ----------
344 | 
345 | **New in 2.3.0:** Updated for pandoc 2.11. 
346 | 
347 | **New in 2.2.2:** Updated for pandoc 2.10.1.
348 | 
349 | **New in 2.1.1:** Warnings are now given for duplicate reference targets.
350 | 
351 | **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.
352 | 
353 | 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.
354 | 
355 | 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.
356 | 
357 | 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].
358 | 
359 | 
360 | *LaTeX/PDF:*
361 | 
362 | 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.
363 | 
364 | 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`.
365 | 
366 | 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.
367 | 
368 | 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`.
369 | 
370 | 
371 | *Html/Epub:*
372 | 
373 | The table is now enclosed in a `<div>` which contains the `id` and class `tablenos`.  This change was made to facilitate styling.  The `id` was formerly contained in an anchor tag.
374 | 
375 | Epub support is generally improved.
376 | 
377 | 
378 | ----
379 | 
380 | **Footnotes**
381 | 
382 | <a name="footnote1">1</a>: Pandoc 2.4 [broke](https://github.com/jgm/pandoc/issues/5099) how references are parsed, and so is not supported.
383 | 
384 | <a name="footnote2">2</a>: For MacOS, my preferred install method is to use the package [available from python.org](https://www.python.org/downloads/).
385 | 
386 | <a name="footnote3">3</a>: 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/).
387 | 
388 | <a name="footnote4">4</a>: The disabling modifier "!" is used instead of "-" because [pandoc drops minus signs] in front of references.
389 | 
390 | [pandoc drops minus signs]: https://github.com/jgm/pandoc/issues/2901
391 | 


--------------------------------------------------------------------------------
/demos/Makefile:
--------------------------------------------------------------------------------
 1 | 
 2 | extensions = .pdf .html .epub .tex .docx
 3 | 
 4 | dest = $(addprefix out/demo,$(extensions)) \
 5 |        $(addprefix out/demo2,$(extensions)) \
 6 |        $(addprefix out/demo3,$(extensions))
 7 | 
 8 | 
 9 | all: $(dest) 
10 | 
11 | 
12 | $(filter out/demo.%,$(dest)): demo.md
13 | $(filter out/demo2.%,$(dest)): demo2.md
14 | $(filter out/demo3.%,$(dest)): demo3.md
15 | 
16 | 
17 | out/%.pdf: %.md
18 | 	@if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi
19 | 	pandoc $< --filter pandoc-tablenos --variable urlcolor=blue -o $@
20 | 
21 | out/%.html: %.md
22 | 	@if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi
23 | 	pandoc $< --standalone --filter pandoc-tablenos --include-in-header=headers/header.html -o $@
24 | 
25 | out/%.epub: %.md
26 | 	@if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi
27 | 	pandoc $< -t epub3 --filter pandoc-tablenos --include-in-header=headers/header.epub -o $@
28 | 
29 | out/%:
30 | 	@if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi
31 | 	pandoc $^ --filter pandoc-tablenos -o $@
32 | 
33 | 
34 | restore: clean
35 | 	for num in "" 2 3 ; do \
36 |       for ext in $(extensions) ; do \
37 |         git checkout out/demo$$num$$ext ; \
38 |       done ; \
39 |     done
40 | 
41 | 
42 | .PHONY: clean
43 | 
44 | clean:
45 | 	rm -rf out
46 | 


--------------------------------------------------------------------------------
/demos/demo.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: Pandoc-tablenos Demo
 3 | ...
 4 | 
 5 |   Right     Left     Center     Default
 6 | -------     ------ ----------   -------
 7 |      12     12        12            12
 8 |     123     123       123          123
 9 |       1     1          1             1
10 | 
11 | Table: Demonstration of a simple table. {#tbl:1}
12 | 
13 | Table @tbl:1 is from the Pandoc User's Guide.  A simpler table is given by table @tbl:2:
14 | 
15 | A B
16 | - -
17 | 0 1
18 | 
19 | Table: Even simpler. {#tbl:2 width=2in}
20 | 


--------------------------------------------------------------------------------
/demos/demo2.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: Pandoc-tablenos Demo
 3 | ...
 4 | 
 5 |   Right     Left     Center     Default
 6 | -------     ------ ----------   -------
 7 |      12     12        12            12
 8 |     123     123       123          123
 9 |       1     1          1             1
10 | 
11 | Table: Demonstration of a simple table. {#tbl:1}
12 | 
13 | *@tbl:1 is from the Pandoc User's Guide.  A simpler table is given by +@tbl:2:
14 | 
15 | A B
16 | - -
17 | 0 1
18 | 
19 | Table: Even simpler. {#tbl:2}
20 | 


--------------------------------------------------------------------------------
/demos/demo3.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: Pandoc-tablenos Demo
 3 | tablenos-cleveref: True
 4 | tablenos-plus-name: Tab.
 5 | ...
 6 | 
 7 |   Right     Left     Center     Default
 8 | -------     ------ ----------   -------
 9 |      12     12        12            12
10 |     123     123       123          123
11 |       1     1          1             1
12 | 
13 | Table: Demonstration of a simple table. {#tbl:1}
14 | 
15 | *@tbl:1 is from the Pandoc User's Guide.  A simpler table is given by @tbl:2:
16 | 
17 | A B
18 | - -
19 | 0 1
20 | 
21 | Table: Even simpler. {#tbl:2}
22 | 


--------------------------------------------------------------------------------
/demos/headers/header.epub:
--------------------------------------------------------------------------------
1 | <style>
2 | .tablenos table {display:flex; flex-direction: column; align-items:center;}
3 | </style>


--------------------------------------------------------------------------------
/demos/headers/header.html:
--------------------------------------------------------------------------------
1 | <style>
2 | html {margin: 0 auto; max-width: 5in;}
3 | .tablenos table {display:flex; flex-direction: column; align-items:center;}
4 | </style>


--------------------------------------------------------------------------------
/pandoc_tablenos.py:
--------------------------------------------------------------------------------
  1 | #! /usr/bin/env python
  2 | 
  3 | """pandoc-tablenos: a pandoc filter that inserts table nos. and refs."""
  4 | 
  5 | 
  6 | __version__ = '2.3.0'
  7 | 
  8 | 
  9 | # Copyright 2015-2020 Thomas J. Duck.
 10 | # All rights reserved.
 11 | #
 12 | # This program is free software: you can redistribute it and/or modify
 13 | # it under the terms of the GNU General Public License as published by
 14 | # the Free Software Foundation, version 3.
 15 | #
 16 | # This program is distributed in the hope that it will be useful,
 17 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
 18 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 19 | # GNU General Public License for more details.
 20 | #
 21 | # You should have received a copy of the GNU General Public License
 22 | # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 23 | 
 24 | 
 25 | # OVERVIEW
 26 | #
 27 | # The basic idea is to scan the document twice in order to:
 28 | #
 29 | #   1. Insert text for the table number in each table caption.
 30 | #      For LaTeX, insert \label{...} instead.  The table labels
 31 | #      and associated table numbers are stored in the global
 32 | #      targets tracker.
 33 | #
 34 | #   2. Replace each reference with a table number.  For LaTeX,
 35 | #      replace with \ref{...} instead.
 36 | #
 37 | # This is followed by injecting header code as needed for certain output
 38 | # formats.
 39 | 
 40 | 
 41 | # pylint: disable=invalid-name
 42 | 
 43 | import re
 44 | import functools
 45 | import argparse
 46 | import json
 47 | import copy
 48 | import textwrap
 49 | import uuid
 50 | 
 51 | from pandocfilters import walk
 52 | from pandocfilters import Table, Str, Space, RawBlock, RawInline, Math, Span
 53 | 
 54 | import pandocxnos
 55 | from pandocxnos import PandocAttributes
 56 | from pandocxnos import STRTYPES, STDIN, STDOUT, STDERR
 57 | from pandocxnos import NBSP
 58 | from pandocxnos import elt, check_bool, get_meta, extract_attrs
 59 | from pandocxnos import repair_refs, process_refs_factory, replace_refs_factory
 60 | from pandocxnos import insert_secnos_factory, delete_secnos_factory
 61 | from pandocxnos import attach_attrs_factory, detach_attrs_factory
 62 | from pandocxnos import version
 63 | 
 64 | 
 65 | # Patterns for matching labels and references
 66 | LABEL_PATTERN = re.compile(r'(tbl:[\w/-]*)')
 67 | 
 68 | # Meta variables; may be reset elsewhere
 69 | captionname = 'Table'   # The caption name
 70 | separator = 'colon'     # The caption separator
 71 | cleveref = False        # Flags that clever references should be used
 72 | capitalise = False      # Default setting for capitalizing plusname
 73 | plusname = ['table', 'tables']  # Sets names for mid-sentence references
 74 | starname = ['Table', 'Tables']  # Sets names for references at sentence start
 75 | numbersections = False  # Flags that tables should be numbered by section
 76 | secoffset = 0           # Section number offset
 77 | warninglevel = 2        # 0 - no warnings; 1 - some warnings; 2 - all warnings
 78 | 
 79 | # Processing state variables
 80 | cursec = None  # Current section
 81 | Ntargets = 0   # Number of targets in current section (or document)
 82 | targets = {}   # Global targets tracker
 83 | 
 84 | # Processing flags
 85 | captionname_changed = False     # Flags the caption name changed
 86 | separator_changed = False       # Flags the caption separator changed
 87 | plusname_changed = False        # Flags that the plus name changed
 88 | starname_changed = False        # Flags that the star name changed
 89 | has_unnumbered_tables = False   # Flags unnumbered tables were found
 90 | has_tagged_tables = False       # Flags a tagged table was found
 91 | 
 92 | PANDOCVERSION = None
 93 | AttrTable = None
 94 | 
 95 | 
 96 | # Actions --------------------------------------------------------------------
 97 | 
 98 | # pylint: disable=unused-argument
 99 | def attach_attrs_table(key, value, fmt, meta):
100 |     """Extracts attributes and attaches them to element."""
101 | 
102 |     # We can't use attach_attrs_factory() because Table is a block-level element
103 | 
104 |     # Tables are attributed as of pandoc 2.10.  There is no native mechanism
105 |     # (yet) to populate those attributes.  This is coming.  See the
106 |     # Revision history for pandoc 2.10.1 at https://pandoc.org/releases.html.
107 | 
108 |     if key in ['Table']:
109 |         if version(PANDOCVERSION) < version('2.10'):
110 |             assert len(value) == 5
111 |             caption = value[0]  # caption, align, x, head, body
112 |         elif version(PANDOCVERSION) < version('2.11'):
113 |             assert len(value) == 6
114 |             assert value[1]['t'] == 'Caption'
115 |             if value[1]['c'][1]:
116 |                 assert value[1]['c'][1][0]['t'] == 'Plain'
117 |                 caption = value[1]['c'][1][0]['c']
118 |             else:
119 |                 return  # There is no caption
120 |         else:
121 |             assert len(value) == 6
122 |             assert value[1][0] is None
123 |             if value[1][1]:
124 |                 assert value[1][1][0]['t'] == 'Plain'
125 |                 caption = value[1][1][0]['c']
126 |             else:
127 |                 return  # There is no caption
128 | 
129 |         # Set n to the index where the attributes start
130 |         n = 0
131 |         while n < len(caption) and not \
132 |           (caption[n]['t'] == 'Str' and caption[n]['c'].startswith('{')):
133 |             n += 1
134 | 
135 |         try:
136 |             # Read the attributes from the caption
137 |             attrs = extract_attrs(caption, n)
138 |             if version(PANDOCVERSION) < version('2.10'):
139 |                 # Insert the attributes
140 |                 value.insert(0, attrs.list)
141 |             else:
142 |                 # Overwrite the attributes
143 |                 value[0] = attrs.list
144 |         except (ValueError, IndexError):
145 |             pass
146 | 
147 | # pylint: disable=too-many-branches
148 | def _process_table(value, fmt):
149 |     """Processes the table.  Returns a dict containing table properties."""
150 | 
151 |     # pylint: disable=global-statement
152 |     global cursec    # Current section being processed
153 |     global Ntargets  # Number of refs in current section (or document)
154 |     global has_unnumbered_tables  # Flags unnumbered tables were found
155 | 
156 |     # Initialize the return value
157 |     table = {'is_unnumbered': False,
158 |              'is_unreferenceable': False,
159 |              'is_tagged': False}
160 | 
161 |     # Bail out if there are no attributes
162 |     if len(value) == 5:
163 |         has_unnumbered_tables = True
164 |         table.update({'is_unnumbered': True, 'is_unreferenceable': True})
165 |         return table
166 | 
167 |     # Parse the table
168 |     attrs = table['attrs'] = PandocAttributes(value[0], 'pandoc')
169 |     if version(PANDOCVERSION) < version('2.10'):
170 |         table['caption'] = value[1]
171 |     elif version(PANDOCVERSION) < version('2.11'):
172 |         if value[1]['c'][1]:
173 |             table['caption'] = value[1]['c'][1][0]['c']
174 |         else:
175 |             table['caption'] = []
176 |     else:
177 |         if value[1][1]:
178 |             table['caption'] = value[1][1][0]['c']
179 |         else:
180 |             table['caption'] = []
181 | 
182 |     # Bail out if the label does not conform to expectations
183 |     if not LABEL_PATTERN.match(attrs.id):
184 |         has_unnumbered_tables = True
185 |         table.update({'is_unnumbered':True, 'is_unreferenceable':True})
186 |         return table
187 | 
188 |     # Identify unreferenceable tables
189 |     if attrs.id == 'tbl:': # Make up a unique description
190 |         attrs.id = 'tbl:' + str(uuid.uuid4())
191 |         table['is_unreferenceable'] = True
192 | 
193 |     # Update the current section number
194 |     if attrs['secno'] != cursec:  # The section number changed
195 |         cursec = attrs['secno']   # Update the global section tracker
196 |         if numbersections:
197 |             Ntargets = 0          # Resets the global target counter
198 | 
199 |     # Increment the targets counter
200 |     if 'tag' not in attrs:
201 |         Ntargets += 1
202 | 
203 |     # Pandoc's --number-sections supports section numbering latex/pdf, html,
204 |     # epub, and docx
205 |     if numbersections:
206 |         if fmt in ['html', 'html4', 'html5', 'epub', 'epub2', 'epub3',
207 |                    'docx'] and \
208 |           'tag' not in attrs:
209 |             attrs['tag'] = str(cursec+secoffset) + '.' + str(Ntargets)
210 | 
211 |     # Save reference information
212 |     table['is_tagged'] = 'tag' in attrs
213 |     if table['is_tagged']:
214 |         # Remove any surrounding quotes
215 |         if attrs['tag'][0] == '"' and attrs['tag'][-1] == '"':
216 |             attrs['tag'] = attrs['tag'].strip('"')
217 |         elif attrs['tag'][0] == "'" and attrs['tag'][-1] == "'":
218 |             attrs['tag'] = attrs['tag'].strip("'")
219 |         targets[attrs.id] = pandocxnos.Target(attrs['tag'], cursec,
220 |                                               attrs.id in targets)
221 |     else:  # ... then save the table number
222 |         targets[attrs.id] = pandocxnos.Target(Ntargets, cursec,
223 |                                               attrs.id in targets)
224 | 
225 |     return table
226 | 
227 | 
228 | # pylint: disable=too-many-statements
229 | def _adjust_caption(fmt, table, value):
230 |     """Adjusts the caption."""
231 |     attrs, caption = table['attrs'], table['caption']
232 |     num = targets[attrs.id].num
233 |     if fmt in['latex', 'beamer']:  # Append a \label if this is referenceable
234 |         if not table['is_unreferenceable']:
235 |             tmp = [RawInline('tex', r'\label{%s}'%attrs.id)]
236 |             if version(PANDOCVERSION) < version('2.10'):
237 |                 value[1] += tmp
238 |             elif version(PANDOCVERSION) < version('2.11'):
239 |                 value[1]['c'][1][0]['c'] += tmp
240 |             else:
241 |                 value[1][1][0]['c'] += tmp
242 | 
243 |     else:  # Hard-code in the caption name and number/tag
244 |         sep = {'none':'', 'colon':':', 'period':'.', 'space':' ',
245 |                'quad':u'\u2000', 'newline':'\n'}[separator]
246 | 
247 |         if isinstance(num, int):  # Numbered reference
248 |             if fmt in ['html', 'html4', 'html5', 'epub', 'epub2', 'epub3']:
249 |                 tmp = [RawInline('html', r'<span>'),
250 |                        Str(captionname+NBSP), Str('%d%s'%(num, sep)),
251 |                        RawInline('html', r'</span>')]
252 |                 if version(PANDOCVERSION) < version('2.10'):
253 |                     value[1] = tmp
254 |                 elif version(PANDOCVERSION) < version('2.11'):
255 |                     value[1]['c'][1][0]['c'] = tmp
256 |                 else:
257 |                     value[1][1][0]['c'] = tmp
258 |             else:
259 |                 tmp = [Str(captionname+NBSP), Str('%d%s'%(num, sep))]
260 |                 if version(PANDOCVERSION) < version('2.10'):
261 |                     value[1] = tmp
262 |                 elif version(PANDOCVERSION) < version('2.11'):
263 |                     value[1]['c'][1][0]['c'] = tmp
264 |                 else:
265 |                     value[1][1][0]['c'] = tmp
266 |         else:  # Tagged reference
267 |             assert isinstance(num, STRTYPES)
268 |             if num.startswith('$') and num.endswith('$'):
269 |                 math = num.replace(' ', r'\ ')[1:-1]
270 |                 els = [Math({"t":"InlineMath", "c":[]}, math), Str(sep)]
271 |             else:  # Text
272 |                 els = [Str(num + sep)]
273 |             if fmt in ['html', 'html4', 'html5', 'epub', 'epub2', 'epub3']:
274 |                 tmp = [RawInline('html', r'<span>'),
275 |                        Str(captionname+NBSP)] + \
276 |                       els + [RawInline('html', r'</span>')]
277 |                 if version(PANDOCVERSION) < version('2.10'):
278 |                     value[1] = tmp
279 |                 elif version(PANDOCVERSION) < version('2.11'):
280 |                     value[1]['c'][1][0]['c'] = tmp
281 |                 else:
282 |                     value[1][1][0]['c'] = tmp
283 |             else:
284 |                 tmp = [Str(captionname+NBSP)] + els
285 |                 if version(PANDOCVERSION) < version('2.10'):
286 |                     value[1] = tmp
287 |                 elif version(PANDOCVERSION) < version('2.11'):
288 |                     value[1]['c'][1][0]['c'] = tmp
289 |                 else:
290 |                     value[1][1][0]['c'] = tmp
291 | 
292 |         tmp = [Space()] + list(caption)
293 |         if version(PANDOCVERSION) < version('2.10'):
294 |             value[1] += tmp
295 |         elif version(PANDOCVERSION) < version('2.11'):
296 |             value[1]['c'][1][0]['c'] += tmp
297 |         else:
298 |             value[1][1][0]['c'] += tmp
299 | 
300 | def _add_markup(fmt, table, value):
301 |     """Adds markup to the output."""
302 | 
303 |     # pylint: disable=global-statement
304 |     global has_tagged_tables  # Flags a tagged tables was found
305 | 
306 |     if table['is_unnumbered']:
307 |         if fmt in ['latex', 'beamer']:
308 |             # Use the no-prefix-table-caption environment
309 |             return [RawBlock('tex',
310 |                              r'\begin{tablenos:no-prefix-table-caption}'),
311 |                     Table(*(value if len(value) == 5 or \
312 |                             version(PANDOCVERSION) >= version('2.10') \
313 |                             else value[1:])),
314 |                     RawBlock('tex', r'\end{tablenos:no-prefix-table-caption}')]
315 |         return None  # Nothing to do
316 | 
317 |     attrs = table['attrs']
318 |     ret = None
319 | 
320 |     if fmt in ['latex', 'beamer']:
321 |         if table['is_tagged']:  # A table cannot be tagged if it is unnumbered
322 |             has_tagged_tables = True
323 |             ret = [RawBlock('tex', r'\begin{tablenos:tagged-table}[%s]' % \
324 |                             targets[attrs.id].num),
325 |                    AttrTable(*value),
326 |                    RawBlock('tex', r'\end{tablenos:tagged-table}')]
327 |     elif fmt in ('html', 'html4', 'html5', 'epub', 'epub2', 'epub3'):
328 |         if LABEL_PATTERN.match(attrs.id):
329 |             # Enclose table in hidden div
330 |             pre = RawBlock('html', '<div id="%s" class="tablenos">'%attrs.id)
331 |             post = RawBlock('html', '</div>')
332 |             ret = [pre, AttrTable(*value), post]
333 |     elif fmt == 'docx':
334 |         # As per http://officeopenxml.com/WPhyperlink.php
335 |         bookmarkstart = \
336 |           RawBlock('openxml',
337 |                    '<w:bookmarkStart w:id="0" w:name="%s"/>'
338 |                    %attrs.id)
339 |         bookmarkend = \
340 |           RawBlock('openxml', '<w:bookmarkEnd w:id="0"/>')
341 |         ret = [bookmarkstart, AttrTable(*value), bookmarkend]
342 |     return ret
343 | 
344 | 
345 | # pylint: disable=unused-argument, too-many-return-statements
346 | def process_tables(key, value, fmt, meta):
347 |     """Processes the attributed tables."""
348 | 
349 |     # Process block-level Table elements
350 |     if key == 'Table':
351 | 
352 |         # Process the table
353 |         table = _process_table(value, fmt)
354 |         if 'attrs' in table and table['attrs'].id:
355 |             _adjust_caption(fmt, table, value)
356 |         return _add_markup(fmt, table, value)
357 | 
358 |     return None
359 | 
360 | 
361 | # TeX blocks -----------------------------------------------------------------
362 | 
363 | # Define an environment that disables table caption prefixes.  Counters
364 | # must be saved and later restored.  The \thetable and \theHtable counter
365 | # must be set to something unique so that duplicate internal names are avoided
366 | # (see Sect. 3.2 of
367 | # http://ctan.mirror.rafal.ca/macros/latex/contrib/hyperref/doc/manual.html).
368 | NO_PREFIX_CAPTION_ENV_TEX = r"""
369 | %% pandoc-tablenos: environment to disable table caption prefixes
370 | \makeatletter
371 | \newcounter{tableno}
372 | \newenvironment{tablenos:no-prefix-table-caption}{
373 |   \caption@ifcompatibility{}{
374 |     \let\oldthetable\thetable
375 |     \let\oldtheHtable\theHtable
376 |     \renewcommand{\thetable}{tableno:\thetableno}
377 |     \renewcommand{\theHtable}{tableno:\thetableno}
378 |     \stepcounter{tableno}
379 |     \captionsetup{labelformat=empty}
380 |   }
381 | }{
382 |   \caption@ifcompatibility{}{
383 |     \captionsetup{labelformat=default}
384 |     \let\thetable\oldthetable
385 |     \let\theHtable\oldtheHtable
386 |     \addtocounter{table}{-1}
387 |   }
388 | }
389 | \makeatother
390 | """
391 | 
392 | # Define an environment for tagged tables
393 | TAGGED_TABLE_ENV_TEX = r"""
394 | %% pandoc-tablenos: environment for tagged tables
395 | \newenvironment{tablenos:tagged-table}[1][]{
396 |   \let\oldthetable\thetable
397 |   \let\oldtheHtable\theHtable
398 |   \renewcommand{\thetable}{#1}
399 |   \renewcommand{\theHtable}{#1}
400 | }{
401 |   \let\thetable\oldthetable
402 |   \let\theHtable\oldtheHtable
403 |   \addtocounter{table}{-1}
404 | }
405 | """
406 | 
407 | # Reset the caption name; i.e. change "Table" at the beginning of a caption
408 | # to something else.
409 | CAPTION_NAME_TEX = r"""
410 | %% pandoc-tablenos: change the caption name
411 | \renewcommand{\tablename}{%s}
412 | """
413 | 
414 | # Reset the label separator; i.e. change the colon after "Table 1:" to
415 | # something else.
416 | CAPTION_SEPARATOR_TEX = r"""
417 | %% pandoc-tablenos: change the caption separator
418 | \captionsetup[table]{labelsep=%s}
419 | """
420 | 
421 | # Define some tex to number tables by section
422 | NUMBER_BY_SECTION_TEX = r"""
423 | %% pandoc-tablenos: number tables by section
424 | \numberwithin{table}{section}
425 | """
426 | 
427 | # Section number offset
428 | SECOFFSET_TEX = r"""
429 | %% pandoc-fignos: section number offset
430 | \setcounter{section}{%s}
431 | """
432 | 
433 | 
434 | # Main program ---------------------------------------------------------------
435 | 
436 | # pylint: disable=too-many-branches,too-many-statements
437 | def process(meta):
438 |     """Saves metadata fields in global variables and returns a few
439 |     computed fields."""
440 | 
441 |     # pylint: disable=global-statement
442 |     global captionname     # The caption name
443 |     global separator       # The caption separator
444 |     global cleveref        # Flags that clever references should be used
445 |     global capitalise      # Flags that plusname should be capitalised
446 |     global plusname        # Sets names for mid-sentence references
447 |     global starname        # Sets names for references at sentence start
448 |     global numbersections  # Flags that sections should be numbered by section
449 |     global secoffset       # Section number offset
450 |     global warninglevel    # 0 - no warnings; 1 - some; 2 - all
451 |     global captionname_changed  # Flags the caption name changed
452 |     global separator_changed    # Flags the caption separator changed
453 |     global plusname_changed     # Flags that the plus name changed
454 |     global starname_changed     # Flags that the star name changed
455 | 
456 |     # Read in the metadata fields and do some checking
457 | 
458 |     for name in ['tablenos-warning-level', 'xnos-warning-level']:
459 |         if name in meta:
460 |             warninglevel = int(get_meta(meta, name))
461 |             pandocxnos.set_warning_level(warninglevel)
462 |             break
463 | 
464 |     metanames = ['tablenos-warning-level', 'xnos-warning-level',
465 |                  'tablenos-caption-name',
466 |                  'tablenos-caption-separator', 'xnos-caption-separator',
467 |                  'tablenos-cleveref', 'xnos-cleveref',
468 |                  'xnos-capitalise', 'xnos-capitalize',
469 |                  'tablenos-plus-name', 'tablenos-star-name',
470 |                  'tablenos-number-by-section', 'xnos-number-by-section',
471 |                  'xnos-number-offset']
472 | 
473 |     if warninglevel:
474 |         for name in meta:
475 |             if (name.startswith('tablenos') or name.startswith('xnos')) and \
476 |               name not in metanames:
477 |                 msg = textwrap.dedent("""
478 |                           pandoc-tablenos: unknown meta variable "%s"
479 |                       """ % name)
480 |                 STDERR.write(msg)
481 | 
482 |     if 'tablenos-caption-name' in meta:
483 |         old_captionname = captionname
484 |         captionname = get_meta(meta, 'tablenos-caption-name')
485 |         captionname_changed = captionname != old_captionname
486 |         assert isinstance(captionname, STRTYPES)
487 | 
488 |     for name in ['tablenos-caption-separator', 'xnos-caption-separator']:
489 |         if name in meta:
490 |             old_separator = separator
491 |             separator = get_meta(meta, name)
492 |             if separator not in \
493 |               ['none', 'colon', 'period', 'space', 'quad', 'newline']:
494 |                 msg = textwrap.dedent("""
495 |                           pandoc-tablenos: caption separator must be one of
496 |                           none, colon, period, space, quad, or newline.
497 |                       """ % name)
498 |                 STDERR.write(msg)
499 |                 continue
500 |             separator_changed = separator != old_separator
501 |             break
502 | 
503 |     for name in ['tablenos-cleveref', 'xnos-cleveref']:
504 |         # 'xnos-cleveref' enables cleveref in all 3 of fignos/eqnos/tablenos
505 |         if name in meta:
506 |             cleveref = check_bool(get_meta(meta, name))
507 |             break
508 | 
509 |     for name in ['xnos-capitalize', 'xnos-capitalise']:
510 |         # 'xnos-capitalise' enables capitalise in all 3 of
511 |         # fignos/eqnos/tablenos.  Since this uses an option in the caption
512 |         # package, it is not possible to select between the three (use
513 |         # 'tablenos-plus-name' instead.  'xnos-capitalize' is an alternative
514 |         # spelling
515 |         if name in meta:
516 |             capitalise = check_bool(get_meta(meta, name))
517 |             break
518 | 
519 |     if 'tablenos-plus-name' in meta:
520 |         tmp = get_meta(meta, 'tablenos-plus-name')
521 |         old_plusname = copy.deepcopy(plusname)
522 |         if isinstance(tmp, list):  # The singular and plural forms were given
523 |             plusname = tmp
524 |         else:  # Only the singular form was given
525 |             plusname[0] = tmp
526 |         plusname_changed = plusname != old_plusname
527 |         assert len(plusname) == 2
528 |         for name in plusname:
529 |             assert isinstance(name, STRTYPES)
530 |         if plusname_changed:
531 |             starname = [name.title() for name in plusname]
532 | 
533 |     if 'tablenos-star-name' in meta:
534 |         tmp = get_meta(meta, 'tablenos-star-name')
535 |         old_starname = copy.deepcopy(starname)
536 |         if isinstance(tmp, list):
537 |             starname = tmp
538 |         else:
539 |             starname[0] = tmp
540 |         starname_changed = starname != old_starname
541 |         assert len(starname) == 2
542 |         for name in starname:
543 |             assert isinstance(name, STRTYPES)
544 | 
545 |     for name in ['tablenos-number-by-section', 'xnos-number-by-section']:
546 |         if name in meta:
547 |             numbersections = check_bool(get_meta(meta, name))
548 |             break
549 | 
550 |     if 'xnos-number-offset' in meta:
551 |         secoffset = int(get_meta(meta, 'xnos-number-offset'))
552 | 
553 | def add_tex(meta):
554 |     """Adds text to the meta data."""
555 | 
556 |     # pylint: disable=too-many-boolean-expressions
557 |     warnings = warninglevel == 2 and (has_unnumbered_tables or \
558 |       (targets and (pandocxnos.cleveref_required() or \
559 |        separator_changed or plusname_changed or starname_changed \
560 |        or has_tagged_tables or captionname_changed or numbersections \
561 |        or secoffset)))
562 |     if warnings:
563 |         msg = textwrap.dedent("""\
564 |                   pandoc-tablenos: Wrote the following blocks to
565 |                   header-includes.  If you use pandoc's
566 |                   --include-in-header option then you will need to
567 |                   manually include these yourself.
568 |               """)
569 |         STDERR.write('\n')
570 |         STDERR.write(textwrap.fill(msg))
571 |         STDERR.write('\n')
572 | 
573 |     # Update the header-includes metadata.  Pandoc's
574 |     # --include-in-header option will override anything we do here.  This
575 |     # is a known issue and is owing to a design decision in pandoc.
576 |     # See https://github.com/jgm/pandoc/issues/3139.
577 | 
578 |     if pandocxnos.cleveref_required() and targets:
579 |         tex = """
580 |             %%%% pandoc-tablenos: required package
581 |             \\usepackage%s{cleveref}
582 |         """ % ('[capitalise]' if capitalise else '')
583 |         pandocxnos.add_to_header_includes(
584 |             meta, 'tex', tex,
585 |             regex=r'\\usepackage(\[[\w\s,]*\])?\{cleveref\}')
586 | 
587 |     if has_unnumbered_tables or (separator_changed and targets):
588 |         tex = """
589 |             %% pandoc-tablenos: required package
590 |             \\usepackage{caption}
591 |         """
592 |         pandocxnos.add_to_header_includes(
593 |             meta, 'tex', tex,
594 |             regex=r'\\usepackage(\[[\w\s,]*\])?\{caption\}')
595 | 
596 |     if plusname_changed and targets:
597 |         tex = """
598 |             %%%% pandoc-tablenos: change cref names
599 |             \\crefname{table}{%s}{%s}
600 |         """ % (plusname[0], plusname[1])
601 |         pandocxnos.add_to_header_includes(meta, 'tex', tex)
602 | 
603 |     if starname_changed and targets:
604 |         tex = """
605 |             %%%% pandoc-tablenos: change Cref names
606 |             \\Crefname{table}{%s}{%s}
607 |         """ % (starname[0], starname[1])
608 |         pandocxnos.add_to_header_includes(meta, 'tex', tex)
609 | 
610 |     if has_unnumbered_tables:
611 |         pandocxnos.add_to_header_includes(
612 |             meta, 'tex', NO_PREFIX_CAPTION_ENV_TEX)
613 | 
614 |     if has_tagged_tables and targets:
615 |         pandocxnos.add_to_header_includes(meta, 'tex', TAGGED_TABLE_ENV_TEX)
616 | 
617 |     if captionname_changed and targets:
618 |         pandocxnos.add_to_header_includes(
619 |             meta, 'tex', CAPTION_NAME_TEX % captionname)
620 | 
621 |     if separator_changed and targets:
622 |         pandocxnos.add_to_header_includes(
623 |             meta, 'tex', CAPTION_SEPARATOR_TEX % separator)
624 | 
625 |     if numbersections and targets:
626 |         pandocxnos.add_to_header_includes(
627 |             meta, 'tex', NUMBER_BY_SECTION_TEX)
628 | 
629 |     if secoffset and targets:
630 |         pandocxnos.add_to_header_includes(
631 |             meta, 'tex', SECOFFSET_TEX % secoffset,
632 |             regex=r'\\setcounter\{section\}')
633 | 
634 |     if warnings:
635 |         STDERR.write('\n')
636 | 
637 | # pylint: disable=too-many-locals, unused-argument
638 | def main(stdin=STDIN, stdout=STDOUT, stderr=STDERR):
639 |     """Filters the document AST."""
640 | 
641 |     # pylint: disable=global-statement
642 |     global PANDOCVERSION
643 |     global Table, AttrTable
644 | 
645 |     # Read the command-line arguments
646 |     parser = argparse.ArgumentParser(\
647 |       description='Pandoc table numbers filter.')
648 |     parser.add_argument(\
649 |       '--version', action='version',
650 |       version='%(prog)s {version}'.format(version=__version__))
651 |     parser.add_argument('fmt')
652 |     parser.add_argument('--pandocversion', help='The pandoc version.')
653 |     args = parser.parse_args()
654 | 
655 |     # Get the output format and document
656 |     fmt = args.fmt
657 |     doc = json.loads(stdin.read())
658 | 
659 |     # Initialize pandocxnos
660 |     # pylint: disable=too-many-function-args
661 |     PANDOCVERSION = pandocxnos.init(args.pandocversion, doc)
662 | 
663 |     # Element primitives
664 |     AttrTable = elt('Table', 6)
665 |     if version(PANDOCVERSION) >= version('2.10'):
666 |         Table = elt('Table', 6)
667 | 
668 |     # Chop up the doc
669 |     meta = doc['meta'] if version(PANDOCVERSION) >= version('1.18')\
670 |       else doc[0]['unMeta']
671 |     blocks = doc['blocks'] if version(PANDOCVERSION) >= version('1.18')\
672 |       else doc[1:]
673 | 
674 |     # Process the metadata variables
675 |     process(meta)
676 | 
677 |     # First pass
678 |     detach_attrs_table = detach_attrs_factory(Table)
679 |     insert_secnos = insert_secnos_factory(Table)
680 |     delete_secnos = delete_secnos_factory(Table)
681 |     actions = [attach_attrs_table, insert_secnos, process_tables, delete_secnos]
682 |     if version(PANDOCVERSION) < version('2.10'):
683 |         actions.append(detach_attrs_table)
684 |     altered = functools.reduce(lambda x, action: walk(x, action, fmt, meta),
685 |                                actions, blocks)
686 | 
687 |     # Second pass
688 |     process_refs = process_refs_factory(LABEL_PATTERN, targets.keys())
689 |     replace_refs = replace_refs_factory(targets,
690 |                                         cleveref, False,
691 |                                         plusname if not capitalise \
692 |                                         or plusname_changed else
693 |                                         [name.title() for name in plusname],
694 |                                         starname)
695 |     attach_attrs_span = attach_attrs_factory(Span, replace=True)
696 |     altered = functools.reduce(lambda x, action: walk(x, action, fmt, meta),
697 |                                [repair_refs, process_refs, replace_refs,
698 |                                 attach_attrs_span],
699 |                                altered)
700 | 
701 |     if fmt in ['latex', 'beamer']:
702 |         add_tex(meta)
703 | 
704 |     # Update the doc
705 |     if version(PANDOCVERSION) >= version('1.18'):
706 |         doc['blocks'] = altered
707 |     else:
708 |         doc = doc[:1] + altered
709 | 
710 |     # Dump the results
711 |     json.dump(doc, stdout)
712 | 
713 |     # Flush stdout
714 |     stdout.flush()
715 | 
716 | if __name__ == '__main__':
717 |     main()
718 | 


--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
1 | [metadata]
2 | description-file = README.md
3 | 


--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
 1 | """setup.py - install script for pandoc-tablenos."""
 2 | 
 3 | # Copyright 2015-2020 Thomas J. Duck.
 4 | # All rights reserved.
 5 | #
 6 | # This program is free software: you can redistribute it and/or modify
 7 | # it under the terms of the GNU General Public License as published by
 8 | # the Free Software Foundation, version 3.
 9 | #
10 | # This program is distributed in the hope that it will be useful,
11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 | # GNU General Public License for more details.
14 | #
15 | # You should have received a copy of the GNU General Public License
16 | # along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 | 
18 | import re
19 | import io
20 | 
21 | from setuptools import setup
22 | 
23 | # pylint: disable=invalid-name
24 | 
25 | DESCRIPTION = """\
26 | A pandoc filter for numbering tables and their references
27 | when converting markdown to other formats.
28 | """
29 | 
30 | # From https://stackoverflow.com/a/39671214
31 | __version__ = re.search(
32 |     r'__version__\s*=\s*[\'"]([^\'"]*)[\'"]',
33 |     io.open('pandoc_tablenos.py', encoding='utf_8_sig').read()
34 |     ).group(1)
35 | 
36 | setup(
37 |     name='pandoc-tablenos',
38 |     version=__version__,
39 | 
40 |     author='Thomas J. Duck',
41 |     author_email='tomduck@tomduck.ca',
42 |     description='Table number filter for pandoc',
43 |     long_description=DESCRIPTION,
44 |     license='GPL',
45 |     keywords='pandoc table numbers filter',
46 |     url='https://github.com/tomduck/pandoc-tablenos',
47 |     download_url='https://github.com/tomduck/pandoc-tablenos/tarball/' + \
48 |                  __version__,
49 | 
50 |     install_requires=['pandoc-xnos >= 2.5.0, < 3.0'],
51 | 
52 |     py_modules=['pandoc_tablenos'],
53 |     entry_points={'console_scripts':['pandoc-tablenos = pandoc_tablenos:main']},
54 | 
55 |     classifiers=[
56 |         'Development Status :: 5 - Production/Stable',
57 |         'Intended Audience :: End Users/Desktop',
58 |         'Environment :: Console',
59 |         'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
60 |         'Programming Language :: Python'
61 |         ],
62 | )
63 | 


--------------------------------------------------------------------------------
/test/Makefile:
--------------------------------------------------------------------------------
 1 | 
 2 | # Note: pandoc-2.4 broke citation parsing, and so is not supported.
 3 | 
 4 | v2.11 = 2.11.1.1
 5 | v2.10 = 2.10.1
 6 | v2.9 = 2.9.2.1
 7 | v2.8 = 2.8.1
 8 | v2.7 = 2.7.3
 9 | v2.7 = 2.7.3
10 | v2.6 = 2.6
11 | v2.5 = 2.5
12 | v2.3 = 2.3.1
13 | v2.2 = 2.2.3.2
14 | v2.1 = 2.1.3
15 | v2.0 = 2.0.6
16 | v1.19 = 1.19.2
17 | v1.18 = 1.18
18 | v1.17 = 1.17.2
19 | v1.16 = 1.16.0.2
20 | v1.15 = 1.15.2
21 | 
22 | PANDOC-2.11 = pandoc-$(v2.11)
23 | PANDOC-2.10 = pandoc-$(v2.10)
24 | PANDOC-2.9 = pandoc-$(v2.9)
25 | PANDOC-2.8 = pandoc-$(v2.8)
26 | PANDOC-2.7 = pandoc-$(v2.7)
27 | PANDOC-2.6 = pandoc-$(v2.6)
28 | PANDOC-2.5 = pandoc-$(v2.5)
29 | PANDOC-2.3 = pandoc-$(v2.3)
30 | PANDOC-2.2 = pandoc-$(v2.2)
31 | PANDOC-2.1 = pandoc-$(v2.1)
32 | PANDOC-2.0 = pandoc-$(v2.0)
33 | PANDOC-1.19 = pandoc-$(v1.19)
34 | PANDOC-1.18 = pandoc-$(v1.18)
35 | PANDOC-1.17 = pandoc-$(v1.17)
36 | PANDOC-1.16 = pandoc-$(v1.16)
37 | PANDOC-1.15 = pandoc-$(v1.15)
38 | 
39 | PYTHON-2.7 = python2.7
40 | 
41 | PDFFLAGS = --variable geometry:margin=1in --standalone --variable urlcolor=blue
42 | HTMLFLAGS = --standalone --variable urlcolor=blue
43 | 
44 | 
45 | all: pdf html epub docx
46 | 
47 | pdf: out/test-2.11.pdf \
48 |      out/test-2.11-py2.7.pdf \
49 |      out/test-2.10.pdf \
50 |      out/test-2.9.pdf \
51 |      out/test-2.8.pdf \
52 |      out/test-2.7.pdf \
53 |      out/test-2.6.pdf \
54 |      out/test-2.5.pdf \
55 |      out/test-2.3.pdf \
56 |      out/test-2.2.pdf \
57 |      out/test-2.1.pdf \
58 |      out/test-2.0.pdf \
59 |      out/test-1.19.pdf \
60 |      out/test-1.18.pdf \
61 |      out/test-1.17.pdf \
62 |      out/test-1.16.pdf \
63 |      out/test-1.15.pdf
64 | 
65 | html: out/test-2.11.html
66 | 
67 | epub: out/test-2.11.epub
68 | 
69 | docx: out/test-2.11.docx
70 | 
71 | 
72 | out/test-%.html: test.md
73 | 	@if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi
74 | 	$(PANDOC-$*) $< --filter pandoc-tablenos $(HTMLFLAGS) -o $@
75 | 
76 | out/test-%-py2.7.pdf: test.md
77 | 	@if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi
78 | 	$(PANDOC-$*) $< -t json | $(PYTHON-2.7) ../pandoc_tablenos.py latex --pandocversion=$(v$*) | $(PANDOC-$*) -f json $(PDFFLAGS) -o $@
79 | 
80 | out/test-%.pdf: test.md
81 | 	@if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi
82 | 	$(PANDOC-$*) $< --filter pandoc-tablenos $(PDFFLAGS) -o $@
83 | 
84 | out/test-%.epub: test.md
85 | 	@if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi
86 | 	$(PANDOC-$*) $< --filter pandoc-tablenos -o $@
87 | 
88 | out/test-%.docx: test.md
89 | 	@if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi
90 | 	$(PANDOC-$*) $< --filter pandoc-tablenos -o $@
91 | 
92 | .PHONY: clean
93 | 
94 | clean:
95 | 	rm -rf out
96 | 


--------------------------------------------------------------------------------
/test/README.md:
--------------------------------------------------------------------------------
1 | 
2 | Regression Tests
3 | ================
4 | 
5 | This directory contains regression tests.  Running `make` produces out/demo-* files that may be inspected and compared.  Note that the Makefile expects specific numbered pandoc executables (e.g., pandoc-2.7.3) to be available.  You will need to adapt the Makefile to use what is available on your system.
6 | 


--------------------------------------------------------------------------------
/test/cleveref.tex:
--------------------------------------------------------------------------------
1 | \usepackage{cleveref}


--------------------------------------------------------------------------------
/test/test.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | title: Pandoc-tablenos Test
  3 | tablenos-caption-name: TABLE
  4 | tablenos-plus-name: TAB.
  5 | tablenos-star-name: TABLE
  6 | ...
  7 | 
  8 | *@tbl:1 and +@tbl:2, Tables {@tbl:1}-{@tbl:3} and Tables {@tbl:1}-{@tbl:2}-{@tbl:3}.
  9 | 
 10 | [Table @tbl:1.]{style="color:red"}
 11 | 
 12 | ***
 13 | 
 14 | 
 15 |   Right     Left     Center     Default
 16 | -------     ------ ----------   -------
 17 |      12     12        12            12
 18 |     123     123       123          123
 19 |       1     1          1             1
 20 | 
 21 | Table: A simple table. Ref to +@tbl:2. {#tbl:1}
 22 | 
 23 | 
 24 | ****
 25 | 
 26 | 
 27 | A B
 28 | - -
 29 | 0 1
 30 | 
 31 | Table: Even simpler. {#tbl:2}
 32 | 
 33 | 
 34 | ****
 35 | 
 36 | 
 37 | References in lists:
 38 | 
 39 |   * {*@tbl:1} and +@tbl:2
 40 |   * Tables {@tbl:1}-{@tbl:3} and Tables {@tbl:1}-{@tbl:2}-{@tbl:3}.
 41 | 
 42 | 
 43 | ****
 44 | 
 45 | 
 46 | X Y
 47 | - -
 48 | 0 1
 49 | 
 50 | Table: Just as simple. {#tbl:3}
 51 | 
 52 | 
 53 | ****
 54 | 
 55 | 
 56 | An unreferenceable, numbered table:
 57 | 
 58 | X Y
 59 | - -
 60 | 0 1
 61 | 
 62 | Table: Cannot be referenced. {#tbl:}
 63 | 
 64 | 
 65 | \newpage
 66 | 
 67 | 
 68 | --------------------------------------------------------------------
 69 | 
 70 | Corner Cases
 71 | ------------
 72 | 
 73 | 
 74 | An unnumbered table with no attributes:
 75 | 
 76 | X Y
 77 | - -
 78 | 0 1
 79 | 
 80 | Table: Another one.
 81 | 
 82 | 
 83 | ****
 84 | 
 85 | 
 86 | An unnumbered table with empty attributes:
 87 | 
 88 | X Y
 89 | - -
 90 | 0 1
 91 | 
 92 | Table: Another one. {}
 93 | 
 94 | 
 95 | ****
 96 | 
 97 | 
 98 | Tables @tbl:4 and @tbl:5 are tagged tables:
 99 | 
100 | X Y
101 | - -
102 | 0 1
103 | 
104 | Table: Another one. {#tbl:4 tag="B.1"}
105 | 
106 | 
107 | X Y
108 | - -
109 | 0 1
110 | 
111 | Table: Another one. {#tbl:5 tag="$\text{B.3}'$"}
112 | 
113 | 
114 | \newpage
115 | 
116 | 
117 | ****
118 | 
119 | 
120 | A series of three unreferenceable numbered tables:
121 | 
122 | X Y
123 | - -
124 | 0 1
125 | 
126 | Table: Another one. {#tbl:}
127 | 
128 | 
129 | X Y
130 | - -
131 | 0 1
132 | 
133 | Table: Another one. {#tbl:}
134 | 
135 | 
136 | X Y
137 | - -
138 | 0 1
139 | 
140 | Table: Another one. {#tbl:}
141 | 
142 | 
143 | ****
144 | 
145 | 
146 | An uncaptioned table:
147 | 
148 | X Y
149 | - -
150 | 0 1
151 | 


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