plastexdepgraph 0.0.5

Dependency graph plugin for plasTeX.

plasTeX dependency graphs

This is a plasTeX plugin allowing to build dependency graphs.

Needs graphviz and its dev libraries. If you have a user-friendly OS, it is as simple as sudo apt install graphviz libgraphviz-dev. See https://pygraphviz.github.io/documentation/stable/install.html otherwise.

You can use this package with plasTeX using \usepackage{depgraph}. Note that the Lean blueprint package automatically loads this packages and transmit options.

Options

When loading the package inside the tex file, you can give the following arguments:

• title: the title of the dependency graph. The default value is Dependencies.
• dep_by: optional level for dependency graph generation, for instance chapter or part. The default value is to generate one graph for the whole document
• thms: optional list of theorem types to include into the report, separated by +. The default value is: definition+lemma+proposition+theorem+corollary
• nonreducedgraph: keep all edges in the dependency, even transitively redundant ones.
• tpl: template file for dependency graph, relative to the current directory

For instance you could write

\usepackage[thms=dfn+lem+prop+thm+cor]{depgraph}

if you like short environment names.

This package will also consider optional information contained in the document userdata dictionary. Such information could be added by other packages who want to influence the dependency graph. For instance the Lean blueprint plugin does that.

• document.userdata['dep_graph']['shapes'] can be a dictionary whose keys are node kinds as strings and whose values are strings descripting graphviz shapes (see https://graphviz.org/doc/info/shapes.html). By default, everything uses an ellipse except definition which uses a box.

• document.userdata['dep_graph']['colorizer'] can be a function taking as input a plasTeX node and outputting a CSS color for the boundary of graph nodes.

• document.userdata['dep_graph']['fillcolorizer'] can be a function taking as input a plasTeX node and outputting a CSS color for the interior of graph nodes.

• document.userdata['dep_graph']['stylerizer'] can be a function taking as input a plasTeX node and outputting a graphviz style (see https://graphviz.org/docs/attr-types/style/).

• document.userdata['dep_graph']['legend'] can be a list whose entries are pairs made of a visual description and an explanation. The default value is: [('Boxes', 'definitions'), ('Ellipses', 'theorems and lemmas')] Additional entries can also refer to colors.

• document.userdata['dep_graph']['extra_modal_links'] can be a list of Jinja2 templates used to render extra links at the bottom of the modal appearing when clicking on graph nodes. The default value is an empty list.