Disseminate

Document Processing

Installation

Markup Language

Projects

Interfaces

Development

Release Notes

v2.3

  1. Webserver. Implementation of the Tornado library for the internal preview webserver.

v2.2

  1. CLI. Implementation of the cli init subcommand.

v2.1

  1. Epub. Implementation of epub version 3 as document target format.

  2. Documentation. Documentation updates for API changes, added an Overview section with Installation, Quickstart and Features sections.

v2.0

  1. Builders. Implementation of thread locking and ThreadPoolExecutor for builder threads.

  2. Builders. Implementation of process timeouts.

  3. Templates. CSS updates to books/tufte, books/novel.

v1.0

  1. Builder. Implementation of the builder framework for multithreaded and multiprocess compilation of documents and document dependencies.

  2. Dependency Manager. Elimination of the dependency manager, which is now replaced by builders.

v0.21

Tags

  1. Problem boxes. Added a feature box for problems.

v0.20

Tags

  1. Tables. Tags to render tables.

  2. Data. Tags to incorporate data into tables or plots.

  3. Captions. Captions now render in html using the caption or figcaption tags.

  4. Figures. Figures now render in html using the figure tag.

  5. Equations. Refactor image, equation and paragraph tags to automatically identify equations in a block paragraph, without specifying the equation environment (ex: @eq[env=align*]{...})

v0.19

Tags

  1. Feature Boxes. A box with a feature for a text, like an example box (@examplebox) or a general featurebox (@featurebox)

  2. Headings. The behavior of heading tags to not list the contents of the tag by default. Instead, a label tag is created, and the content of the tag is included if a @label.title macro was included.

  3. Equations

    3.1. tex: Block equations (equations in their own paragraph) are written

    without newlines before/after the environment in latex.

Templates

  1. books/tufte. Remove indentation before captions.

Documentation

  1. Feature Boxes. Add the @featurebox and @examplebox tags to the language documentation.

Bug Fixes

  1. Fixed the renaming of filenames with periods in converters. Created a new path utility, rename, that more intelligently renames files.

v0.18

Document

  1. Add local path (parent dir) to the search paths for each document

  2. Files are copied both from the local path of a document or subdocument or the project root path.

Converters

  1. Imagemagick. Implemented a .tif/.tiff converter to .png

Bug Fixes

  1. Wrap filenames and paths in curly braces for LaTeX \includegraphics command. This is needed to deal with filenames that include special characters, like periods.

v0.17

Tags

  1. Implementation of the @list and @outline tags.

  2. Implementation of @prev and @next tags with signals

  3. Implementation of a general html_list function for @list and @toc tags

Document

  1. Implementation of signals.

v0.16

Backend

  1. Webserver. Implement sanic for preview server.

  2. Heritable tags. Allow tags to be copied and inherited between documents. This enables @toc tags and navigation tags to be shared between a document and its subdocuments.

  3. Navigation tags. Add navigations tags @prev and @next to add html links for the previous or next page. These are available as the prev and next entries in the context.

v0.15

Interfaces

  1. Click. Implemented Click for the CLI

  2. Flask. Removed the server interface from the project

v0.14

Interfaces

  1. Flask. Implement Flask web server for viewing the document list and rendered products.

Backend

  1. BaseContext. Refactor to copy values from parent_context, rather than use a ChainMap implementation. This significantly speeds up look ups and loading of documents.

  2. BaseContext. Create shallow copies of mutables from the parent_context so that these aren’t modified directly. This is only done for mutables that have copy methods so that some mutables, like the LabelManager and DependencyManager, can be preserved by all contexts and documents in a project

  3. ProcessContextHeader. Refactor to use the new implementation of the BaseContext. The ProcessContextHeader now does the work of loading templates and loading additional context headers.

  4. Renderers. Simplify the API.

v0.13 beta

Backend

  1. Documentation. Update documentation to use sphinx.

  2. Context. Rewrote context to work like a ChainMapping with inherited entries from a parent_context.

  3. Paths. Allow relative links and urls.

  4. TemplateStrings. Eliminated the TemplateString class with a replace_macro function.

  5. Equation Tags. Implement a new pdf cropping converter to more cleanly crop equation images in targets like .html.

  6. Attributes. Refactored tag attributes to use an ordered dict instead of tuples. The Attributes class now includes useful utility functions, like filter and exclude.

  7. Formats. Refactor the formatting of targets for tags with a new formats sub-module. This module now checks for allowed tags in the settings. The formats submodule also isolates the dependency of external packages, like lxml, to one place instead of multiple places.

  8. Processors. Created a ProcessorABC abstract base class as a chain of command class for objects like tags and context. Included a simple listing of processors in the CLI.

  9. Tags. Eliminate the ast submodule and replaced with a TagProcessor.

  10. Document. Moved context processors to the document submodule and refactor to use the ProcessorABC.

  11. Label Manager. Refactored to simplify the assignment of labels, the resetting of label counters and to minimize the dependency of labels for tags. Also added a set of label processors based on the ProcessorABC.