Skip to content

Secties, index, appendix, bibliografie

Redmer Kronemeijer edited this page Jun 15, 2022 · 2 revisions

Voor het bewerken van een specificatie, is het handig om hoofdstukken in losse (markdown of HTML) bestanden op te slaan. Die laad je vervolgens zo in:

<section data-include-format="markdown" data-include="h/1-inleiding.md"></section>
<section data-include="h/2-model.html"></section>

Als zo'n documentdeel een appendix is, of niet-normatief (dus informatief), voeg dan respectievelijk dit toe, na <section :

class="informative"
class="appendix"

Er zijn ook speciale secties, die wat speciaals betekenen voor ReSpec of die ReSpec voor je vult:

  • Samenvatting: <section id="abstract">. Deze tekst kan niet gegenereerd worden, dus laad het bijv. in met data-include-format="markdown" data-include="h/0-samenvatting.md".
  • Status van dit document: ` Tekst die je hier toevoegt, wordt toegevoegd aan de uiteindelijke status.
  • Index van termen, lokaal en elders gedefinieerd: <section id="index"></section>.
  • Definitie van conformiteit: <section id="conformance"></section>.

Bibliografie

Een bibliografie wordt automatisch toegevoegd, als je termen citeert. Via SpecRef kun je webnormen opzoeken en citeren als [[citeersleutel]]. Is de bron hierin niet te vinden? Stel dan de bibliografie samen door in config.js onder localBiblio de bronnen toe te voegen, volgens een specifiek formaat.

var respecConfig = { 
  shortName: "imbor/conceptueel-model",
  localBiblio: {
    nen2660: {
      "title": "NEN 2660-2: Regels voor informatiemodellering van de gebouwde omgeving", 
      ...
    }
  },
  ...
... gebruikmakend van een _Fysiek Object_ [[nen2660]], dat ...
Clone this wiki locally