Closed Gtrouborst closed 1 year ago
De standaardopmaak van een definitie met de meest actuele versie van ReSpec (o.b.v. van NL-ReSpec-GN-template) is heel summier, hierdoor zijn definities visueel onvoldoende herkenbaar. Het zou mooi zijn als een definitie in een vergelijkbaar blok als noot
, voorbeeld
of issue
wordt weergegeven.
Het is gelukt om een definitieblok te maken met nummering die op een vergelijkbare wijze als een noot
, voorbeeld
of issue
in de lopende tekst van een markdown-bestand kan worden opgenomen. Dit ziet er als volgt uit:
<aside class="definition">
<dfn>Begrip</dfn>Definitie van het begrip
</aside>
Een css-script voegt de verdere styling toe
Alle definities omzetten op basis van bovenstaande format. Er zijn circa 80
definities in H2 Metamodel Algemeen.
Issue
De werkversie van MIM1.2 maakt gebruik van de actueelste versie van ReSpec. In ReSpec worden definities opgenomen met behulp van de html tag
<dfn>
(zie: ReSpec Editor's Guide, W3C). In de huidige MIM-documentatie worden definities met een de formatting van een quote opgenomen:Dat levert veen visueel herkenbaar resultaat op ...
... maar heeft geen inhoudelijke/technische betekenis. Ze worden door ReSpec echter niet herkend als definitie. Hierdoor kun je er niet naar verwijzen en blijft de index van begrippen leeg.
Voorstel
Voorzie alle definities van de juiste formatting door gebruik te maken van de
<dfn>
tag, zoals beschreven in bovengenoemde documentatie