Here you will find reference pages for each of the built-in dexy filters. Filters are what let dexy run code, transform text, and wrap libraries and tools so you can easily and reproducibly create any kind of document.
If you have worked through the getting started tutorial, then you are already familiar with some of these filters like pyg and jinja.
You can browse through the alphabetical list or browse filters by tag (not all filters are tagged yet, so the alphabetical list is more reliable).
An example is provided for this filter. | |
This is a newly added filter (in version 1.0.0 or later). | |
This filter was added after the current released version 2.0.6. Will be in the next dexy release, and is available now if you install dexy from the develop branch. |
Runs `abcm2ps` on .abc music files.
Runs `abcm2ps` on .abc music files, generating all output formats.
Base class for filters which post content to a remote API.
Apply template to file. Template should specify %(content)s.
Creates a .tgz archive of all input documents.
Runs asciidoc command.
Runs `asciidoctor`.
Surrounds code with highlighting instructions for Asciidoctor
Runs bash scripts using 'bash' and returns stdout.
Forces previous filter to output .bmp extension.
Converts color pdf to black and white.
Compile code using gcc and run.
Runs `ebook-convert` command (part of calibre)
Runs scripts using casper js. Saves cookies.
Changes file extension to .sh
Filter for the Confluence REST API.
Compile code using gcc and run, raising an error if compiled code returns nonzero exit.
Changes file extension to .html
Dummy filter for allowing changing a file extension.
Compile code using gcc and run with input.
Changes file extension to .json
Compile code using clang and run.
compile code using clang and run with input.
Runs clojure code, returning stdout.
Runs clojure in REPL.
Parse clojure code into sections based on whitespace and try to guess a
Runs input through 'cowthink'.
Forces previous filter to output .cpickle extension.
Compile c++ code using cpp and run.
Compile c++ code using cpp and run with input.
Changes file extension to .txt
Add <script> tags or <link> tags to an HTML file's header.
Filter which implements some default behaviors.
Returns an ordered dict with a single element.
Renders .dot files to either PNG or PDF images.
Wraps your text in HTML header/footer which includes Baseline CSS resets.
Wraps your text in LaTeX article header/footer.
Runs Elixir (.ex) files.
Runs ghostscript ps2pdf with prepress settings.
Uses epstopdf to convert .eps files to .pdf
Runs Erlang scripts using the escript command.
Runs espeak text to speech.
Renders .dot files to either PNG or PDF images using fdp.
Runs input through 'figlet'.
Prints out the args it receives.
Deprecated. No longer needed.
Runs fopub on an xml generated by asciidoctor.
Forces previous filter to output .R extension.
Apply template to file. Template should specify {content}.
Compiles and executes fortran code.
Changes file extension to .py
Apply another file to bottom of file.
Forces previous filter to output .gif extension.
Runs 'go run' command on an input .go file. http://golang.org/
Runs 'go test' command on an input .go file. http://golang.org/
Forces previous filter to output .html extension.
Apply another file to top of file.
Returns just the first 10 lines of input.
Generates HTML from Latex source using htlatex
Deprecated, use casper.js instead.
Splits files into sections based on comments like ### "foo"
Runs inkscape in batch mode.
Imports any referenced images as data URIs.
Runs ruby code in irb.
Runs ruby scripts in irb.
Forces previous filter to output .json extension.
Compiles java code and runs main method.
Compiles java code and returns the .class object
Runs the Jinja templating engine.
Run jruby code in jirb.
Runs julia (.jl) files in the repl.
Forces previous filter to output .jpg extension.
Takes sectioned code and joins it into a single section. Some filters which
Run jruby code and return stdout.
Runs code through rhino js interpreter.
Runs rhino JavaScript interpeter.
Runs julia (.jl) files.
jython
jython in REPL
Example of storing key value data.
Runs the kramdown markdown converter.
Runs ksh. Use to run bash scripts.
Creates a new key-value store.
Forces previous filter to output .tex extension.
Generates a PDF file from LaTeX source.
Run Latex outputting a .dvi file.
Converts libreoffice files to other formats.
Returns each line in its own section.
Runs LiveScript (.ls) files.
Runs code through lua interpreter.
Converts HTML to plain text by using lynx -dump.
Runs lyx to generate LaTeX output.
Converts dexy:foo.txt|bar into << d['foo.txt|bar'] >>
Runs make tasks.
Read command names from a file and fetch man pages for each.
Runs a Markdown processor to convert markdown to HTML.
Generate a Jupyter (IPython) notebook from markdown with embedded code.
Base class for filters which divide markdown scripts into code/prose
A filter which adds an extra document to the tree.
Runs scripts using node js
Convert .org files to other formats.
Example of accessing other documents.
Only outputs extension .abc
Forces previous filter to output .pdf extension.
Convert documents to various available output formats using pandoc.
Runs ghostscript to convert PDF files to images.
Converts a PDF file to a jpg image using ghostscript.
Runs the PDFcrop script http://pdfcrop.sourceforge.net/
Uses the pdfinfo script to retrieve metadata about a PDF.
Runs `pdftocairo` from the poppler library.
Uses pdftotext from the poppler library to convert PDFs to text.
Converts extended markdown to HTML using pegdown.
Runs perl interpreter.
Runs scripts using phantom js.
Runs php file.
Runs PHP in interpeter mode.
Forces previous filter to output .pickle extension.
Runs plantuml and generates an image file.
Forces previous filter to output .png extension.
Pretty prints JSON input.
Calls `set_data` method to store output.
Writes output directly to output file.
Uses process_text method
Stores sectional data using `process` method.
Converts a postscript file to PDF format.
Runs Python code and returns stdout.
Runs python code in python's REPL.
Returns introspected python data in key-value storage format.
Apply Pygments <http://pygments.org/> syntax highlighting.
Surrounds code with highlighting instructions for Markdown
Surrounds code with highlighting instructions for ReST
Runs python code and passes input
Parses Python source code using lib2to3, without loading files, so doesn't
Runs the tests in the specified Python modules.
Runs R in REPL.
Generates ruby source code from a ragel file.
Generates state chart in .dot format of ragel state machine.
Runs ruby scripts and return stdout.
Generates a pdf from R documentation file.
Convert R documentation to other formats.
Converts github-flavored markdown to HTML using redcarpet.
Converts textile to HTML using Redcloth.
Converts textile to LaTeX using Redcloth.
Filter which loads .regex file into regetron and runs any input text against it.
Runs re.sub on each line of input.
Runs R files in batch mode, returning an R console transcript.
Experimental filter to run R in sections without using pexpect.
Generates state chart in .dot format of ragel state machine for ruby.
Runs R files in batch mode, returning just the output.
A 'native' ReST filter which uses the docutils library.
Runs rst2beamer command (docutils).
Convert rst to HTML
Runs rst2latex command (docutils).
Runs rst2man command (docutils).
Runs rst2odt command (docutils).
Runs rst2xml command (docutils).
Returns just the body part of an ReST document.
Returns key-value storage of document parts.
Extracts bibliographical metadata and makes this available to dexy.
Runs rust code.
Runs rust code in the rust repl (rusti). EXPERIMENTAL.
Compiles and runs .scala files.
Compiles .scala code to .class files.
Runs scala code in the REPL.
Runs a sed script.
Runs bash scripts using 'sh' and returns stdout.
Runs bash. use to run bash scripts.
Converts paragraphs to HTML and wrap each slide in a header and footer.
Runs code through sloccount.
Split a HTML file into nested sections based on header tags.
Companion to slides filter which helps generate speaker notes.
Generate index page linking to multiple pages from single source.
Add a blank space to the start of each line.
Runs stata files.
Runs stata files.
Clean non-printing characters from text using the 'strings' tool.
Forces previous filter to output .svg extension.
Converts an SVG file to PDF by running it through casper js.
Runs Sweave, generating a .tex file.
Forces previous filter to output .txt extension.
Wrap text in specified HTML tags.
Runs workflows in Taverna via command line tool.
Base class for templating system filters such as JinjaFilter. Templating
Create a .tgz archive containing the unprocessed files in a directory.
Uses tidy to clean and validate HTML.
Runs `tidy` to check for valid HTML.
Uses tidy to print HTML errors.
Renders Tikz code to PDF.
http://dag.wiee.rs/home-made/unoconv/
Runs `sed` on the input file.
Runs input through wc command line tool.
Converts wiki content to beamer.
Posts to a WordPress blog.
Dexy filter to use WebSequenceDiagrams.com
Wraps text after 79 characters (tries to preserve existing line breaks and
Forces previous filter to output .xml extension.
Runs .tex files using xelatex.
Specify attributes in YAML at top of file.
Creates a .zip archive of all input documents.
sweave: Runs Sweave, generating a .tex file.
cowsay: Runs input through 'cowsay'.
cowthink: Runs input through 'cowthink'.
figlet: Runs input through 'figlet'.
asciidoc: Runs asciidoc command.
asciidoctor: Runs `asciidoctor`.
c: Compile code using gcc and run.
cfussy: Compile code using gcc and run, raising an error if compiled code returns nonzero exit.
cinput: Compile code using gcc and run with input.
clang: Compile code using clang and run.
clanginput: compile code using clang and run with input.
clj: Runs clojure code, returning stdout.
cljint: Runs clojure in REPL.
bash: Runs bash scripts using 'bash' and returns stdout.
c: Compile code using gcc and run.
cfussy: Compile code using gcc and run, raising an error if compiled code returns nonzero exit.
cinput: Compile code using gcc and run with input.
clang: Compile code using clang and run.
clanginput: compile code using clang and run with input.
clj: Runs clojure code, returning stdout.
cljint: Runs clojure in REPL.
cpp: Compile c++ code using cpp and run.
cppinput: Compile c++ code using cpp and run with input.
escript: Runs Erlang scripts using the escript command.
irb: Runs ruby code in irb.
irbout: Runs ruby scripts in irb.
java: Compiles java code and runs main method.
javac: Compiles java code and returns the .class object
jirb: Run jruby code in jirb.
jruby: Run jruby code and return stdout.
js: Runs code through rhino js interpreter.
jsint: Runs rhino JavaScript interpeter.
jython: jython
jythoni: jython in REPL
kshint: Runs ksh. Use to run bash scripts.
lua: Runs code through lua interpreter.
matlabint: Runs matlab in REPL.
nodejs: Runs scripts using node js
perl: Runs perl interpreter.
php: Runs php file. Php code must be included in tags.
phpint: Runs PHP in interpeter mode.
py: Runs Python code and returns stdout.
pycon: Runs python code in python's REPL.
pyin: Runs python code and passes input
r: Runs R in REPL.
rb: Runs ruby scripts and return stdout.
rintbatch: Runs R files in batch mode, returning an R console transcript.
rout: Runs R files in batch mode, returning just the output.
rust: Runs rust code.
rusti: Runs rust code in the rust repl (rusti). EXPERIMENTAL.
scala: Compiles and runs .scala files.
scalac: Compiles .scala code to .class files.
scalai: Runs scala code in the REPL.
sh: Runs bash scripts using 'sh' and returns stdout.
shint: Runs bash. use to run bash scripts.
stata: Runs stata files.
statai: Runs stata files.
c: Compile code using gcc and run.
cfussy: Compile code using gcc and run, raising an error if compiled code returns nonzero exit.
cinput: Compile code using gcc and run with input.
clang: Compile code using clang and run.
clanginput: compile code using clang and run with input.
cpp: Compile c++ code using cpp and run.
cppinput: Compile c++ code using cpp and run with input.
java: Compiles java code and runs main method.
javac: Compiles java code and returns the .class object
rust: Runs rust code.
rust: Runs rust code.
scala: Compiles and runs .scala files.
scalac: Compiles .scala code to .class files.
cpp: Compile c++ code using cpp and run.
cppinput: Compile c++ code using cpp and run with input.
html2pdf: Deprecated, use casper.js instead. Renders HTML to PDF using wkhtmltopdf. If the HTML relies on assets such as CSS or image files, these should be specified as inputs. If you have an older version of wkhtmltopdf, and are running on a server, you may get XServer errors. You can install xvfb and run Dexy as `xvfb-run dexy`. Or upgrade to the most recent wkhtmltopdf which only needs X11 client libs.
dot: Renders .dot files to either PNG or PDF images.
fdp: Renders .dot files to either PNG or PDF images using fdp.
rageldot: Generates state chart in .dot format of ragel state machine.
rlrbd: Generates state chart in .dot format of ragel state machine for ruby.
calibre: Runs `ebook-convert` command (part of calibre) Generates various output formats (including .mobi for Kindle) http://manual.calibre-ebook.com/cli/ebook-convert.html
pandoc: Convert documents to various available output formats using pandoc.
escript: Runs Erlang scripts using the escript command.
bn: Forces previous filter to output .bmp extension.
cb: Changes file extension to .sh
ch: Changes file extension to .html
cj: Changes file extension to .json
cpickle: Forces previous filter to output .cpickle extension.
ct: Changes file extension to .txt
forcer: Forces previous filter to output .R extension.
fpy: Changes file extension to .py
gn: Forces previous filter to output .gif extension.
h: Forces previous filter to output .html extension.
j: Forces previous filter to output .json extension.
jn: Forces previous filter to output .jpg extension.
l: Forces previous filter to output .tex extension.
p: Forces previous filter to output .pdf extension.
pickle: Forces previous filter to output .pickle extension.
pn: Forces previous filter to output .png extension.
svg: Forces previous filter to output .svg extension.
t: Forces previous filter to output .txt extension.
x: Forces previous filter to output .xml extension.
bw: Converts color pdf to black and white.
pdf2img: Runs ghostscript to convert PDF files to images. An image file can only hold a single page of PDF, so this defaults to returning page 1. The `page` setting can be used to specify other pages.
pdf2jpg: Converts a PDF file to a jpg image using ghostscript.
casperjs: Runs scripts using casper js. Saves cookies.
phantomjs: Runs scripts using phantom js.
asciidoc: Runs asciidoc command.
asciidoctor: Runs `asciidoctor`.
casperjs: Runs scripts using casper js. Saves cookies.
htlatex: Generates HTML from Latex source using htlatex
lynxdump: Converts HTML to plain text by using lynx -dump.
pandoc: Convert documents to various available output formats using pandoc.
phantomjs: Runs scripts using phantom js.
tidy: Uses tidy to clean and validate HTML.
tidycheck: Runs `tidy` to check for valid HTML. This filter does not alter valid HTML. It raises an Exception if invalid HTML is found.
tidyerrors: Uses tidy to print HTML errors.
dot: Renders .dot files to either PNG or PDF images.
fdp: Renders .dot files to either PNG or PDF images using fdp.
inkscape: Runs inkscape in batch mode.
libreoffice: Converts libreoffice files to other formats.
pdf2jpg: Converts a PDF file to a jpg image using ghostscript.
pdftocairo: Runs `pdftocairo` from the poppler library. Converts PDF input to various output formats inclusing SVG.
unoconv: http://dag.wiee.rs/home-made/unoconv/
sloc: Runs code through sloccount.
wc: Runs input through wc command line tool.
cinput: Compile code using gcc and run with input.
clanginput: compile code using clang and run with input.
cppinput: Compile c++ code using cpp and run with input.
pyin: Runs python code and passes input
java: Compiles java code and runs main method.
javac: Compiles java code and returns the .class object
casperjs: Runs scripts using casper js. Saves cookies.
js: Runs code through rhino js interpreter.
jsint: Runs rhino JavaScript interpeter.
nodejs: Runs scripts using node js
phantomjs: Runs scripts using phantom js.
java: Compiles java code and runs main method.
javac: Compiles java code and returns the .class object
jython: jython
jythoni: jython in REPL
scala: Compiles and runs .scala files.
scalac: Compiles .scala code to .class files.
jython: jython
jythoni: jython in REPL
htlatex: Generates HTML from Latex source using htlatex
latexdvi: Run Latex outputting a .dvi file.
lyx: Runs lyx to generate LaTeX output.
rst2latex: Runs rst2latex command (docutils).
wiki2beamer: Converts wiki content to beamer.
xelatex: Runs .tex files using xelatex.
sweave: Runs Sweave, generating a .tex file.
lua: Runs code through lua interpreter.
lyx: Runs lyx to generate LaTeX output.
redcloth: Converts textile to HTML using Redcloth.
redclothl: Converts textile to LaTeX using Redcloth.
rst2odt: Runs rst2odt command (docutils).
matlabint: Runs matlab in REPL.
abc: Runs `abcm2ps` on .abc music files.
abcm: Runs `abcm2ps` on .abc music files, generating all output formats.
libreoffice: Converts libreoffice files to other formats.
unoconv: http://dag.wiee.rs/home-made/unoconv/
ragel: Generates ruby source code from a ragel file.
rageldot: Generates state chart in .dot format of ragel state machine.
rlrbd: Generates state chart in .dot format of ragel state machine for ruby.
bw: Converts color pdf to black and white.
dot: Renders .dot files to either PNG or PDF images.
embedfonts: Runs ghostscript ps2pdf with prepress settings. Allegedly this helps embed fonts and makes documents friendly for printing.
epstopdf: Uses epstopdf to convert .eps files to .pdf
fdp: Renders .dot files to either PNG or PDF images using fdp.
fopub: Runs fopub on an xml generated by asciidoctor.
html2pdf: Deprecated, use casper.js instead. Renders HTML to PDF using wkhtmltopdf. If the HTML relies on assets such as CSS or image files, these should be specified as inputs. If you have an older version of wkhtmltopdf, and are running on a server, you may get XServer errors. You can install xvfb and run Dexy as `xvfb-run dexy`. Or upgrade to the most recent wkhtmltopdf which only needs X11 client libs.
inkscape: Runs inkscape in batch mode.
libreoffice: Converts libreoffice files to other formats.
lyx: Runs lyx to generate LaTeX output.
pdf2img: Runs ghostscript to convert PDF files to images. An image file can only hold a single page of PDF, so this defaults to returning page 1. The `page` setting can be used to specify other pages.
pdf2jpg: Converts a PDF file to a jpg image using ghostscript.
pdfcrop: Runs the PDFcrop script http://pdfcrop.sourceforge.net/
pdfinfo: Uses the pdfinfo script to retrieve metadata about a PDF.
pdftocairo: Runs `pdftocairo` from the poppler library. Converts PDF input to various output formats inclusing SVG.
pdftotext: Uses pdftotext from the poppler library to convert PDFs to text.
ps2pdf: Converts a postscript file to PDF format.
rd2pdf: Generates a pdf from R documentation file.
unoconv: http://dag.wiee.rs/home-made/unoconv/
xelatex: Runs .tex files using xelatex.
perl: Runs perl interpreter.
php: Runs php file. Php code must be included in tags.
phpint: Runs PHP in interpeter mode.
py: Runs Python code and returns stdout.
pycon: Runs python code in python's REPL.
pyin: Runs python code and passes input
ragel: Generates ruby source code from a ragel file.
rageldot: Generates state chart in .dot format of ragel state machine.
rlrbd: Generates state chart in .dot format of ragel state machine for ruby.
rst2beamer: Runs rst2beamer command (docutils).
rst2html: Convert rst to HTML
rst2latex: Runs rst2latex command (docutils).
rst2man: Runs rst2man command (docutils).
regetron: Filter which loads .regex file into regetron and runs any input text against it.
cljint: Runs clojure in REPL.
irb: Runs ruby code in irb.
irbout: Runs ruby scripts in irb.
jirb: Run jruby code in jirb.
jsint: Runs rhino JavaScript interpeter.
jythoni: jython in REPL
kshint: Runs ksh. Use to run bash scripts.
matlabint: Runs matlab in REPL.
phpint: Runs PHP in interpeter mode.
pycon: Runs python code in python's REPL.
r: Runs R in REPL.
rintbatch: Runs R files in batch mode, returning an R console transcript.
rintmock: Experimental filter to run R in sections without using pexpect.
rusti: Runs rust code in the rust repl (rusti). EXPERIMENTAL.
scalai: Runs scala code in the REPL.
shint: Runs bash. use to run bash scripts.
statai: Runs stata files.
taverna: Runs workflows in Taverna via command line tool.
r: Runs R in REPL.
rd2pdf: Generates a pdf from R documentation file.
rdconv: Convert R documentation to other formats.
rintbatch: Runs R files in batch mode, returning an R console transcript.
rintmock: Experimental filter to run R in sections without using pexpect.
rout: Runs R files in batch mode, returning just the output.
irb: Runs ruby code in irb.
irbout: Runs ruby scripts in irb.
jirb: Run jruby code in jirb.
jruby: Run jruby code and return stdout.
ragel: Generates ruby source code from a ragel file.
rb: Runs ruby scripts and return stdout.
rlrbd: Generates state chart in .dot format of ragel state machine for ruby.
rusti: Runs rust code in the rust repl (rusti). EXPERIMENTAL.
scala: Compiles and runs .scala files.
scalac: Compiles .scala code to .class files.
scalai: Runs scala code in the REPL.
casperjs: Runs scripts using casper js. Saves cookies.
phantomjs: Runs scripts using phantom js.
bash: Runs bash scripts using 'bash' and returns stdout.
kshint: Runs ksh. Use to run bash scripts.
sh: Runs bash scripts using 'sh' and returns stdout.
shint: Runs bash. use to run bash scripts.
matlabint: Runs matlab in REPL.
r: Runs R in REPL.
rintbatch: Runs R files in batch mode, returning an R console transcript.
rintmock: Experimental filter to run R in sections without using pexpect.
rout: Runs R files in batch mode, returning just the output.
stata: Runs stata files.
statai: Runs stata files.
sweave: Runs Sweave, generating a .tex file.
lynxdump: Converts HTML to plain text by using lynx -dump.
redcloth: Converts textile to HTML using Redcloth.
redclothl: Converts textile to LaTeX using Redcloth.
rst2odt: Runs rst2odt command (docutils).
espeak: Runs espeak text to speech.
plantuml: Runs plantuml and generates an image file.
man: Read command names from a file and fetch man pages for each. Returns a JSON dict whose keys are the program names and values are man pages.
sed: Runs a sed script. Any dependencies are assumed to be text files and they have the sed script applied to them.
strings: Clean non-printing characters from text using the 'strings' tool.
used: Runs `sed` on the input file. Expects a sed script to be a dependency.
taverna: Runs workflows in Taverna via command line tool.
Content © 2020 Dr. Ana Nelson | Site Design © Copyright 2011 Andre Gagnon | All Rights Reserved.