Create a PDF template from Word
Create a PDF template from Word
Section titled “Create a PDF template from Word”Use an existing .docx as design evidence for a PDF template. atlcli compares
what it can recognize with the complete Editorial Indigo baseline, presents
the proposed changes in business terms, and applies nothing until you choose.
The result is a verified .wiki-pdf-template pack for later PDF exports.
The import is intentionally a review workflow, not a Word-to-PDF conversion. Your document content is not copied into the template pack.
On this page
Section titled “On this page”- Prerequisites
- The four-step workflow
- Minimal workflow
- Review design choices
- Review graphics
- Preview and build
- Resume or undo
- Use the pack
- What can and cannot transfer
- Security and privacy
- Troubleshooting
- Related topics
Prerequisites
Section titled “Prerequisites”- A
.docxcontaining representative styles and page design. - atlcli installed. Creating the pack is local and does not require a Confluence profile.
- The right to reuse every graphic you choose to include.
- A PDF viewer for the generated design review.
For a useful result, include the document elements that matter to your normal output: headings, body text, lists, tables, headers or footers, and any background or brand graphics. A one-page sample is enough if it contains those elements.
The four-step workflow
Section titled “The four-step workflow”importanalyzes the Word design into a local, resumable project.reviewlets you apply, retain, or leave open each supported choice.previewrenders a design review and compatibility proof.buildvalidates the reviewed design and creates one verified pack.
The project is the durable workspace. You can stop after any command and
continue later with status.
Minimal workflow
Section titled “Minimal workflow”atlcli pdf-template import ./brand.docxatlcli pdf-template review ./brand-pdf-templateatlcli pdf-template preview ./brand-pdf-templateatlcli pdf-template build ./brand-pdf-template \ --output ./brand.wiki-pdf-templateThe default project directory is
./<word-file-name>-pdf-template. Import refuses to replace an existing
directory.
The primary journey looks like this:
$ atlcli pdf-template import brand.docxAnalyzed brand.docx
12 design choices are ready to apply 4 need your review 3 Word features cannot be transferred
No Word suggestions have been applied yet.The draft currently uses Editorial Indigo.
Project: ./brand-pdf-templateNext: atlcli pdf-template review ./brand-pdf-template
$ atlcli pdf-template review ./brand-pdf-template…review the grouped choices…
$ atlcli pdf-template preview ./brand-pdf-templateOK Ready to build…design-review: ./brand-pdf-template/proof/design-review.pdfcompatibility-proof: ./brand-pdf-template/proof/compatibility-proof.pdf
$ atlcli pdf-template build ./brand-pdf-template \ --output ./brand.wiki-pdf-templateOK Built…archive: ./brand.wiki-pdf-templateCounts and available questions depend on the source document. The command order, stages, project behavior, and next-action guidance do not.
Review design choices
Section titled “Review design choices”Interactive review groups choices by familiar areas such as page layout, typography, colors, headings, tables, and graphics. Each item shows:
- the current Editorial Indigo value;
- the value found in Word;
- what atlcli recommends and why;
- whether the match is ready, uncertain, unsupported, or blocked.
No suggestion is applied during the default import. During review you can accept a ready match, keep the current value, skip it for later, go back, or stop. Stopping commits only the answers you already gave and leaves the rest open.
For a non-interactive first pass, apply only ready choices explicitly:
atlcli pdf-template review ./brand-pdf-template \ --apply-ready --non-interactiveUse status afterward. Build stays blocked while required decisions or
unsupported-inventory acknowledgements remain open.
Review graphics
Section titled “Review graphics”Graphics are separate decisions because a visually plausible match is not proof of intent or permission. When graphics are present, review first creates an asset contact sheet. For every included graphic, atlcli asks for:
- its PDF role: logo, page background, cover art, header decoration, or footer decoration;
- confirmation that you intend to use it;
- confirmation that you have the right to use it;
- whether it is decorative or needs alternative text;
- placement: the safe slot default, a stable source placement when available, or an explicit custom placement.
A graphic enters the final pack only after all confirmations succeed. Unselected graphics stay in the private local intake area and are excluded from the pack.
Use metadata-only mode when you want to inspect style candidates without extracting graphic bytes:
atlcli pdf-template import ./brand.docx --metadata-onlyTo review graphics later, reanalyze the original source without that flag:
atlcli pdf-template reanalyze ./brand.docx \ --dir ./brand-pdf-templatePreview and build
Section titled “Preview and build”Preview creates:
proof/design-review.pdf— baseline and reviewed design, including counts for applied, retained, open, and unsupported choices;proof/compatibility-proof.pdf— representative headings, paragraphs, tables, callouts, and other supported output;proof/asset-contact-sheet.pdf— only when the source contains graphics;proof/results.json— compiler version, hashes, page counts, regions, and the project generation those PDFs prove.
Open the design review before building. If you change any decision afterward, the preview becomes stale and must be created again.
build refuses unanswered decisions, stale previews, invalid assets, unsafe
pack contents, or a pack that fails a real Typst compile. It never overwrites
an existing output file.
Resume or undo
Section titled “Resume or undo”Resume without changing anything:
atlcli pdf-template status ./brand-pdf-templateIf the Word source changed, reanalyze it into the same project:
atlcli pdf-template reanalyze ./brand-v2.docx \ --dir ./brand-pdf-templateatlcli retains prior intent where it still matches and reports stale or unmatched decisions for review. It does not partially activate a failed reanalysis.
Undo creates a new generation from the previous committed design; it does not delete history:
atlcli pdf-template undo ./brand-pdf-templateatlcli pdf-template preview ./brand-pdf-templateA restored design needs a fresh preview before it can be built.
Use the pack
Section titled “Use the pack”Pass the generated pack by path when exporting PDF:
atlcli wiki export 12345678 --format pdf \ --template ./brand.wiki-pdf-template \ --output ./brand-report.pdf --jsonWithout --template, PDF export continues to use Editorial Indigo. The pack is
validated locally before atlcli contacts Confluence.
What can and cannot transfer
Section titled “What can and cannot transfer”atlcli transfers supported design intent, not arbitrary Word rendering behavior.
| Confidence | Examples | What happens |
|---|---|---|
| Reliable | Page size and margins, explicit colors, named style typography, paragraph spacing, borders, supported header/footer graphics | Presented as supported candidates with source evidence |
| Needs review | Theme indirection, competing style definitions, inferred graphic role, repeated decorations, layout-dependent placement | Kept open until you choose |
| Not transferable | Macros, fields or executable expressions, arbitrary DrawingML effects, unsupported shapes, Word-only pagination behavior | Named in the unsupported inventory; never silently approximated |
The compatibility proof is the final check for the output features you care about. Word and Typst are different layout engines, so equal design tokens do not guarantee identical line breaks or pagination.
Security and privacy
Section titled “Security and privacy”- Analysis, review, preview, and build run locally.
- The project uses private directory and file permissions where the platform supports them.
- Extracted source graphics live under the project’s private
.intakearea. - The portable project state contains hashes and normalized design facts, not raw OOXML or document body text.
- The final pack contains only the resolved design, canonical generated Typst, required metadata, and graphics you explicitly accepted.
- DOCX macros, fields, expressions, and embedded code are never executed.
- XML, ZIP, raster, and SVG limits are enforced before expensive processing.
- Deleting the project is a local filesystem operation;
undois the safer choice while you are still working.
Treat the local project as sensitive if the source graphics are sensitive. Do not commit it unless your repository policy explicitly allows those assets.
Troubleshooting
Section titled “Troubleshooting”| Symptom | Likely cause | Fix |
|---|---|---|
| Project directory already exists | Initial import is no-clobber | Resume it with status, choose another --dir, or remove it only after confirming it is disposable |
| Review shows no graphics | Import used --metadata-only, or the graphic format/relationship is unsupported |
Reanalyze without --metadata-only; check the unsupported inventory |
| Candidate placement is unavailable | Word placement depends on layout or an unsupported reference frame | Use the role’s slot default or an explicit reviewed custom placement |
| Preview is stale | A decision or source analysis changed | Run preview again |
| Build says review remains open | One or more choices or inventory items are unanswered | Run review; use status to see the next valid action |
| Build refuses the output path | The archive already exists | Choose a new path; build deliberately does not overwrite |
| Source changed | The project was analyzed from different bytes | Run reanalyze <updated.docx> --dir <project> |
| A font falls back | The Word font is not in the bundled PDF font set | Choose a supported font during review and inspect the compatibility proof |
Related topics
Section titled “Related topics”- PDF template authoring CLI — commands, flags, machine output, and automation
- DOCX and PDF Export — use a generated pack
- Export template library — Word templates, PDF packs, and host differences
- PDF Template Contract — runtime contract and versioning
- Template Pack Format — archive and validation details