User Manual • docdesigner

This manual gathers the main package documentation in one place.

Outputs

docdesigner::pdf creates a designed PDF document.
docdesigner::html creates plain body HTML for WordPress or another CMS.

Start

docdesigner::designer_use(template = "pdf")
docdesigner::designer_use(template = "html")

Styles

Use docdesigner::designer_styles() to inspect built-in PDF styles. Use docdesigner::designer_gallery() to write a local HTML style gallery, or docdesigner::designer_specimens() to render a specimen PDF of every style.

A style is a format.yml file of design tokens. Scaffold one with docdesigner::designer_new_style(), check it with docdesigner::designer_validate_style(), and see docdesigner::designer_tokens() for the full token vocabulary. The Creating a style article covers the workflow and the principles of a good style.

Update Local Assets

Most projects use bundled package assets. Projects with local editable copies can refresh them:

docdesigner::designer_update_templates()

Reviewing a Draft

The review style prints a manuscript to read and mark up by hand: a 3in writing margin, line and paragraph numbers, a map of the argument from the headings, margin flags, citation keys, and changebars against an earlier version.

output:
  docdesigner::pdf:
    style: review
    changes_since: v1.0          # a git tag, commit, or earlier copy; default: latest tag
    markup:
      line_numbers: 0            # turn one feature off for this printout

In the text, [[TODO: words]], [[CITE]], [[WEAK]], [[CUT]], [[CHECK]] and [[FIX]] print as margin tags. Write headings as claims: a heading of fewer than four words is flagged LABEL?. warning: auto prints a stamped “Review draft” line with the git version and date.

Diagnostics

docdesigner::designer_check()