Skip to content

Doc42 0.6.0

Choose a tag to compare

@jevontech jevontech released this 08 Nov 15:42
d203111

Doc42 builds every document of a model in one run, keeps readable diagrams in the text, and warns when a figure would print too small to read.

  • Build every document at once. doc42 build model --all --out out builds all documents in the model, loading it once. Every document is checked before any is rendered, so an error leaves no partial set. With --json, build prints a manifest of the files written and each document's metadata (title, number, revision, status, …); doc42 list --json reports the same metadata without a license.
  • Diagrams stay in the text when they can. A diagram that stays readable when scaled to the text width (65 % or more) stays in the text on the portrait page, scaled to fit, instead of running past the margin. Only a larger one gets a page of its own, landscape when that shows it clearly larger.
  • Too-small figures are reported. When a figure's smallest text would print below 5 pt, check, build and ir warn with doc42-figure-text-size, naming the printed size and the page. Set another minimum with --min-text-size, and make it an error with --strict, so a release job stops on an unreadable figure.
  • Clearer diagrams from Spec42 0.60.1. Action flows put inputs on top of each action and outputs below it, so flows run straight down. In interconnection views limited in depth, a bus is drawn as one port and ports face the parts they connect to. Diagrams whose expressions use quantity units, such as remaining + 60 [s] in a transition, no longer stop the build.
  • doc42.exe needs nothing beyond Windows. It is built natively for Windows and needs no Visual C++ redistributable.

Breaking: the Document IR (doc42 ir) is version 4. Figures add placement and smallest_text. A custom template that places figures itself should use placement; templates that use the built-in doc42-figure need no change.

Use elan8/doc42-release@v0.6.0. Built with Spec42 0.60.1. Linux x64 needs glibc 2.35 or later.