Sinds: Nocterra 0.99.3
Terminologie: Technische Nocterra-termen blijven in deze Nederlandse handleiding onvertaald, zodat ze één-op-één terug te vinden zijn in de API, configuratie en article headers.
Nocterra ondersteunt term definitions in article files. Met definitions kan een auteur in de article body een definition term zoals {term} schrijven, waarna Nocterra deze tijdens het genereren van het article omzet in consistente semantische markup en, optioneel, een link.
Dit is bruikbaar voor:
title) en links (link) toevoegen,Koppen, alinea's en andere tekstuele inhoud mogen definition terms bevatten, bijvoorbeeld:
<CODE>{term}</CODE><H4>{term} in de praktijk gebruiken</H4><A href="...">Lees meer over {term}</A> (alleen voor definitions zonder link)Regel: Een definition term mag niet in de naam van een HTML-element of in de naam of waarde van een attribuut worden gebruikt. Definition terms zijn uitsluitend bedoeld voor tekstinhoud.
Definitions worden in de sectie [definitions] van een article file geschreven. Een definition begint met een niet-ingesprongen regel met de definition name. De daaropvolgende ingesprongen regels kennen keys toe met paren in de vorm key = value.
Minimaal voorbeeld:
[definitions]
Term
type = default
title = A short explanation shown as a tooltip
[body]
<P>In this article we will use {Term} multiple times.</P>
Definition names worden letterlijk gebruikt. {Term} en {term} zijn dus verschillende definition terms, tenzij expliciet een passend synonym is opgegeven. Case prefixes veranderen alleen de weergegeven tekst en niet deze exacte opzoeking (zie Case prefixes en synonyms).
Binnen een definition worden de volgende keys ondersteund:
| Key | Beschrijving |
|---|---|
| type | bepaalt welke semantische markup wordt gebruikt (zie Definition types). |
| link | de URL die voor alle voorkomens van de term wordt gebruikt wanneer linken is ingeschakeld. |
| link-first | optionele URL die alleen voor het eerste voorkomen wordt gebruikt. |
| title | optionele tooltip (title-attribuut) voor alle voorkomens. |
| title-first | optionele tooltip die alleen voor het eerste voorkomen wordt gebruikt. |
| rel | optioneel rel-attribuut dat wordt toegevoegd wanneer linken is ingeschakeld. |
| target | optioneel target-attribuut dat wordt toegevoegd wanneer linken is ingeschakeld. |
| synonym | één of meer alternatieve definition terms die naar dezelfde definition verwijzen. |
Sommige keys mogen, waar dat zinvol is, meerdere keren voorkomen. Zo kan synonym meerdere keren worden gebruikt om meerdere synonyms toe te voegen.
Keys zoals link, link-first, title, title-first en synonym kunnen met :lang aan een taal worden gekoppeld (zie Taalafhandeling).
Definitions kunnen tussen talen worden gedeeld of taalspecifiek worden gemaakt.
Een definition onder [definitions] zonder taalprefix wordt op alle talen toegepast, tenzij een taalspecifieke definition deze overschrijft.
Een volledige definition kan aan één of meer talen worden gekoppeld door de definition name vooraf te laten gaan door één of meer taalcodes, gescheiden door dubbele punten:
[definitions]
en:fr:Poutine
type = name
link = https://en.wikipedia.org/wiki/Poutine
synonym:fr = poutine (plat)
In het bovenstaande voorbeeld geldt de definition Poutine voor Engels en Frans.
Sommige keys kunnen per taal worden ingesteld met key:lang = value. Dit is bruikbaar wanneer dezelfde definition in meerdere talen bestaat maar taalspecifieke titles, links of synonyms nodig heeft:
Term
type = default
title:en = English tooltip
title:fr = Info-bulle française
link:en = https://www.example.com/en/term
link:fr = https://www.example.com/fr/terme
synonym:en = Term (alt)
synonym:fr = Terme (alt)
Keys die link metadata beïnvloeden (type, rel, target) zijn niet taalspecifiek.
In de article body wordt een definition term geschreven als {naam} en moet deze exact overeenkomen met een definition name of synonym, inclusief hoofdlettergebruik. Definition terms kunnen in de meeste tekstcontexten worden gebruikt, waaronder koppen en linktekst, maar in linktekst alleen voor definitions zonder eigen link.
Geldige voorbeelden:
<P>We will start with {Mycorrhiza} and then compare it to {Rhizome}.</P>
<H4>Using {Mycorrhiza} in the field</H4>
<P>Lookup more about <A href="https://example.org"> {Mycorrhiza}</A>.</P>
<P>Literal syntax: <CODE>{Mycorrhiza}</CODE>.</P>
Ongeldige voorbeelden; gebruik dit niet:
<!-- Element name -->
<{term>...</{term}>
<!-- Attribute value (would inject markup into an attribute) -->
<A href="https://example.org/{term}">Link</A>
Definition names en synonyms blijven hoofdlettergevoelig. {Term} zoekt daarom naar Term, terwijl {term} naar term zoekt.
Sinds Nocterra 0.99.6 kan een definition term direct na de openingsaccolade een expliciet case prefix bevatten. Het prefix verandert alleen de weergegeven tekst; de definition of het synonym wordt nog steeds opgezocht aan de hand van de exacte tekst na het prefix.
| Prefix | Effect |
|---|---|
_ | maak alleen het eerste teken een kleine letter (lcfirst) |
$ | maak alleen het eerste teken een hoofdletter (ucfirst) |
- | zet de volledige waarde om naar kleine letters (strtolower) |
+ | zet de volledige waarde om naar hoofdletters (strtoupper) |
Voor een definition met de naam Term zijn de vormen dus {Term}, {_Term}, {$Term}, {-Term} en {+Term}. {-Term} zoekt bijvoorbeeld nog steeds naar de definition Term, maar geeft het voorkomen weer als term.
Anders dan bij placeholders en URL scheme keys impliceert hoofdlettergebruik in de definition name zelf geen case prefix. {Term} betekent exact de definition of het synonym Term; gebruik {$term} alleen wanneer term zelf de exacte definition of het exacte synonym is en de weergegeven waarde met een hoofdletter moet beginnen. Placeholders, URL scheme keys en definition terms delen de case-prefixsyntax, maar zijn afzonderlijke mechanismen die hun namen naar verschillende soorten waarden resolven.
Gebruik synonyms voor werkelijk verschillende namen of spellingen, niet alleen voor varianten in hoofdlettergebruik:
Term
type = default
synonym = alternative term
synonym = colour
Dezelfde case prefixes kunnen ook bij een synonym worden gebruikt. Het prefix wordt toegepast op de synonym text die als definition term is geschreven, terwijl het synonym de markup van de canonical definition blijft gebruiken.
Nocterra maakt het eerste voorkomen van een definition anders op dan latere voorkomens. Daardoor kan het eerste voorkomen de term introduceren, bijvoorbeeld met <DFN>-markup, terwijl latere voorkomens een lichtere vorm gebruiken, bijvoorbeeld nadrukmarkup.
Het “eerste voorkomen” geldt alleen voor de canonieke definition name. Een synonym gebruikt de normale markup voor voorkomens en verbruikt het eerste voorkomen van de canonical definition niet. Vormen van de canonieke naam met een case prefix tellen wel als hetzelfde canonieke voorkomen, omdat het prefix alleen de weergegeven tekst verandert.
Voorbeeld:
[definitions]
Nocturnal
type = default
synonym = night-active
[body]
<P>{night-active} animals are easiest to observe at dusk.</P>
<P>Some {Nocturnal} species prefer deep forest cover.</P>
In het bovenstaande voorbeeld gebruikt {night-active} de normale opmaak voor voorkomens en verbruikt het het eerste voorkomen niet. De latere {Nocturnal} is het eerste canonieke voorkomen en krijgt daarom de opmaak voor het “eerste voorkomen”.
De key type bepaalt welke semantische markup wordt gegenereerd. Nocterra ondersteunt momenteel:
default — algemene termen, doorgaans als definition bij het eerste voorkomen en daarna als nadruk.name — namen, bijvoorbeeld productnamen of publicatietitels, doorgaans met citaatmarkup.abbreviation — afkortingen, doorgaans met afkortingsmarkup.Elk type ondersteunt optionele links en tooltips:
link of link-first aanwezig is, wordt de uitvoer in een <A>-element geplaatst.title of title-first aanwezig is, wordt een tooltip via het HTML-attribuut title gegenereerd.Voorbeeld van een set definitions:
[definitions]
Nocterra
type = name
link = https://nocterra.org/
title = Nocterra documentation platform
synonym = Nocterra platform
ISO
type = abbreviation
title = International Organization for Standardization
link = https://www.iso.org/
mycorrhiza
type = default
title = Symbiosis between fungi and plant roots
Als de letterlijke definition term syntax in een article moet worden weergegeven, bijvoorbeeld in een uitleg, schrijf dan niet rechtstreeks {term}. Encodeer in plaats daarvan de accolades zodat ze als letterlijke tekst worden behandeld:
<P>Write a placeholder like this: {term}.</P>
<P>Or in code: <CODE>{term}</CODE>.</P>
Hierdoor behandelt Nocterra de accolades niet als een definition term.
:) in definition names, omdat dubbele punten worden gebruikt voor language prefixes.<CODE>-element.Elke definition kan één of meer sleutel/waardeparen bevatten die bepalen hoe de definition term in de article body wordt weergegeven. De tabellen hieronder beschrijven iedere ondersteunde key, waaronder of deze herhaalbaar is, per taal kan worden ingesteld met key:<lang_code> en hoe keys voor het “eerste voorkomen” samenwerken met hun algemene varianten.
| Beschrijving: | Bepaalt welke semantische markup wordt gebruikt om de term weer te geven (zie Definition types). |
|---|---|
| Verplicht: | Optioneel |
| Herhaalbaar: | Eenmaal |
| Taalspecifiek: | Nee |
| Bereik: | Alle voorkomens |
| Voorwaarde: | Geen |
| Waarde: | Enumeratie — ondersteunde waarden:
Opmerkingen:
|
| Beschrijving: | Stelt de URL in die voor gelinkte voorkomens van de term wordt gebruikt. |
|---|---|
| Verplicht: | Optioneel |
| Herhaalbaar: | Eenmaal |
| Taalspecifiek: | Ja |
| Bereik: | Alle voorkomens |
| Voorwaarde: | Wordt alleen gebruikt wanneer linken is ingeschakeld doordat link en/of link-first is ingesteld. |
| Waarde: | URL — absolute of relatieve URL.
Opmerkingen:
|
| Beschrijving: | Stelt een optionele URL in die alleen voor het eerste voorkomen wordt gebruikt. |
|---|---|
| Verplicht: | Optioneel |
| Herhaalbaar: | Eenmaal |
| Taalspecifiek: | Ja |
| Bereik: | Eerste voorkomen |
| Voorwaarde: | Wordt alleen gebruikt wanneer de canonieke definition name in de article body voorkomt. |
| Waarde: | URL — absolute of relatieve URL.
Opmerkingen:
|
| Beschrijving: | Stelt een optionele tooltip (title-attribuut) in voor voorkomens van de term. |
|---|---|
| Verplicht: | Optioneel |
| Herhaalbaar: | Eenmaal |
| Taalspecifiek: | Ja |
| Bereik: | Alle voorkomens |
| Voorwaarde: | Geen |
| Waarde: | Tekst — inhoud van de tooltip.
Opmerkingen:
|
| Beschrijving: | Stelt een optionele tooltip (title-attribuut) in die alleen voor het eerste voorkomen wordt gebruikt. |
|---|---|
| Verplicht: | Optioneel |
| Herhaalbaar: | Eenmaal |
| Taalspecifiek: | Ja |
| Bereik: | Eerste voorkomen |
| Voorwaarde: | Wordt alleen gebruikt wanneer de canonieke definition name in de article body voorkomt. |
| Waarde: | Tekst — inhoud van de tooltip.
Opmerkingen:
|
| Beschrijving: | Stelt een optioneel rel-attribuut in op gegenereerde links. |
|---|---|
| Verplicht: | Optioneel |
| Herhaalbaar: | Eenmaal |
| Taalspecifiek: | Nee |
| Bereik: | Alle voorkomens |
| Voorwaarde: | Alleen wanneer linken is ingeschakeld doordat link en/of link-first is ingesteld. |
| Waarde: | Tekst — door spaties gescheiden rel-tokens, bijvoorbeeld noopener en noreferrer. |
| Beschrijving: | Stelt een optioneel target-attribuut in op gegenereerde links. |
|---|---|
| Verplicht: | Optioneel |
| Herhaalbaar: | Eenmaal |
| Taalspecifiek: | Nee |
| Bereik: | Alle voorkomens |
| Voorwaarde: | Alleen wanneer linken is ingeschakeld doordat link en/of link-first is ingesteld. |
| Waarde: | Tekst — gebruikelijke waarden zijn _blank, _self, _parent en _top. |
| Beschrijving: | Voegt één of meer alternatieve placeholders toe die naar dezelfde definition verwijzen. |
|---|---|
| Verplicht: | Optioneel |
| Herhaalbaar: | Meerdere malen |
| Taalspecifiek: | Ja |
| Bereik: | Koppeling |
| Voorwaarde: | Geen |
| Waarde: | Tekst — één synonym per voorkomen van de key.
Opmerkingen:
|
Deze sectie bevat twee grotere voorbeelden van article files. Beide bevatten een article header, een sectie [definitions] en een korte article body waarin definition terms praktisch worden gebruikt.
author = Rowan
published = 2025-05-14
category = Nature
tags = Field notes, Plants, Fungi, Woodland
keywords = mycorrhiza, oak woodland, Quercus robur, forest floor, fungi, root symbiosis, biodiversity, field observation
title = Under the Oaks: A Short Guide to Mycorrhiza in the Wild
description = A practical introduction to mycorrhiza and why fungi matter in oak woodlands, with easy observations you can try on a walk.
[definitions]
Mycorrhiza
type = default
title = Symbiosis between fungi and plant roots
link = https://en.wikipedia.org/wiki/Mycorrhiza
synonym = mycorrhiza
Quercus robur
type = name
title = English oak
link = https://en.wikipedia.org/wiki/Quercus_robur
synonym = English oak
ISO
type = abbreviation
title = International Organization for Standardization
link = https://www.iso.org/
[body]
<P>This article is a short field tutorial. We will look for signs of {Mycorrhiza} around {Quercus robur} and learn what to notice on the forest floor.</P>
<P>Literal syntax example: <CODE>{Mycorrhiza}</CODE>.</P>
<H4>Finding {Mycorrhiza} near {English oak}</H4>
<P>Start by checking the soil line and the leaf litter. If you see fine white strands near roots, you may be looking at fungal growth associated with {mycorrhiza}.</P>
<P>Want a reference link in the text? Read more about <A href="https://example.org/field-notes"> {Quercus robur}</A>.</P>
author = Camille
published = 2025-06-02
category = Cuisine
tags = Restaurants, Regional food, Comfort food
keywords:en = poutine, Québec cuisine, gravy, cheese curds, comfort food, regional specialties
keywords:fr = poutine, cuisine québécoise, sauce brune, fromage en grains, spécialités régionales
title:en = Poutine Basics: What to Order (and How to Talk About It)
title:fr = Les bases de la poutine : quoi commander (et comment en parler)
description:en = A short guide to poutine vocabulary and ordering tips, with a few terms defined inline.
description:fr = Un petit guide du vocabulaire de la poutine et des conseils pour commander, avec quelques termes définis.
[definitions]
en:fr:Poutine
type = name
title:en = A Québec dish of fries, cheese curds, and gravy
title:fr = Plat québécois de frites, fromage en grains et sauce
link:en = https://en.wikipedia.org/wiki/Poutine
link:fr = https://fr.wikipedia.org/wiki/Poutine
synonym:fr = poutine
en:Cheese curds
type = default
title = Fresh curds that squeak when you bite
link = https://en.wikipedia.org/wiki/Cheese_curd
fr:Fromage en grains
type = default
title = Fromage frais qui “couine” sous la dent
link = https://fr.wikipedia.org/wiki/Fromage_en_grains
[body:en]
<P>This article is a short ordering tutorial. We will define a few words you will see on menus, starting with {Poutine}.</P>
%toc%
<H4>Ordering {Poutine} with confidence</H4>
<P>When a menu mentions {Cheese curds}, it usually means the classic topping. If you are unsure, ask the staff what they use.</P>
[body:fr]
<P>Ce guide est un petit tutoriel pour commander. Nous allons définir quelques mots, en commençant par {poutine}.</P>
%toc%
<H4>Commander une {Poutine} en toute confiance</H4>
<P>Quand le menu mentionne {Fromage en grains}, c’est généralement la garniture classique. En cas de doute, demandez au personnel.</P>