Book Metrics¶
Generated by: Book Metrics Python Program v0.08
Generated on: June 10, 2026 at 08:45 AM
This file contains overall metrics for the intelligent textbook.
Note: Student-facing content metrics exclude prompts/ and learning-graph/ directories. Chapter-only metrics show what students see in the main chapters.
Book Composition¶
The twelve tracked elements of an intelligent textbook. The Status column shows whether each element is Required, Recommended, or Optional; a ⚠️ marks a required element that is still missing.
| # | Element | Value | Status | Notes |
|---|---|---|---|---|
| 1 | Concepts | 221 | Required | Concepts from learning graph |
| 2 | Chapters | 13 | Required | Chapter directories with index.md |
| 3 | MicroSims | 1 | Recommended | Interactive simulations in docs/sims/ |
| 4 | Stories | 0 | Optional | Graphic-novel narratives in docs/stories/ |
| 5 | Chapter Quizzes | 13 / 13 | Recommended | Chapters with a quiz.md (13 questions total) |
| 6 | Chapter References | 13 / 13 | Recommended | Chapters with references.md (0 references total) |
| 7 | Glossary Terms | 214 | Recommended | Defined terms in glossary.md |
| 8 | FAQs | 63 | Recommended | Questions in faq.md |
| 9 | Words | 143,211 | Required | Words across student-facing markdown |
| 10 | Mascot | 7 | Optional | Mascot image poses in docs/img/mascot/ |
| 11 | Appendices | 0 | Optional | Appendix pages |
| 12 | Development Stage | Not specified | Required ⚠️ | From mkdocs.yml or course-description.md |
Student-Facing Content Metrics¶
Excludes administrative directories (prompts/, learning-graph/).
| Metric Name | All Content | Chapters Only | Notes |
|---|---|---|---|
| Diagrams | 30 | 30 | H4 headers starting with '#### Diagram:' |
| Equations | 0 | 0 | LaTeX expressions (inline and display) |
| Total Words | 143,211 | 85,786 | Words in markdown files |
| Links | 280 | 88 | Hyperlinks in markdown format |
| Equivalent Pages | 580 | 351 | Estimated pages (250 words/page + visuals) |
Metrics Explanation¶
Book Composition Elements¶
- Concepts (required): Number of rows in learning-graph.csv
- Chapters (required): Count of chapter directories containing index.md files
- MicroSims (recommended): Directories in docs/sims/ with index.md files
- Stories (optional): Story directories in docs/stories/ with index.md files
- Chapter Quizzes (recommended): Chapters containing a quiz.md file (with total quiz questions in the notes)
- Chapter References (recommended): Chapters containing a references.md file (with total reference entries in the notes)
- Glossary Terms (recommended): H4 headers in glossary.md
- FAQs (recommended): H3 headers in faq.md
- Words (required): All words in student-facing markdown files (excluding code blocks and URLs)
- Mascot (optional): Image files (poses) in docs/img/mascot/
- Appendices (optional): Pages in the appendices/ directory (excluding index.md)
- Development Stage (required):
development_stagevalue in mkdocs.yml (or course-description.md); shows 'Not specified' if absent
Content Metrics¶
- Diagrams: H4 headers starting with '#### Diagram:'
- Equations: LaTeX expressions using $ and $$ delimiters
- Total Words: All words in markdown files (excluding code blocks and URLs)
- Links: Markdown-formatted links
[text](url) - Equivalent Pages: Based on 250 words/page + 0.25 page/diagram + 0.5 page/MicroSim
Column Explanations¶
- All Content: Includes all student-facing content (chapters, glossary, FAQ, sims, etc.) but excludes administrative directories
- Chapters Only: Aggregated from chapter directories only - represents the core textbook content students read
Excluded Directories: prompts/, learning-graph/ (administrative content not visible to students)