Skip to content

Latest commit

 

History

History
150 lines (87 loc) · 4.4 KB

README.pod

File metadata and controls

150 lines (87 loc) · 4.4 KB

BPJ's Pandoc scripts

Some filters and utilities for use with Pandoc, written in Perl. Not all of them may be useful for other people, but they are here so that I have a place to grab them. It will generally be evident from the filename, or at least the documentation, which category they fall into. More scripts will appear as I write and document them. It was originally my intention to add only those scripts which I had documented, but I've relaxed that a bit.

The scripts

The list below was autogenerated by pulling the first paragraph in the DESCRIPTION section of the Pod documentation of each script, or if there was no such paragraph inserting a note that the documentation is still to be written. (This may be inaccurate while I'm still cleaning up the mess created by my previous attempts at automaticizing the documentation updating process! There may be some (markdown) documentation in a comment block at the head of the `scripts/*.pl` files themselves.)

The order is strictly ASCIIbetical, so no discrimination is made between filters and other scripts. There should also be copies of the Pod documentation for each script in the repository wiki. Both the list and the documentation on the wiki should generally be updated as I make changes.

batch-pandoc.pl

batch-pandoc.pl is a perl script to batch-convert files with a certain extension in a directory and its descendants with pandoc, creating a mirror directory structure with converted files.

pandoc-base64-img2file.pl

Pandoc filter which intercepts image elements with data URIs with Base64 encoded image data, decodes the data and writes the image to a file with a hopefully correct extension in a directory designated by the user as a metadata value, then replaces the URL in the output document with the path to that file.

pandoc-class2latex.pl

Documentation for pandoc-class2latex.pl still to be written!

pandoc-code2raw.pl

Documentation for pandoc-code2raw.pl still to be written!

pandoc-dl2ul.pl

No documentation yet!

pandoc-extract-noattr-div-span.pl

Documentation for pandoc-extract-noattr-div-span.pl still to be written!

pandoc-keep-div.pl

Documentation for pandoc-keep-div.pl still to be written!

pandoc-link2span.pl

pandoc-link2span.pl is a pandoc filter which overloads link syntax to define spans.

pandoc-local-quotes.pl

Documentation for pandoc-local-quotes.pl still to be written!

pandoc-mintedcode.pl

This is a quick and dirty pandoc filter which allows you to highlight code in LaTeX output with minted 2.0 rather than with Pandoc's builtin highlighting mechanism. This is useful because you get more sophisticated highlighting and formatting of code, and you can highlight different pieces of code differently, e.g. based on code language.

pandoc-no-header-links.pl

Documentation for pandoc-no-header-links.pl still to be written!

pandoc-no-header-span-ids.pl

Works around a pandoc bug where spans with an id inside a header causes invalid LaTeX to be generated, by transferring the span's id to the header, unless there is a metadata entry -M keep_header_ids=true. It is especially useful when you convert HTML fetched from the Web.

pandoc-number-blocks.pl

Documentation for pandoc-number-blocks.pl still to be written!

pandoc-plain2email.pl

No documentation yet!

pandoc-plain2pod.pl

pandoc-plain2pod.pl is a pandoc filter to munge plain output into Perl POD documentation, a poor man's custom writer implemented as a filter if you will.

pandoc-span2cmd.pl

Documentation for pandoc-span2cmd.pl still to be written!

pandoc-tabularize.pl

pandoc-tabularize.pl is a pandoc filter to use the tabular environment instead of the longtable package in LaTeX output. This is especially useful if you want to use twocolumn mode, which doesn't work with longtable.

pandoc-texlogo.pl

pandoc-texlogo.pl is a pandoc filter to help display the logos for TeX, LaTeX etc. correctly in in LaTeX (including when generating PDF!) and ConTeXt output while also rendering them sensibly in other formats.

pandoc-zap-images.pl

Documentation for pandoc-zap-images.pl still to be written!