validate-bookmap
Skill2 starsChanged 6 months agoMITView on GitHub
Validates a DITA 1.3 bookmap file against structural rules derived from the DITA 1.3 bookmap DTD. Use this skill when you need to check bookmap element order (title, bookmeta, frontmatter, chapter, part, appendix, backmatter), booktitle completeness, appendices vs appendix mixing, and chapter presence. Returns structured JSON with errors and warnings.
In this repository18 other files it gives its agents.
- .github/copilot-instructions.mdCopilot instructions
- context-setupSkill
- dita-best-practicesSkill
- ditaval-helperSkill
- error-handlingSkill
- generate-bookmapSkill
- generate-ditamapSkill
- generate-dita-topicSkill
- generate-keyrefsSkill
- keyspace-debugSkill
- map-resolveSkill
- pdf-to-ditaSkill
- refactor-dita-contentSkill
- review-dita-guideSkill
- validate-ditamapSkill
- validate-dita-topicSkill
- visitor-extendSkill
- xslt-dita-helperSkill
The file
Files
Overview
Validates a DITA 1.3 <bookmap> file and returns a JSON report.
Usage
python scripts/validate_bookmap.py path/to/bookmap.ditamap
cat bookmap.ditamap | python scripts/validate_bookmap.py -Output schema
{
"is_valid": true,
"errors": [{ "element": "string", "rule": "string", "message": "string", "line": 0 }],
"warnings": [{ "element": "string", "rule": "string", "message": "string", "line": 0 }]
}Rules applied
See references/RULES.md for the full catalogue.
| Category | Key rules |
| Root | Must be <bookmap> |
| Order | DTD order enforced: (title|booktitle)?, bookmeta?, frontmatter?, chapter*, part*, (appendices?|appendix*), backmatter?, reltable* |
| Chapters | At least one <chapter> or <part> required |
| Booktitle | <booktitle> must contain <mainbooktitle> |
| Appendix | <appendices> and bare <appendix> must not be mixed |
Common edge cases
- A bookmap with only
<part>elements (no bare<chapter>) is valid — parts are checked <backmatter>before<chapter>→ Error (order violation)<booktitle>without<mainbooktitle>→ Error
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.