Spelregels van de markup

Een editie is één tekstbestand (bron.txt) met bovenaan een kop met gegevens over de editie, en daaronder de tekst zelf in een lichte opmaak. Hieronder staan alle regels. Deze afspraken staan open ter bespreking en kunnen worden uitgebreid.

1. De kop (metagegevens)

De kop staat tussen twee regels met ---. Elke regel is sleutel: waarde. De apparaten worden elk op een eigen apparaat:-regel gedefinieerd, in de volgorde waarin ze onderaan moeten verschijnen.

---
titel: Journael van een reis door Italië
auteur: ...
jaar: 1685
bron: Handschrift, signatuur ...
type: handschrift            # of: druk
transcriptie: kritisch
regelnummering: 5            # nummer verspringt om de 5 regels (0 of weglaten = geen nummering)
origineel_type: afbeelding   # of: pdf
origineel_afbeeldingen: origineel/pagina-{n}.jpg
# of, bij een pdf:
# origineel_pdf: origineel/handschrift.pdf
apparaat: w      | Woordverklaringen          | editeur
apparaat: comm   | Toelichting en commentaar  | editeur
apparaat: krit   | Tekstkritisch apparaat     | editeur
apparaat: auteur | Noten van de auteur        | origineel
---

Elke apparaat:-regel heeft velden, gescheiden door |: de code (kort, gebruik je in de noten), het label (wat de lezer ziet), de soort (editeur of origineel) en optioneel de zijde (links of rechts) waar de noot als kantlijnnoot verschijnt. Zonder zijde staan editeursnoten links en oorspronkelijke noten rechts. Voor een goede balans kun je bijvoorbeeld woordverklaringen en het tekstkritische apparaat links plaatsen, en de toelichting en de auteursnoten rechts. Een editie hoeft niet alle apparaten te bevatten — laat weg wat niet van toepassing is.

Op een breed scherm verschijnen de noten in de kantlijn, naast de regel waar ze bij horen (en scrollen mee); op een smal scherm vallen ze terug op hover/klik en het verzamelde apparaat onder elke pagina.

2. De tekst

De regelnummering volgt dus de regelindeling van de bron: knip de tekst af op dezelfde plaatsen als in het origineel. Om de vijf regels verschijnt het nummer in de marge.

Lijsten en tabellen

Opsommingen en tabellen schrijft u in de gewone Markdown-notatie; ze worden als structuurblokken weergegeven (zonder eigen regelnummer, net als koppen en afbeeldingen).

Voorbeeld van een tabel:

| Gewest     | Munt         | Koers       |
| ---        | ---          | ---:        |
| Holland    | gulden       | 20 stuivers |
| Denemarken | rijksdaalder | 6 mark      |

Noten mogen ook in een lijstitem of een tabelcel vallen: u verankert ze op de gewone manier via het === NOTEN ===-blok (zie §3). Zowel het register als de zoekfunctie doorzoeken de tekst in lijsten en tabellen mee.

3. Noten

Een noot koppelt u aan een lemma (het woord of de woordgroep waar de noot bij hoort):

[[lemma|code|inhoud van de noot]]

• lemma — verschijnt in de tekst en wordt subtiel onderstreept in de kleur van het apparaat. Er staan géén nootcijfers in de lopende tekst.
• code — de apparaatcode uit de kop (w, comm, krit, auteur, …).
• inhoud — de noottekst (mag zelf cursief, kleinkapitaal en zelfs een geneste noot bevatten).

Voorbeeld: uit [[Bologne|w|Bologna, stad in Emilia-Romagna]] vertrokken. Bij hover of klik op het lemma verschijnt de noot; onderaan zijn alle noten per apparaat verzameld en gekoppeld aan het regelnummer. Elk apparaat is met de werkbalk afzonderlijk aan/uit te zetten.

De volledige woordgroep blijft in de tekst onderstreept (de reikwijdte), maar in het apparaat en de kantnoot wordt een lang lemma ingekort tot eerste woord … laatste woord (bijvoorbeeld onze … afgekaatst). Dat scheelt ruimte in de marge; korte lemma's blijven volledig.

Oorspronkelijke noten van de auteur (voet- én eindnoten uit de bron zelf) geeft u een apparaat van soort origineel, zodat ze gescheiden blijven van de editeursnoten.

Geneste noten — een editeursnoot óp een auteursnoot

Omdat de inhoud van een noot zelf weer een lemma mag bevatten, kunt u binnen een auteursnoot commentaar geven. Voorbeeld:

[[ongemak|auteur|De weerd was een [[schelm|comm|Sterke term; ...]], die ons bedroog.]]

In de auteursnoot is dan het woord schelm onderstreept en toont het bij hover uw editeurscommentaar.

4. Typografie

Let op: gebruik {ul:…} spaarzaam — geannoteerde woorden krijgen zelf al een (gestippelde) onderstreping, dus te veel onderstreepte tekst kan verwarren.

5. Editeursingrepen (kritische editie)

Bij {ab:…} markeert u alleen de door de editeur aangevulde letters. In de transcriptie is de conventie ronde haken; in de editie verschijnt de aanvulling cursief zonder haken (HoogMogenden). Met de werkbalkoptie “Opgeloste afkortingen markeren” uit vervalt de cursivering en leest het als gewone tekst: Hoogmogenden.

6. Bron- en handschriftkenmerken

Interlineaire en marginale toevoegingen worden op de plaats van inlassing in de tekststroom weergegeven, zodat de tekst doorloopbaar blijft, maar met een eigen stijl die laat zien waar ze vandaan komen: interlineair verschijnt verhoogd (het stond boven de regel), marginaal als een klein ingesprongen inzetje (het stond in de marge).

7. Pagina- en foliomarkeringen → het origineel

Zet op een eigen regel een ~, gevolgd door het label en het doel:

~ 12r | 1

Dit plaatst een klikbare markering ∣12r in de tekst. Het tweede veld is het doel: bij origineel_type: pdf is dat het paginanummer in de pdf (opent op die pagina); bij origineel_type: afbeelding vervangt het de {n} in het bestandspad (opent de scan in een lightbox).

Afbeeldingen in de editie

Een figuur (kaart, portret, tekening) zet u met de gewone Markdown-afbeeldingssyntax op een eigen regel:

![Bijschrift, met desgewenst een bron. — Bron: …](afbeeldingen/kaart.jpg)

De figuur wordt automatisch genummerd (“Afbeelding 1”, “Afbeelding 2” …), gecentreerd weergegeven met het bijschrift eronder, en is klikbaar om te vergroten (lightbox). Figuren blijven binnen de hoofdtekstkolom, zodat de witruimte tot de kantnoten intact blijft. Voeg {breed} toe voor de volledige kolombreedte (een gewone figuur is wat smaller):

![Bijschrift.](afbeeldingen/kaart.jpg){breed}

Dit is iets anders dan de facsimile (de scans van het origineel), die via de paginamarkeringen wordt geopend. Afbeeldingen horen in een map afbeeldingen/ bij de editie; in de Inleiding of Verantwoording kunt u ze ook rechtstreeks als HTML plaatsen.

De ~-markeringen bepalen tevens de paginagrenzen: heeft een editie meer dan één markering, dan kan de lezer in de werkbalk kiezen tussen doorlopend lezen (alles onder elkaar) en per pagina doorbladeren (met vorige/volgende en een paginakeuze). Bij het doorbladeren tonen de apparaten alleen de noten van de zichtbare pagina. Elke pagina is aan te linken met #pagina-2 in de URL.

8. Register van namen en plaatsen

Naast de noten kunt u een register aanleggen. Dat verschijnt op een apart tabblad en niet in het notenapparaat. Het register is bij uitstek geschikt om de afwijkende en inconsequente spelling van eigennamen onder één noemer te brengen. Voeg onderaan het bronbestand een blok toe, ingeleid door een regel === REGISTER ===, met per regel:

soort | canonieke naam | variant, variant, …

• soort — persoon of plaats; bepaalt onder welke groep (Personen of Plaatsen) de ingang komt te staan.
• canonieke naam — de gestandaardiseerde vorm die als kopje verschijnt (bijvoorbeeld Göteborg).
• varianten — alle schrijfwijzen zoals ze in het handschrift voorkomen, door komma's gescheiden (Gottenburg, Gotenburg, Gottenborg). De canonieke naam hoeft niet te worden herhaald.

Voorbeeld:

=== REGISTER ===
persoon | Tycho Brahe | Tycho Brahe, Tycho Brake
plaats  | Kopenhagen  | Coppenhagen, Kopenhagen

De site zoekt elke variant in de lopende tekst op, groepeert de vindplaatsen alfabetisch onder de canonieke naam en toont bij elke ingang de pagina's waarop de naam voorkomt. Een klik op een vindplaats opent de tekst en licht het woord even op. De hoofdtekst blijft schoon: er komen geen markeringen in te staan.

9. Dagtekeningen (navigatie per dag)

Naast doorlopend lezen en per pagina bladeren kan de lezer ook per dag navigeren. Daarvoor markeert u in de tekst waar een nieuwe dag begint met een regel die begint met @:

@ sleutel [sv|sn] | label

• sleutel — een machinaal leesbare datum JJJJ-MM-DD. Ontbreekt de dag of de maand, laat die dan weg (1674-02 of 1674). Voor een periode geeft u begin- en einddatum met een schuine streep: 1674-01-05/1674-01-08 (er wordt op de begindatum gesorteerd).
• sv / sn — optioneel de kalenderstijl: sv voor de oude stijl (stilo vetus, Juliaanse kalender), sn voor de nieuwe stijl (Gregoriaans, de standaard). Een sv-datum krijgt in de weergave een tagje o.s. en wordt voor de juiste chronologische volgorde intern naar de nieuwe stijl omgerekend.
• label — de tekst zoals die in de dagbalk en in de marge verschijnt (bijvoorbeeld 23 februari 1674).

Voorbeeld:

@ 1674-02-12 sv | 12 februari 1674

De dagtekeningen verschijnen als ingetogen datumregels in de tekst (met de werkbalk uit te zetten) en vullen de knop Dagen, waarmee de lezer chronologisch naar elke dag kan springen. Zo werkt doorklikken niet alleen doorlopend of per pagina, maar ook per dag.

10. Werkbalk (voor de lezer)

Boven de tekst kan de lezer aan/uit zetten: elk apparaat afzonderlijk, de regelnummers, de paginamarkeringen, de onderstreping van geannoteerde woorden, en of opgeloste afkortingen cursief worden getoond — plus, bij meerdere pagina's, de keuze tussen doorlopend en per pagina.

Zijn er kopjes in de tekst, dan verschijnt een knop Inhoud met een inhoudsopgave; zijn er dagtekeningen, dan een knop Dagen (zie §9). Een klik springt telkens naar de bijbehorende plaats (en, in de modus per pagina, naar de juiste pagina). Links vindt de lezer de zoekbalk, rechts de knop Weergave.

11. Invoeren: editor of importscript

Een editie schrijft u in het editie.md-formaat (schone tekst plus een === NOTEN ===- en eventueel === REGISTER ===-blok). Er zijn twee manieren om daar het runtime-bestand bron.txt van te maken:

• De editor in de browser — schrijf of open een editie.md, zie meteen het resultaat met verankerde noten, en download het bron.txt. U kunt bovendien tekst in het voorbeeld selecteren om er direct een noot bij te maken: de editor kiest het lemma (lange selecties als «eerste … laatste»), bepaalt zo nodig het juiste voorkomen, en schrijft de regel in het notenblok. Geen installatie nodig.
• Het importscript importeer.py — voor wie in Obsidian of een teksteditor werkt en meerdere bestanden ineens wil verwerken:

  python3 importeer.py edities/mijn-editie/editie.md

  Beide gebruiken exact dezelfde logica en geven hetzelfde bron.txt.

De editor en importer verankeren elk lemma uit het notenblok in de tekst en melden welke niet gevonden zijn, zodat u spelvarianten kunt bijwerken.

12. Lokaal bekijken

Omdat de tekst met fetch() wordt geladen, moet u de site via een (lokale) webserver openen, niet rechtstreeks als bestand. Bijvoorbeeld:

python3 -m http.server
# open daarna http://localhost:8000/