dita-deliverables
Work with DITA-OT deliverables — the project's defined outputs (root map + DITAVAL filter + transtype + params). Use when asked to validate or build specific outputs, add/change a deliverable, understand a project's publication set, or deep-validate beyond static checks.
- License 许可
- Apache-2.0
- 最近更新
- 2026-10-20
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- dita-deliverables
- description
- Work with DITA-OT deliverables — the project's defined outputs (root map + DITAVAL filter + transtype + params). Use when asked to validate or build specific outputs, add/change a deliverable, understand a project's publication set, or deep-validate beyond static checks.
03 SKILL.md 正文
DITA deliverables and publishing
A deliverable is one publishable output, declared in a DITA-OT project file
(project.{json,xml,yaml} — the standard name; never rename it): a root map, an
optional DITAVAL filter, a transtype, an output dir, and publication params. Tools:
get_project, validate_deliverables, validate_deep, build_deliverables.
Key facts
- The project file is the source of truth, and DITA teams own it — edit it field-preservingly (don't reformat or invent a new format). One project usually ships several deliverables (e.g. full guide; a beginner guide filtered for mac and for windows; a PDF).
- DITAVAL = conditional filtering. A deliverable's
.ditavaldecides which@platform/@audience/@props-tagged content is kept. A "mac" build and a "windows" build are the same topics, filtered differently — validate and build each, don't assume one covers the others. (Govern the allowed condition values with [[dita-subject-schemes]].) - Publication params have three forms —
value(literal, passed as-is),href(resolved to a URI relative to the project file),path(resolved to an absolute filesystem path, e.g.args.cssroot). A relative path put invaluewon't resolve — choosehref/pathfor resource params.
Process
- Understand the set —
get_projectlists the deliverables (root map, ditaval, transtype, params, source file). To see what each one actually publishes, and how two outputs differ, readdeliverables[].shipsfromproject_graph; it also reports keys that resolve in some deliverables and not others ([[dita-project-graph]]). - Static validate per output —
validate_deliverablesvalidates each deliverable's publication set (unfiltered: DITAVAL is not applied) and reports each invalid file once with the deliverables it breaks; report which outputs an error affects. - Deep validate when needed —
validate_deepruns DITA-OT preprocessing to catch what static checks can't: broken keyref/conref after key resolution and filtering, map/topic resolution. Requires DITA-OT. Do this before declaring a deliverable publish-ready. - Build —
build_deliverablesproduces the outputs (applying each ditaval + params). Build one, or all.
Report
The deliverables and which outputs are affected by each finding, the deep-validation result, and what was built. To restructure the maps a deliverable points at, use [[dita-map-editing]].
04 同仓库更多 Skills
valid-skill
A valid test skill for unit testing.
wrong-name
Name does not match directory.
missing-description
暂无简介
hidden-skill
A skill hidden from model invocation.
dita-subject-schemes
Author or repair a DITA subjectScheme that governs conditional-processing attribute values (@platform, @audience, @product, @props, @otherprops), then validate content against it. Use when introducing controlled values, governing conditional content, or when validate_conditions reports controlled-value violations.
dita-shortdesc
Write SEO-friendly DITA shortdescs and abstracts — a standalone one-sentence summary that doubles as the link preview and the HTML meta description. Use when asked to add or improve a topic's description/abstract, write shortdescs, fill missing ones, or make descriptions SEO-friendly.