​

Types & Data Models

​

SECTION 9 — DOCUMENT TYPES & DATA MODELS

​

9.1 Document Type Overview

​

9.2 Compilation Trigger Schedule

​

9.3 Magazine Trigger Schedule

​

9.3A Quarterly Collection Trigger Schedule

Note: For a January–December academic year, Q4 trigger fires on January 7 of the next calendar year.

​

9.3B Bi-Annual Compendium Trigger Schedule

Note: For a January–December academic year, Compendium-2 trigger fires on January 7 of the next calendar year.

​

9.3C Annual Yearbook Trigger Schedule

Intentional co-scheduling: For a January–December academic year, Q4 Collection (6:00 PM), Compendium-2 (6:10 PM), and Annual Yearbook (6:20 PM) all trigger on January 7 of the next year, processing independently as separate parallel documents queued one after another with 10-minute intervals between each.

​

9.3D Category Extraction

• Creator: Editor (manual)
• UI mechanism: Checkbox interface allowing selection of specific news categories (e.g. “SCIENCE & TECHNOLOGY”) across the aggregation range
• Document naming: extraction-\{CATEGORY-NAME\}-\{AGGREGATION-DOC-NAME\}
• Storage: Uses the same folder structure as the aggregation type from which it was extracted
• Kanban visibility: Appears in Kanban board as its own entity
• Billing flag: Configurable boolean flag count_in_billing (default: false). Generally set to false because these documents are primarily used for proofreading and cross-checking purposes of an individual category within the overall final aggregated document.
• Drive storage: Saved as its own entity in the path used by the source aggregation type
• Use case example: An exclusive “SCIENCE & TECHNOLOGY” category extracted over a monthly aggregation range could be used for cross-checking purposes to verify the integrity of the actual final Magazine document
• Multi-lingual support: Category Extractions support parallel multilingual generation as configured by Teacher or Editor

​

9.4 Newsletter Raw Data Structure (Markdown Hierarchy)

# DD-MM-YY                    ← H1: Document Date
# CURRENT AFFAIRS             ← H1: Section Header
| Q  | A  |                   ← Table: 2 columns, minimum 6 rows (Q&A pairs)
|----|----|
| Q1 | A1 |

# OUTLINE                     ← H1: Section Header
- Headline 1                  ← Bullet list of all news headlines in this Newsletter
- Headline 2
───────────────────           ← Visual separator

# NEWS CATEGORY               ← H1: Category name (e.g. SCIENCE & TECHNOLOGY)
## News Headline              ← H2: Individual news item headline
### DD-MM-YY                  ← H3: Date of the news item
Content paragraphs...         ← Body text, bullet points, tables (optional)

​

9.5 Compilation & Magazine Raw Data Structure

# WK{n}/M{n}-Compilation-DD(start)-DD(end)-MMM-YY-RAW
│
├── # INDEX
│   ├── CATEGORY-1 (from all Newsletters in the period)
│   ├── CATEGORY-2
│   └── CATEGORY-N
│
├── # HIGHLIGHTS OF THIS WEEK/MONTH
│   └── (2 randomly selected news headlines from each Newsletter in range)
│
├── # WEEKLY/MONTHLY CURRENT AFFAIRS
│   ├── ## DATE-1
│   │   └── Q&A Table (from that date's Newsletter)
│   ├── ## DATE-2
│   │   └── Q&A Table
│   └── ## DATE-N
│       └── Q&A Table
│
├── # OUTLINE
│   ├── ## DATE-1
│   │   └── Bullet list of all headlines from that date
│   ├── ## DATE-2
│   │   └── Bullet list of headlines
│   └── ## DATE-N
│       └── Bullet list of headlines
│
└── # WEEKLY/MONTHLY COMPILATION
    ├── # CATEGORY-1
    │   ├── ## DATE-1
    │   │   ├── ### NEWS-HEADLINE
    │   │   │   ├── Bullet points / paragraphs (news content)
    │   │   │   └── Optional related data table
    │   │   └── ### NEWS-HEADLINE
    │   │       └── ...
    │   ├── ## DATE-2
    │   │   └── ...
    │   └── ## DATE-N
    │       └── ...
    ├── # CATEGORY-2
    │   └── ...
    └── # CATEGORY-N
        └── ...

​

9.6 Document Status State Machine

draft ──► review ──► approved ──► published ──► archived
  ▲                      │
  │                      ▼
  └──── (revision) ◄── delivered