VSA-tooling — documentatie¶
Welkom bij de documentatie van de VSA-toolchain: parser, validatie, SVG- en MusicXML-export, Markdown-build en hergebruik in andere repositories.
Deze site is voor wie de tool gebruikt of documenteert — niet voor het koor dat een dienst oefent. Daarvoor: de parochie-site (VSA-demo als voorbeeld).
Wie ben je? (kies je route)¶
| Ik wil … | Voor wie | Start hier |
|---|---|---|
| VSA schrijven / valideren / SVG maken | Notatie-auteur | Starten · Validatie |
Hugo/CI aan vsa-tool hangen |
Consumer-site builder | Consumer-site · Integratie |
| Docs of TEv2 bijdragen | Docs-/tool-contributor | TEv2 in tool-docs |
| Formele taal-/toolregels | Spec-/PR-reviewer | Specificaties · Terminologie |
Zangstuk / access: in de bron-repo |
Bron-contentbeheerder | bron — handleidingen |
| Partituur oefenen / liturgie volgen | Koor / liturgie | Niet hier — parochie-site / VSA-demo |
Rollen en toon: bron — schrijfconventies.
Wat vind je hier¶
| Sectie | Wat je er vindt |
|---|---|
| Starten | Lokaal ontwikkelen: omgeving, vsa --version, valideren en een SVG maken. |
| Formaten & CLI | .vsa / .mvsa / .mxl / .mscz / .mp3, checklists, CLI en .cmd-scripts. |
| Handleidingen | Taakgerichte uitleg (CLI-taken, validatie, export, consumer-site). |
| Specificaties | Normatieve VSA-taal- en toolcontracts. |
| Referentie | Naslag: voorbeelden, CLI man-pagina’s, tokens, diagnostics en outputs. |
| Integratie | vsa-tool importeren in andere repo’s en CI; TEv2 in tool-docs. |
| Terminologie | Gegenereerde glossary van tool-termen (+ geselecteerde bron-termen). |
| Plannen | Ontwikkelplannen. Die zijn niet normatief; bij twijfel gelden specificatie en handleidingen. |
Waar hoort wat?¶
| Vraag | Ga naar |
|---|---|
| Hoe gebruik ik de VSA-CLI of bouw ik een consumer-site? | Starten of Handleidingen |
Welk formaat / welk mvsa/mxl/mscz-commando? |
Formaten & CLI |
| Wat moet de taal/tool formeel doen? | Specificaties |
| Org-specs, zangstuk-formaat, glossary | bron — documentatie |
Wat is dit niet¶
| Repo / site | Rol |
|---|---|
| bron | Org-specs en zangstukken (single source of truth) |
| VSA-demo | Hugo-presentatiesite / voorbeeldconsumer |
| Deze site | Documentatie van de tool, geen liturgische browsable catalogus |
URL-cutover: docs staan op
/(main) en/preview/(andere branches). Oude paden/docs/en/docs-preview/zijn vervangen.
Lokaal bekijken¶
cd /d C:\Git\orthodox-ronl\VSA-tooling
python -m pip install -r requirements-docs.txt
serve
Met TermRefs (na npm install): serve-tev2 — zie
TEv2 in tool-docs.
Snel naar de tool¶
cd /d C:\Git\orthodox-ronl\VSA-tooling
test
vsa --version
vsa validate examples\minimal\001_plain_text.vsa