Adobe FrameMaker Technical Documentation Handbook
The Practitioner's Guide to Structured XML/DITA Authoring, Template Architecture, EDD Modeling, and Multi-Channel Publishing
For more than three decades, Adobe FrameMaker has stood as the enterprise benchmark for long-document desktop publishing and structured XML architecture. In aerospace, defense, medical device manufacturing, and industrial machinery, documentation is not merely supplementary—it is a mission-critical engineering asset.
Grounded in a comprehensive, real-world case study—the Kestrel KP-200 Centrifugal Slurry Pump Field Service Manual—this handbook delivers battle-tested procedures, exact menu paths, keyboard shortcuts, XML code listings, and automation scripts designed for immediate production deployment.
What Makes This Handbook Different
Zero invented UI, no casual word-processor habits, and zero high-level hand-waving. Built for working documentation engineers.
Windows-Only Verified UI
Every single menu path, dialog title, shortcut, and property label traces directly to verified 64-bit Windows installations of FrameMaker 2020, 2022, and 2026. No Mac command substitutions or invented menu items.
Running Case Study: The Kestrel Project
You don't learn isolated theory. Across 14 chapters, you build the complete Kestrel KP-200 Centrifugal Slurry Pump Field Service Manual for Northfield Fluid Systems: templates, conditional variables, book files, EDD, and DITA maps.
OASIS DITA 1.3 Errata 02 Standard
Learn structured authoring against the canonical OASIS standard: task, concept, and reference topics, relationship tables (reltables), keyref mechanisms, and cross-topic content references (conrefs).
ExtendScript Automation Pipeline
Includes complete, runnable ExtendScript source (kestrel-build.jsx) to open book structures, update cross-references, synchronize catalogs, and execute automated multi-channel batch publishing.
14 Chapters Across 3 Engineering Parts
From initial document geometry to structured XML schemas and headless automation.
Core Foundations & Single-Sourcing Mechanics
Body, Master, and Reference page interactions; multi-column text flows; dynamic background running headers.
Paragraph and character catalogs, autonomous numbering streams, eliminating formatting overrides, layout import.
Multi-page table structures, header straddles, anchor frames (Below Current Line vs. Run Into Paragraph), equation frames.
Multi-variable product libraries, Boolean condition expressions (Model-200 vs Model-250), cross-file variable synchronization.
Master book files, autonomous chapter numbering, multi-level TOC generation, two-pass indexing with sorting specifiers.
Structured FrameMaker, EDDs, & DITA 1.3
Container elements, attribute definitions, context-sensitive formatting rules, element catalogs, structure validation.
Translating XML structures to FrameMaker formatting; configuring structapps.fm; entity mapping.
Task, Concept, and Reference topic types; DITA maps; relationship tables (reltable); keys and indirect addressing.
Single-sourcing modular XML topics; conditional filtering with DITAVAL; managing key spaces across enterprise product lines.
Architecting conversion tables; mapping paragraph/character tags to XML element trees; wrapping inline structures.
Multi-Channel Publishing & Production Automation
CMYK prepress compliance, bleed and crop geometry, PDF/A-1b archiving, tagged PDF structure trees, alt-text tags.
Configuring the FrameMaker Publishing Server engine; mapping paragraph styles to semantic HTML5; CSS styling overrides.
Automating batch book updates, cross-reference verification, PDF generation, and log analysis via JavaScript (ExtendScript).
25 proven recipes for catalog corruption, broken cross-references, missing fonts, unresolvable DITA conrefs, and MIF repair.
The Kestrel Project Starter Kit & Windows Shortcut Matrix
Every starter template, structured application configuration, read/write translation rule, and ExtendScript automation script from the handbook—packaged and ready for immediate deployment on Adobe FrameMaker 2020, 2022, and 2026.
Deploy the Kestrel Pipeline in Under 3 Minutes
Enter your professional email below to immediately access and download the complete 5-part engineering package.
Kestrel Master Template (.mif / .fm)
Pre-configured 8.5" × 11" FrameMaker template featuring the 25-element paragraph catalog, character styles, custom master spreads (Left, Right, First), and dynamic running variable definitions.
templates/kestrel-template.mifstructapps.fm XML Application Snippet
Drop-in <XMLApplication> registration block for structapps.fm using portable $STRUCTDIR and $APPDATADIR path variables. Zero absolute drive letter conflicts.
Production Read/Write Rules (kestrel-rw.txt)
The complete 331-line translation specification mapping XML elements, CALS parts tables, graphic attributes, index markers, and bidirectional conditional profiling attributes.
structure/rules/kestrel-rw.txtExtendScript Build Suite (kestrel-build.jsx)
Headless automation engine: batch-opens book components, synchronizes catalogs, applies single-sourcing condition filters, audits rogue tags, updates cross-references, and logs build receipts.
scripts/kestrel-build.jsxWindows Shortcut Reference Sheet (PDF)
Laminated 2-page desktop matrix covering all verified sequential escape sequences (Esc Shift+F I P), function key mappings (F1–F9), table manipulation, and Structure View tree navigation.
Corporate Publishing & Automation Tiers
Equip your technical publications department with verified lay-flat desk references, internal team/intranet rights, and unattended CI/CD automation suites.
Team Reference Pack
Designed for specialized engineering teams and technical writing pods needing physical reference manuals and team-wide digital access.
kestrel-template.mif, kestrel-rw.txt (331 lines), and structapps.fm snippet. build-book.cmd, build-book.sh, and headless-build-runner.jsx. Enterprise Department Suite
Engineered for defense primes, aerospace, and medical device publications departments requiring organization-wide intranet hosting and unattended CI/CD automation.
build-book.cmd, build-book.sh), and Python log scraper (log-scraper.py). Official Trademark & Regulatory Shielding Notice:
Adobe®, FrameMaker®, PostScript®, Distiller®, and Acrobat® are either registered trademarks or trademarks of Adobe in the United States and/or other countries. OASIS® and DITA® are trademarks of OASIS Open. This independent technical engineering reference is published by Precision Technical Press and is not affiliated with, sponsored by, or endorsed by Adobe Systems Incorporated or OASIS Open. Adobe does not administer a commercial certification exam for Adobe FrameMaker.