├── .gitignore ├── AUTHORS ├── ChangeLog ├── DEVELOPERS.md ├── LICENSE ├── MANIFEST.in ├── README.md ├── demos ├── Makefile ├── demo.md ├── demo2.md ├── demo3.md └── headers │ └── header.html ├── pandoc_secnos.py ├── setup.cfg ├── setup.py └── test ├── Makefile └── test.md /.gitignore: -------------------------------------------------------------------------------- 1 | build 2 | dist 3 | *.egg-info 4 | /demos/out/* 5 | /test/out/* -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | 2 | pandoc-secnos was written and is maintained by Thomas J. Duck 3 | . -------------------------------------------------------------------------------- /ChangeLog: -------------------------------------------------------------------------------- 1 | pandoc-secnos 2.2.2 (2020-07-31) 2 | 3 | * Require pandoc-xnos 2.4.2 (bug fix release). 4 | 5 | 6 | pandoc-secnos 2.2.1 (2020-07-30) 7 | 8 | * Fixed "Failed reading: not a valid json" error when using 9 | python 2.7 (pandoc-tablenos Issue #19 and pandoc-eqnos 10 | Issue #45). 11 | * Fixed section number offset problem for html output (Issue #2). 12 | 13 | 14 | pandoc-secnos 2.2.0 (2020-07-30) 15 | 16 | * Updated to work with pandoc 2.10. 17 | 18 | 19 | pandoc-secnos 2.1.1 (2019-09-26) 20 | 21 | * Warns about duplicate reference targets. 22 | 23 | 24 | pandoc-secnos 2.0.0 (2019-09-17) 25 | 26 | * initial release. 27 | 28 | -------------------------------------------------------------------------------- /DEVELOPERS.md: -------------------------------------------------------------------------------- 1 | 2 | Developer Notes 3 | =============== 4 | 5 | Contributions 6 | ------------- 7 | 8 | Contributions to pandoc-secnos 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-secnos.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-secnos.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-secnos 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.2.2 -m "New release." 107 | git push origin 2.2.2 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-secnos-2.2.2.tar.gz \ 121 | dist/pandoc_secnos-2.2.2-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. 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 | 635 | Copyright (C) 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 . 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 | Copyright (C) 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 | . 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 | . 675 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.md 2 | DEVELOPERS.md 3 | include LICENSE 4 | include ChangeLog 5 | include AUTHORS -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | **New in 2.2.2:** Updated for pandoc 2.10.1. Fixed section number offset problem for html output (Issue #2). 3 | 4 | [more...](#whats-new) 5 | 6 | 7 | pandoc-secnos 2.2.2 8 | =================== 9 | 10 | *pandoc-secnos* is a [pandoc] filter for numbering section 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-secos gives numbered section references in [pdf][pdf3], [tex][tex3], [html][html3], [epub][epub3], [docx][docx3] and other formats. 13 | 14 | This version of pandoc-secnos was tested using pandoc 1.15.2 - 2.10.1,[1](#footnote1) and may be used with linux, macOS, and Windows. Bug reports and feature requests may be posted on the project's [Issues tracker]. If you find pandoc-secnos useful, then please kindly give it a star [on GitHub]. 15 | 16 | See also: [pandoc-fignos], [pandoc-eqnos], [pandoc-tablenos] \ 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-secnos/issues 22 | [on GitHub]: https://github.com/tomduck/pandoc-secnos 23 | [pandoc-fignos]: https://github.com/tomduck/pandoc-fignos 24 | [pandoc-eqnos]: https://github.com/tomduck/pandoc-eqnos 25 | [pandoc-tablenos]: https://github.com/tomduck/pandoc-tablenos 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-secnos requires [python]. It is easily installed -- see [here](https://realpython.com/installing-python/).[2](#footnote2) Either python 2.7 or 3.x will do. 47 | 48 | Pandoc-secnos may be installed using the shell command 49 | 50 | pip install pandoc-secnos --user 51 | 52 | and upgrade by appending `--upgrade` to the above command. Pip is a program that downloads and installs software from the Python Package Index, [PyPI]. It normally comes installed with a python distribution.[3](#footnote3) 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-secnos is activated by using the 65 | 66 | --filter pandoc-secnos 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-secnos` or `pandoc-xnos` filter calls. 75 | 76 | 77 | Markdown Syntax 78 | --------------- 79 | 80 | The cross-referencing syntax used by pandoc-secnos was developed in [pandoc Issue #813] -- see [this post] by [@scaramouche1]. 81 | 82 | For LaTeX/pdf, html, and epub output, sections are numbered using pandoc's `--number-sections` [option](https://pandoc.org/MANUAL.html#option--number-sections). 83 | 84 | To reference a section, use 85 | 86 | @sec:id 87 | 88 | or 89 | 90 | {@sec:id} 91 | 92 | The prefix `@sec:` is required. `id` should be replaced with a unique identifier for the section, composed of letters, numbers, dashes and underscores. Curly braces protect a reference and are stripped from the output. 93 | 94 | Pandoc automatically assigns an identifier to each section title in a document. For example, the identifier for 95 | 96 | Section One 97 | =========== 98 | 99 | is `section-one`; a reference to it would be `@sec:section-one`. An identifier may be explicitly assigned to the section title using attributes as follows: 100 | 101 | Section Two {#sec:2} 102 | =========== 103 | 104 | A reference to this would be `@sec:2`. 105 | 106 | Demonstration: Processing [demo.md] with pandoc + pandoc-secnos gives numbered section references in [pdf], [tex], [html], [epub], [docx] and other formats. 107 | 108 | [pandoc Issue #813]: https://github.com/jgm/pandoc/issues/813 109 | [this post]: https://github.com/jgm/pandoc/issues/813#issuecomment-70423503 110 | [@scaramouche1]: https://github.com/scaramouche1 111 | [reference link]: http://pandoc.org/MANUAL.html#reference-links 112 | [demo.md]: https://raw.githubusercontent.com/tomduck/pandoc-secnos/master/demos/demo.md 113 | [pdf]: https://raw.githack.com/tomduck/pandoc-secnos/demos/demo.pdf 114 | [tex]: https://raw.githack.com/tomduck/pandoc-secnos/demos/demo.tex 115 | [html]: https://raw.githack.com/tomduck/pandoc-secnos/demos/demo.html 116 | [epub]: https://raw.githack.com/tomduck/pandoc-secnos/demos/demo.epub 117 | [docx]: https://raw.githack.com/tomduck/pandoc-secnos/demos/demo.docx 118 | 119 | 120 | ### Clever References ### 121 | 122 | Writing markdown like 123 | 124 | See sec. @sec:id. 125 | 126 | seems a bit redundant. Pandoc-secnos supports "clever references" via single-character modifiers in front of a reference. Users may write 127 | 128 | See +@sec:id. 129 | 130 | to have the reference name (i.e., "section") automatically generated. The above form is used mid-sentence; at the beginning of a sentence, use 131 | 132 | *@sec:id 133 | 134 | instead. If clever references are enabled by default (see [Customization](#customization), below), then users may disable it for a given reference using[4](#footnote4) 135 | 136 | !@sec:id 137 | 138 | Demonstration: Processing [demo2.md] with pandoc + pandoc-secnos gives numbered section references in [pdf][pdf2], [tex][tex2], [html][html2], [epub][epub2], [docx][docx2] and other formats. 139 | 140 | Note: When using `*@sec:id` and emphasis (e.g., `*italics*`) in the same sentence, the `*` in the clever reference must be backslash-escaped; i.e., `\*@sec:id`. 141 | 142 | [demo2.md]: https://raw.githubusercontent.com/tomduck/pandoc-secnos/master/demos/demo2.md 143 | [pdf2]: https://raw.githack.com/tomduck/pandoc-secnos/demos/demo2.pdf 144 | [tex2]: https://raw.githack.com/tomduck/pandoc-secnos/demos/demo2.tex 145 | [html2]: https://raw.githack.com/tomduck/pandoc-secnos/demos/demo2.html 146 | [epub2]: https://raw.githack.com/tomduck/pandoc-secnos/demos/demo2.epub 147 | [docx2]: https://raw.githack.com/tomduck/pandoc-secnos/demos/demo2.docx 148 | 149 | 150 | ### Disabling Links ### 151 | 152 | To disable a link on a reference, set `nolink=True` in the reference's attributes: 153 | 154 | @sec:id{nolink=True} 155 | 156 | 157 | Customization 158 | ------------- 159 | 160 | Pandoc-secnos may be customized by setting variables in the [metadata block] or on the command line (using `-M KEY=VAL`). The following variables are supported: 161 | 162 | * `secnos-warning-level` or `xnos-warning-level` - Set to `0` for 163 | no warnings, `1` for critical warnings, or `2` (default) for 164 | all warnings. Warning level 2 should be used when 165 | troubleshooting. 166 | 167 | * `secnos-cleveref` or `xnos-cleveref` - Set to `True` to assume "+" 168 | clever references by default; 169 | 170 | * `xnos-capitalise` - Capitalises the names of "+" clever 171 | references (e.g., change from "section" to "Section"); 172 | 173 | * `secnos-plus-name` - Sets the name of a "+" clever reference 174 | (e.g., change it from "section" to "sec."). Settings here take 175 | precedence over `xnos-capitalise`; 176 | 177 | * `secnos-star-name` - Sets the name of a "*" clever reference 178 | (e.g., change it from "Section" to "Sec."); 179 | 180 | * `xnos-number-offset` - Set to an integer to offset the section 181 | numbers in references. For html and epub output, this feature 182 | should be used together with pandoc's `--number-offset` 183 | [option](https://pandoc.org/MANUAL.html#option--number-sections) 184 | set to the same integer value. For LaTeX/PDF, this option 185 | offsets the actual section numbers as required. 186 | 187 | 188 | Note that variables beginning with `secnos-` apply to only pandoc-secnos, whereas variables beginning with `xnos-` apply to all all of the pandoc-fignos/eqnos/tablenos/secnos filters. 189 | 190 | Demonstration: Processing [demo3.md] with pandoc + pandoc-secnos gives numbered section references in [pdf][pdf3], [tex][tex3], [html][html3], [epub][epub3], [docx][docx3] and other formats. 191 | 192 | [metadata block]: http://pandoc.org/README.html#extension-yaml_metadata_block 193 | [demo3.md]: https://raw.githubusercontent.com/tomduck/pandoc-secnos/master/demos/demo3.md 194 | [pdf3]: https://raw.githack.com/tomduck/pandoc-secnos/demos/demo3.pdf 195 | [tex3]: https://raw.githack.com/tomduck/pandoc-secnos/demos/demo3.tex 196 | [html3]: https://raw.githack.com/tomduck/pandoc-secnos/demos/demo3.html 197 | [epub3]: https://raw.githack.com/tomduck/pandoc-secnos/demos/demo3.epub 198 | [docx3]: https://raw.githack.com/tomduck/pandoc-secnos/demos/demo3.docx 199 | 200 | 201 | Technical Details 202 | ----------------- 203 | 204 | ### LaTeX/pdf Output ### 205 | 206 | During processing, pandoc-secnos inserts packages and supporting LaTeX into the `header-includes` metadata field. To see what is inserted, set the `secnos-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`. 207 | 208 | An example reference in LaTeX looks like 209 | 210 | ~~~latex 211 | See \cref{sec:1}. 212 | ~~~ 213 | 214 | Other details: 215 | 216 | * The `cleveref` and `caption` packages are used for clever 217 | references and caption control, respectively; 218 | * The `\label` and `\ref` macros are used for section labels and 219 | references, respectively (`\Cref` and `\cref` are used for 220 | clever references); 221 | * Clever reference names are set with `\Crefname` and `\crefname`; 222 | 223 | 224 | ### Html/Epub Output ### 225 | 226 | An example reference in html looks like 227 | 228 | ~~~html 229 | See section 1. 230 | ~~~ 231 | 232 | 233 | ### Docx Output ### 234 | 235 | Docx OOXML output is under development and subject to change. Native capabilities will be used wherever possible. 236 | 237 | 238 | Getting Help 239 | ------------ 240 | 241 | If you have any difficulties with pandoc-secnos, or would like to see a new feature, then please submit a report to our [Issues tracker]. 242 | 243 | 244 | Development 245 | ----------- 246 | 247 | Pandoc-secnos 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-secnos more robust. 248 | 249 | Developer notes are maintained in [DEVELOPERS.md]. 250 | 251 | 252 | What's New 253 | ---------- 254 | 255 | **New in 2.2.2:** Updated for pandoc 2.10.1. Fixed section number offset problem for html output (Issue #2). 256 | 257 | **New in 2.1.1:** Warnings are now given for duplicate reference targets. 258 | 259 | **New in 2.0.0:** Pandoc-secnos is a new filter. It has been marked with version number 2.0.0 in keeping with the major version number of the underlying pandoc-xnos library. 260 | 261 | 262 | ---- 263 | 264 | **Footnotes** 265 | 266 | 1: Pandoc 2.4 [broke](https://github.com/jgm/pandoc/issues/5099) how references are parsed, and so is not supported. 267 | 268 | 2: For MacOS, my preferred install method is to use the package [available from python.org](https://www.python.org/downloads/). 269 | 270 | 3: Anaconda users may be tempted to use `conda` instead. This is not advised. The packages distributed on the Anaconda cloud are unofficial, are not posted by me, and in some cases are ancient. Some tips on using `pip` in a `conda` environment may be found [here](https://www.anaconda.com/using-pip-in-a-conda-environment/). 271 | 272 | 4: The disabling modifier "!" is used instead of "-" because [pandoc drops minus signs] in front of references. 273 | 274 | [pandoc drops minus signs]: https://github.com/jgm/pandoc/issues/2901 275 | -------------------------------------------------------------------------------- /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 | out/%.pdf: %.md 17 | @if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi 18 | pandoc $< --number-sections --filter pandoc-secnos --variable urlcolor=blue -o $@ 19 | 20 | out/%.html: %.md headers/header.html 21 | @if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi 22 | pandoc $< --standalone --number-sections --filter pandoc-secnos --include-in-header headers/header.html -o $@ 23 | 24 | out/%.epub: %.md 25 | @if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi 26 | pandoc $< -t epub3 --number-sections --filter pandoc-secnos -o $@ 27 | 28 | out/%: 29 | @if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi 30 | pandoc $^ --number-sections --filter pandoc-secnos -o $@ 31 | 32 | 33 | restore: clean 34 | for num in "" 2 3 ; do \ 35 | for ext in $(extensions) ; do \ 36 | git checkout out/demo$$num$$ext ; \ 37 | done ; \ 38 | done 39 | 40 | 41 | .PHONY: clean 42 | 43 | clean: 44 | rm -rf out 45 | -------------------------------------------------------------------------------- /demos/demo.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Pandoc-secnos Demo 3 | ... 4 | 5 | Section One 6 | =========== 7 | 8 | Reference to section @sec:2. 9 | 10 | 11 | Section Two {#sec:2} 12 | =========== 13 | 14 | Reference to section @sec:section-one. Section @sec:subsection comes next. 15 | 16 | 17 | Subsection 18 | ---------- 19 | 20 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. 21 | -------------------------------------------------------------------------------- /demos/demo2.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Pandoc-secnos Demo 3 | ... 4 | 5 | Section One 6 | =========== 7 | 8 | Reference to +@sec:2. 9 | 10 | 11 | Section Two {#sec:2} 12 | =========== 13 | 14 | Reference to +@sec:section-one. *@sec:subsection comes next. 15 | 16 | 17 | Subsection 18 | ---------- 19 | 20 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. 21 | -------------------------------------------------------------------------------- /demos/demo3.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Pandoc-secnos Demo 3 | secnos-cleveref: True 4 | secnos-plus-name: sec. 5 | ... 6 | 7 | Section One 8 | =========== 9 | 10 | Reference to @sec:2. 11 | 12 | 13 | Section Two {#sec:2} 14 | =========== 15 | 16 | Reference to +@sec:section-one. *@sec:subsection comes next. 17 | 18 | 19 | Subsection 20 | ---------- 21 | 22 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. 23 | -------------------------------------------------------------------------------- /demos/headers/header.html: -------------------------------------------------------------------------------- 1 | 4 | -------------------------------------------------------------------------------- /pandoc_secnos.py: -------------------------------------------------------------------------------- 1 | #! /usr/bin/env python 2 | 3 | """pandoc-secnos: a pandoc filter that inserts section references.""" 4 | 5 | 6 | __version__ = '2.2.2' 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 . 23 | 24 | 25 | # OVERVIEW 26 | # 27 | # The basic idea is to scan the document twice in order to: 28 | # 29 | # 1. Obtain the labels for each section. 30 | # 31 | # 2. Replace each reference with a section number. For LaTeX, 32 | # replace with \ref{...} instead. 33 | # 34 | # This is followed by injecting header code as needed for certain output 35 | # formats. 36 | 37 | # pylint: disable=invalid-name, global-statement 38 | 39 | import re 40 | import functools 41 | import argparse 42 | import json 43 | import copy 44 | import textwrap 45 | 46 | from pandocfilters import walk, Span 47 | 48 | import pandocxnos 49 | from pandocxnos import STRTYPES, STDIN, STDOUT, STDERR 50 | from pandocxnos import check_bool, get_meta 51 | from pandocxnos import repair_refs, process_refs_factory, replace_refs_factory 52 | from pandocxnos import attach_attrs_factory 53 | from pandocxnos import version 54 | 55 | # Read the command-line arguments 56 | parser = argparse.ArgumentParser(description='Pandoc section numbers filter.') 57 | parser.add_argument('--version', action='version', 58 | version='%(prog)s {version}'.format(version=__version__)) 59 | parser.add_argument('fmt') 60 | parser.add_argument('--pandocversion', help='The pandoc version.') 61 | args = parser.parse_args() 62 | 63 | # Patterns for matching labels and references 64 | LABEL_PATTERN = re.compile(r'(sec:[\w/-]*)') 65 | 66 | # Meta variables; may be reset elsewhere 67 | cleveref = False # Flags that clever references should be used 68 | capitalise = False # Flags that plusname should be capitalised 69 | # Sets names for mid-sentence references 70 | plusname = {'section': ['section', 'sections'], 71 | 'chapter': ['chapter', 'chapters']} 72 | # Sets names for refs at sentence start 73 | starname = {'section': ['Section', 'Sections'], 74 | 'chapter': ['Chapter', 'Chapters']} 75 | secoffset = 0 # Section number offset 76 | warninglevel = 2 # 0 - no warnings; 1 - some warnings; 2 - all warnings 77 | 78 | # Processing state variables 79 | sec = [] # Section number tracker 80 | targets = {} # Global targets tracker 81 | 82 | # Processing flags 83 | # Flags that the plus name changed 84 | plusname_changed = {'section': False, 'chapter': False} 85 | # Flags that the star name changed 86 | starname_changed = {'section': False, 'chapter': False} 87 | 88 | PANDOCVERSION = None 89 | 90 | 91 | # Actions -------------------------------------------------------------------- 92 | 93 | def process_sections(key, value, fmt, meta): # pylint: disable=unused-argument 94 | """Processes sections.""" 95 | 96 | global sec 97 | 98 | if key == 'Header': 99 | if 'unnumbered' in value[1][1]: 100 | return 101 | 102 | # Update the section number 103 | level = value[0] 104 | assert level 105 | if not sec: 106 | sec = [secoffset] 107 | while len(sec) < level: 108 | sec.append(0) 109 | if len(sec) > level: 110 | sec = sec[:level] 111 | assert len(sec) == level 112 | sec[level-1] += 1 113 | 114 | # Add new item to the targets tracker 115 | targets[value[1][0]] = \ 116 | pandocxnos.Target('.'.join(str(i) for i in sec), None, 117 | value[1][0] in targets) 118 | 119 | 120 | # TeX blocks ----------------------------------------------------------------- 121 | 122 | # Section number offset 123 | SECOFFSET_TEX = r""" 124 | %% pandoc-secnos: section number offset 125 | \setcounter{section}{%s} 126 | """ 127 | 128 | 129 | # Main program --------------------------------------------------------------- 130 | 131 | def set_name(nametype, division, value): 132 | """Sets the name on a given division.""" 133 | 134 | global plusname_changed # Flags that the plus name changed 135 | global starname_changed # Flags that the star name changed 136 | 137 | isplusname = nametype == 'plus' 138 | 139 | old_name = copy.deepcopy(plusname if isplusname else starname) 140 | name = plusname if isplusname else starname 141 | name_changed = plusname_changed if isplusname else starname_changed 142 | 143 | if isinstance(value, list): # Singular and plural forms given 144 | name[division] = value 145 | else: # Only the singular form was given 146 | name[division][0] = value 147 | name_changed[division] = name[division] != old_name[division] 148 | assert len(name[division]) == 2 149 | for x in name[division]: 150 | assert isinstance(x, STRTYPES) 151 | if isplusname and name_changed[division]: 152 | starname[division] = \ 153 | [x.title() for x in name[division]] 154 | 155 | # pylint: disable=too-many-statements, too-many-branches 156 | def process(meta): 157 | """Saves metadata fields in global variables and returns a few 158 | computed fields.""" 159 | 160 | # pylint: disable=global-statement 161 | global cleveref # Flags that clever references should be used 162 | global capitalise # Flags that plusname should be capitalised 163 | global plusname # Sets names for mid-sentence references 164 | global starname # Sets names for references at sentence start 165 | global secoffset # Section number offset 166 | global warninglevel # 0 - no warnings; 1 - some; 2 - all 167 | 168 | # Read in the metadata fields and do some checking 169 | 170 | for name in ['secnos-warning-level', 'xnos-warning-level']: 171 | if name in meta: 172 | warninglevel = int(get_meta(meta, name)) 173 | pandocxnos.set_warning_level(warninglevel) 174 | break 175 | 176 | metanames = ['secnos-warning-level', 'xnos-warning-level', 177 | 'secnos-cleveref', 'xnos-cleveref', 178 | 'xnos-capitalise', 'xnos-capitalize', 179 | 'xnos-caption-separator', # Used by pandoc-fignos/tablenos 180 | 'secnos-plus-name', 'secnos-star-name', 181 | 'xnos-number-by-section', 'xnos-number-offset'] 182 | 183 | if warninglevel: 184 | for name in meta: 185 | if (name.startswith('secnos') or name.startswith('xnos')) and \ 186 | name not in metanames: 187 | msg = textwrap.dedent(""" 188 | pandoc-secnos: unknown meta variable "%s"\n 189 | """ % name) 190 | STDERR.write(msg) 191 | 192 | for name in ['secnos-cleveref', 'xnos-cleveref']: 193 | # 'xnos-cleveref' enables cleveref in all four of 194 | # fignos/eqnos/tablenos/secnos 195 | if name in meta: 196 | cleveref = check_bool(get_meta(meta, name)) 197 | break 198 | 199 | for name in ['xnos-capitalise', 'xnos-capitalize']: 200 | # 'xnos-capitalise' enables capitalise in all four of 201 | # fignos/eqnos/tablenos/secnos. Since this uses an option in the 202 | # caption package, it is not possible to select between the three (use 203 | # 'secnos-plus-name' instead. 'xnos-capitalize' is an alternative 204 | # spelling 205 | if name in meta: 206 | capitalise = check_bool(get_meta(meta, name)) 207 | break 208 | 209 | if 'secnos-plus-name' in meta: 210 | 211 | value = get_meta(meta, 'secnos-plus-name') 212 | 213 | if isinstance(value, str): 214 | try: 215 | value_ = \ 216 | dict(itemstr.split(':') for itemstr in value.split(',')) 217 | for division in value_: 218 | set_name('plus', division, value_[division]) 219 | except ValueError: 220 | set_name('plus', 'section', value) 221 | else: # Dict expected 222 | for division in value: 223 | set_name('plus', division, value[division]) 224 | 225 | if 'secnos-star-name' in meta: 226 | 227 | value = get_meta(meta, 'secnos-star-name') 228 | 229 | if isinstance(value, str): 230 | try: 231 | value_ = \ 232 | dict(itemstr.split(':') for itemstr in value.split(',')) 233 | for division in value_: 234 | set_name('star', division, value_[division]) 235 | except ValueError: 236 | set_name('star', 'section', value) 237 | else: # Dict expected 238 | for division in value: 239 | set_name('star', division, value[division]) 240 | 241 | if 'xnos-number-offset' in meta: 242 | secoffset = int(get_meta(meta, 'xnos-number-offset')) 243 | 244 | 245 | def add_tex(meta): 246 | """Adds tex to the meta data.""" 247 | 248 | warnings = warninglevel == 2 and targets and \ 249 | (pandocxnos.cleveref_required() or 250 | any(plusname_changed.values()) or any(starname_changed.values()) or \ 251 | secoffset) 252 | if warnings: 253 | msg = textwrap.dedent("""\ 254 | pandoc-secnos: Wrote the following blocks to 255 | header-includes. If you use pandoc's 256 | --include-in-header option then you will need to 257 | manually include these yourself. 258 | """) 259 | STDERR.write('\n') 260 | STDERR.write(textwrap.fill(msg)) 261 | STDERR.write('\n') 262 | 263 | # Update the header-includes metadata. Pandoc's 264 | # --include-in-header option will override anything we do here. This 265 | # is a known issue and is owing to a design decision in pandoc. 266 | # See https://github.com/jgm/pandoc/issues/3139. 267 | 268 | if pandocxnos.cleveref_required() and targets: 269 | tex = """ 270 | %%%% pandoc-secnos: required package 271 | \\usepackage%s{cleveref} 272 | """ % ('[capitalise]' if capitalise else '') 273 | pandocxnos.add_to_header_includes( 274 | meta, 'tex', tex, 275 | regex=r'\\usepackage(\[[\w\s,]*\])?\{cleveref\}') 276 | 277 | if plusname_changed['section'] and targets: 278 | tex = """ 279 | %%%% pandoc-secnos: change cref names 280 | \\crefname{section}{%s}{%s} 281 | """ % (plusname['section'][0], plusname['section'][1]) 282 | pandocxnos.add_to_header_includes(meta, 'tex', tex) 283 | 284 | if plusname_changed['chapter'] and targets: 285 | tex = """ 286 | %%%% pandoc-secnos: change cref names 287 | \\crefname{chapter}{%s}{%s} 288 | """ % (plusname['chapter'][0], plusname['chapter'][1]) 289 | pandocxnos.add_to_header_includes(meta, 'tex', tex) 290 | 291 | if starname_changed['section'] and targets: 292 | tex = """ 293 | %%%% pandoc-secnos: change Cref names 294 | \\Crefname{section}{%s}{%s} 295 | """ % (starname['section'][0], starname['section'][1]) 296 | pandocxnos.add_to_header_includes(meta, 'tex', tex) 297 | 298 | if starname_changed['chapter'] and targets: 299 | tex = """ 300 | %%%% pandoc-secnos: change Cref names 301 | \\Crefname{chapter}{%s}{%s} 302 | """ % (starname['chapter'][0], starname['chapter'][1]) 303 | pandocxnos.add_to_header_includes(meta, 'tex', tex) 304 | 305 | if secoffset and targets: 306 | pandocxnos.add_to_header_includes( 307 | meta, 'tex', SECOFFSET_TEX % secoffset, 308 | regex=r'\\setcounter\{section\}') 309 | 310 | if warnings: 311 | STDERR.write('\n') 312 | 313 | # pylint: disable=too-many-locals, unused-argument 314 | def main(stdin=STDIN, stdout=STDOUT, stderr=STDERR): 315 | """Filters the document AST.""" 316 | 317 | # pylint: disable=global-statement 318 | global PANDOCVERSION 319 | 320 | # Get the output format and document 321 | fmt = args.fmt 322 | doc = json.loads(stdin.read()) 323 | 324 | # Initialize pandocxnos 325 | PANDOCVERSION = pandocxnos.init(args.pandocversion, doc) 326 | 327 | # Chop up the doc 328 | meta = doc['meta'] if version(PANDOCVERSION) >= version('1.18') \ 329 | else doc[0]['unMeta'] 330 | blocks = doc['blocks'] if version(PANDOCVERSION) >= version('1.18') \ 331 | else doc[1:] 332 | 333 | # Process the metadata variables 334 | process(meta) 335 | 336 | # First pass 337 | altered = functools.reduce(lambda x, action: walk(x, action, fmt, meta), 338 | [process_sections], blocks) 339 | 340 | # Second pass 341 | process_refs = process_refs_factory(LABEL_PATTERN, targets.keys()) 342 | replace_refs = \ 343 | replace_refs_factory(targets, cleveref, False, 344 | plusname['section'] if not capitalise or \ 345 | plusname_changed['section'] else \ 346 | [name.title() for name in plusname['section']], 347 | starname['section'], allow_implicit_refs=True) 348 | attach_attrs_span = attach_attrs_factory(Span, replace=True) 349 | altered = functools.reduce(lambda x, action: walk(x, action, fmt, meta), 350 | [repair_refs, process_refs, replace_refs, 351 | attach_attrs_span], 352 | altered) 353 | 354 | if fmt in ['latex', 'beamer']: 355 | add_tex(meta) 356 | 357 | # Update the doc 358 | if version(PANDOCVERSION) >= version('1.18'): 359 | doc['blocks'] = altered 360 | else: 361 | doc = doc[:1] + altered 362 | 363 | # Dump the results 364 | json.dump(doc, stdout) 365 | 366 | # Flush stdout 367 | stdout.flush() 368 | 369 | if __name__ == '__main__': 370 | main() 371 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | description-file = README.md 3 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | """setup.py - install script for pandoc-secnos.""" 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 . 17 | 18 | import re 19 | import io 20 | import textwrap 21 | import sys 22 | import shutil 23 | 24 | from setuptools import setup 25 | 26 | # pylint: disable=invalid-name 27 | 28 | DESCRIPTION = """\ 29 | A pandoc filter for numbering equations and their references 30 | when converting markdown documents to other formats. 31 | """ 32 | 33 | # From https://stackoverflow.com/a/39671214 34 | __version__ = re.search( 35 | r'__version__\s*=\s*[\'"]([^\'"]*)[\'"]', 36 | io.open('pandoc_secnos.py', encoding='utf_8_sig').read() 37 | ).group(1) 38 | 39 | setup( 40 | name='pandoc-secnos', 41 | version=__version__, 42 | 43 | author='Thomas J. Duck', 44 | author_email='tomduck@tomduck.ca', 45 | description='Equation number filter for pandoc', 46 | long_description=DESCRIPTION, 47 | license='GPL', 48 | keywords='pandoc equation numbers filter', 49 | url='https://github.com/tomduck/pandoc-secnos', 50 | download_url='https://github.com/tomduck/pandoc-secnos/tarball/' + \ 51 | __version__, 52 | 53 | install_requires=['pandoc-xnos >= 2.4.3, < 3.0'], 54 | 55 | py_modules=['pandoc_secnos'], 56 | entry_points={'console_scripts':['pandoc-secnos = pandoc_secnos:main']}, 57 | 58 | classifiers=[ 59 | 'Development Status :: 4 - Beta', 60 | 'Intended Audience :: End Users/Desktop', 61 | 'Environment :: Console', 62 | 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', 63 | 'Programming Language :: Python' 64 | ] 65 | ) 66 | 67 | # Check that the pandoc-secnos script is on the PATH 68 | if not shutil.which('pandoc-secnos'): 69 | msg = """ 70 | ERROR: `pandoc-secnos` script not found. This will need to 71 | be corrected. If you need help, please file an Issue at 72 | https://github.com/tomduck/pandoc-secnos/issues.\n""" 73 | print(textwrap.dedent(msg)) 74 | sys.exit(-1) 75 | -------------------------------------------------------------------------------- /test/Makefile: -------------------------------------------------------------------------------- 1 | 2 | # Note: pandoc-2.4 broke citation parsing, and so is not supported. 3 | 4 | v2.10 = 2.10.1 5 | v2.9 = 2.9.2.1 6 | v2.8 = 2.8.1 7 | v2.7 = 2.7.3 8 | v2.6 = 2.6 9 | v2.5 = 2.5 10 | v2.3 = 2.3.1 11 | v2.2 = 2.2.3.2 12 | v2.1 = 2.1.3 13 | v2.0 = 2.0.6 14 | v1.19 = 1.19.2 15 | v1.18 = 1.18 16 | v1.17 = 1.17.2 17 | v1.16 = 1.16.0.2 18 | v1.15 = 1.15.2 19 | 20 | PANDOC-2.10 = pandoc-$(v2.10) 21 | PANDOC-2.9 = pandoc-$(v2.9) 22 | PANDOC-2.8 = pandoc-$(v2.8) 23 | PANDOC-2.7 = pandoc-$(v2.7) 24 | PANDOC-2.6 = pandoc-$(v2.6) 25 | PANDOC-2.5 = pandoc-$(v2.5) 26 | PANDOC-2.3 = pandoc-$(v2.3) 27 | PANDOC-2.2 = pandoc-$(v2.2) 28 | PANDOC-2.1 = pandoc-$(v2.1) 29 | PANDOC-2.0 = pandoc-$(v2.0) 30 | PANDOC-1.19 = pandoc-$(v1.19) 31 | PANDOC-1.18 = pandoc-$(v1.18) 32 | PANDOC-1.17 = pandoc-$(v1.17) 33 | PANDOC-1.16 = pandoc-$(v1.16) 34 | PANDOC-1.15 = pandoc-$(v1.15) 35 | 36 | PYTHON-2.7 = python2.7 37 | 38 | PDFFLAGS = --number-sections --variable geometry:margin=1in --standalone --variable urlcolor=blue 39 | HTMLFLAGS = --number-sections --standalone --variable urlcolor=blue 40 | 41 | 42 | all: pdf html epub docx 43 | 44 | pdf: out/test-2.10.pdf \ 45 | out/test-2.10-py2.7.pdf \ 46 | out/test-2.9.pdf \ 47 | out/test-2.8.pdf \ 48 | out/test-2.7.pdf \ 49 | out/test-2.6.pdf \ 50 | out/test-2.5.pdf \ 51 | out/test-2.3.pdf \ 52 | out/test-2.2.pdf \ 53 | out/test-2.1.pdf \ 54 | out/test-2.0.pdf \ 55 | out/test-1.19.pdf \ 56 | out/test-1.18.pdf \ 57 | out/test-1.17.pdf \ 58 | out/test-1.16.pdf \ 59 | out/test-1.15.pdf 60 | 61 | html: out/test-2.10.html 62 | 63 | epub: out/test-2.10.epub 64 | 65 | docx: out/test-2.10.docx 66 | 67 | 68 | out/test-%.html: test.md 69 | @if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi 70 | $(PANDOC-$*) $< --filter pandoc-secnos $(HTMLFLAGS) -o $@ 71 | 72 | out/test-%-py2.7.pdf: test.md 73 | @if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi 74 | $(PANDOC-$*) $< -t json | $(PYTHON-2.7) ../pandoc_secnos.py latex --pandocversion=$(v$*) | $(PANDOC-$*) -f json $(PDFFLAGS) -o $@ 75 | 76 | out/test-%.pdf: test.md 77 | @if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi 78 | $(PANDOC-$*) $< --filter pandoc-secnos $(PDFFLAGS) -o $@ 79 | 80 | out/test-%.epub: test.md 81 | @if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi 82 | $(PANDOC-$*) $< --number-sections --filter pandoc-secnos -o $@ 83 | 84 | out/test-%.docx: test.md 85 | @if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi 86 | $(PANDOC-$*) $< --filter pandoc-secnos -o $@ 87 | 88 | .PHONY: clean 89 | 90 | clean: 91 | rm -rf out 92 | -------------------------------------------------------------------------------- /test/test.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Pandoc-secnos Demo 3 | secnos-cleveref: True 4 | ... 5 | 6 | Section One 7 | =========== 8 | 9 | Reference to @sec:2. 10 | 11 | 12 | Section Two {#sec:2} 13 | =========== 14 | 15 | Reference to @sec:section-one. *@sec:subsection comes next. 16 | 17 | 18 | Subsection 19 | ---------- 20 | 21 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. 22 | --------------------------------------------------------------------------------