diff --git a/Respec-bij-VNG-R.pdf b/Respec-bij-VNG-R.pdf index 82fa34b..659e46e 100644 Binary files a/Respec-bij-VNG-R.pdf and b/Respec-bij-VNG-R.pdf differ diff --git a/snapshot.html b/snapshot.html index c71f0b7..caee597 100644 --- a/snapshot.html +++ b/snapshot.html @@ -575,7 +575,7 @@ latestVersion Combinatie van strings en configuration propertynamen. - Globaal + Globaal en lokaal Samenvoeging van achtereenvolgens nl_organisationPublishURL, pubDomain, "/", en shortName. Wordt opgebouwd m.b.v. andere gedefinieerde configuration properties en '/' tekens. Daarin voorkomende hoofdletters worden omgezet naar kleine letters.

Indien deze configuration property of een van de properties waaruit het bestaat niet worden verstrekt dan wordt de gerelateerde rubriek in het Respec document @@ -644,17 +644,17 @@ Integer Globaal en lokaal - Bepaald het aantal niveau's dat maximaal wordt opgenomen in de inhoudsopgave van het Respec document.

Deze property kan lokaal overruled worden. - Default worden alle niveau's opgenomen. + Bepaald het aantal niveau's dat maximaal wordt opgenomen in de inhoudsopgave van het Respec document. + Default worden alle niveau's opgenomen.

Deze property kan lokaal overruled worden. nl_organisationName String Globaal en lokaal VNG Realisatie - Wordt gebruikt om de subtitel en het vertikale label linksboven te genereren.

Deze property kan lokaal overruled worden. - - + Wordt gebruikt om de subtitel en het vertikale label linksboven te genereren. + Deze property kan lokaal overruled worden. + nl_organisationPublishURL URL @@ -671,9 +671,9 @@ URL Globaal en lokaal https://gitdocumentatie.logius.nl/publicatie/respec/style/ - Definieert de locatie waar het te gebruiken css bestand staat excl. dat bestand zelf.

Deze property kan lokaal overruled worden. - - + Definieert de locatie waar het te gebruiken css bestand staat excl. dat bestand zelf. + Deze property kan lokaal overruled worden. + noTOC boolean @@ -695,8 +695,9 @@ Functie aanroep. Globaal ? - Bevat een of meer JavaScript functies die achtereenvolgend opgestart worden nadat Respec klaar is met generatie van het Respec document.

Deze property kan niet lokaal gedefinieerd worden en dus ook niet overruled worden. - Bevat nu een functie die indien van toepassing mermaid notatie wijze omzet naar graphs. + Bevat een of meer JavaScript functies die achtereenvolgend opgestart worden nadat Respec klaar is met generatie van het Respec document. + Bevat nu een functie die indien van toepassing mermaid notatie wijze omzet naar graphs.

+ Deze property kan niet lokaal gedefinieerd worden en dus ook niet overruled worden. previousMaturity @@ -726,7 +727,7 @@ prevVersion Combinatie van strings en configuration propertynamen. - Globaal + Globaal en lokaal Samenvoeging van achtereenvolgens nl_organisationPublishURL, pubDomain, "/", shortName, "/" en previousPublishVersion. Wordt opgebouwd m.b.v. andere gedefinieerde configuration properties en '/' tekens. Daarin voorkomende hoofdletters worden omgezet naar kleine letters.

Indien deze configuration property of een van de properties waaruit het bestaat niet worden verstrekt dan wordt de gerelateerde rubriek in het Respec document @@ -750,7 +751,8 @@
  • sd (Sociaal domein)
  • bv (Bedrijfsvoering)
  • - Dat betekent wel dat de folderstructuur van de 'publicatie' GitHub repository ook moet worden aangepast.

    Property kan ook een waarde hebben als zd/cim.

    De globale waarde van deze property kan lokaal overruled worden. + Dat betekent wel dat de folderstructuur van de 'publicatie' GitHub repository ook moet worden aangepast.

    Property kan ook een waarde hebben als zd/cim.

    Deze property kan lokaal + overruled worden maar ben daar terughoudend mee. Bij lokaal definiëren van deze property is de werking van de links in het document nl. niet te garanderen aangezien die zou kunnen afwijken van de afgesproken structuur in de publishing repository.. @@ -785,8 +787,8 @@ Array van properties per taalcode. Globaal en lokaal - Bevat voor een aantal 'specStatus'sen en talen de te gebruiken codes en de daarbij horende volledige tekst.

    Kan lokaal overruled worden. - Bij VNG-R zullen we moeten bepalen welke teksten er bij welke status gegenereerd moeten worden. + Bevat voor een aantal 'specStatus'sen en talen de te gebruiken codes en de daarbij horende volledige tekst. + Bij VNG-R zullen we moeten bepalen welke teksten er bij welke status gegenereerd moeten worden.

    Kan lokaal overruled worden. specStatus @@ -839,7 +841,7 @@ thisVersion Combinatie van strings en configuration propertynamen. - Globaal + Globaal en lokaal Samenvoeging van achtereenvolgens nl_organisationPublishURL, pubDomain, "/", shortName, "/" en publishVersion. Wordt opgebouwd m.b.v. andere gedefinieerde configuration properties en '/' tekens. Daarin voorkomende hoofdletters worden omgezet naar kleine letters.

    Indien deze configuration property of een van de properties waaruit het bestaat niet worden verstrekt dan wordt de gerelateerde rubriek in het Respec document @@ -858,19 +860,19 @@ useLabel boolean - Globaal + Globaal en lokaal true Bepaald of het verticale label aan de linker bovenzijde van de inhoudsopgave gegenereerd moet worden.

    - Kan lokaal overruled worden. + Deze property kan lokaal overruled worden. useLogo boolean - Globaal + Globaal en lokaal true Bepaald of het VNG-Realisatie logo in de rechter bovenzijde van het document geplaatst moet worden.

    - Kan lokaal overruled worden. + Deze property kan lokaal overruled worden. @@ -1022,24 +1024,9 @@

    Onderstaande flowchart beschrijft het proces zoals we dat binnen VNG Realisatie hanteren om tot Respec documentatie te komen. Daarnaast is het echter ook een voorbeeld van het gebruik van de Mermaid syntax voor het vervaardigen van zo'n flowchart.

    -
    %%{init: {"flowchart": {"defaultRenderer": "elk"}} }%%
    -graph TD
    -    A([Start])---->B{"<b>1</b><br/>Eerste versie<br/>van Respec<br/>documentatie?"}
    -    B{"<b>1</b><br/>Eerste versie<br/>van Respec<br/>documentatie?"}--Nee-->C("...")
    -    C("...")---->D("<b>3</b><br/>Creëer nieuwe content of pas content aan")
    -    C("...")---->E("<b>5</b><br/>Pas basisstructuur aan voor versie")
    -    D("<b>3</b><br/>Creëer nieuwe content of pas content aan")---->I("<b>4</b><br/>Assembleer document")
    -    I("<b>4</b><br/>Assembleer document")---->J("<b>5</b><br/>Pas document configuratie properties aan")
    -    B{"<b>1</b><br/>Eerste versie<br/>van Respec<br/>documentatie?"}--Ja-->F("...")
    -    F("...")---->G("<b>2</b><br/>Creëer en configureer project repo")
    -    F("...")---->H("<b>6</b><br/>Creëer basisstructuur in publicatie repo")
    -    G("<b>2</b><br/>Creëer en configureer project repo")---->D("<b>3</b><br/>Creëer nieuwe content of pas content aan")
    -    H("<b>6</b><br/>Creëer basisstructuur in publicatie repo")---->E("<b>7</b><br/>Pas basisstructuur aan voor versie")
    -    E("<b>7</b><br/>Pas basisstructuur aan voor versie")---->K("<b>8</b><br/>Plaats gegenereerde documenten in publicatie repo")
    -    K("<b>8</b><br/>Plaats gegenereerde documenten in publicatie repo")---->L("<b>9</b><br/>Gebruik publicatie link Respec doc in GH Pages")
    -    J("<b>5</b><br/>Pas document configuratie properties aan")---->K("<b>8</b><br/>Plaats gegenereerde documenten in publicatie repo")
    -    L("<b>9</b><br/>Gebruik publicatie link Respec doc in GH Pages")---->M([Stop])
    -
    +
    Nee
    Ja
    Start
    1
    Eerste versie
    van Respec
    documentatie?
    ...
    3
    Creëer nieuwe content of pas content aan
    7
    Pas basisstructuur aan voor versie
    4
    Assembleer document
    5
    Pas document configuratie properties aan
    ...
    2
    Creëer en configureer project repo
    6
    Creëer basisstructuur in publicatie repo
    8
    Plaats gegenereerde documenten in publicatie repo
    9
    Gebruik publicatie link Respec doc in GH Pages
    Stop
    Figuur 3 Het VNG-R Respec proces (Mermaid voorbeeld)


    @@ -1052,82 +1039,49 @@

    Hieronder nog een aantal Mermaid voorbeelden.

    -
    %%{init: { "sequence": { "useMaxWidth": true } } }%%
    -sequenceDiagram
    -    participant dotcom
    -    participant iframe
    -    participant viewscreen
    -    dotcom->>iframe: loads html w/ iframe url
    -    iframe->>viewscreen: request template
    -    viewscreen->>iframe: html & javascript
    -    iframe->>dotcom: iframe ready
    -    dotcom->>iframe: set mermaid data on iframe
    -    iframe->>iframe: render mermaid
    -
    +
    dotcomiframeviewscreenloads html w/ iframe urlrequest templatehtml & javascriptiframe readyset mermaid data on iframerender mermaiddotcomiframeviewscreen
    Figuur 4 Sequence diagram
    -
    stateDiagram-v2
    -    [*] --> Still
    -    Still --> [*]
    -
    -    Still --> Moving
    -    Moving --> Still
    -    Moving --> Crash
    -    Crash --> [*]
    -
    +
    Still
    Moving
    Crash
    Figuur 5 state diagram
    -
    erDiagram
    -    CUSTOMER ||--o{ ORDER : places
    -    ORDER ||--|{ LINE-ITEM : contains
    -    CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
    -
    +
    CUSTOMERORDERLINE-ITEMDELIVERY-ADDRESSplacescontainsuses
    Figuur 6 ER diagram
    -
    journey
    -    title My working day
    -    section Go to work
    -      Make tea: 5: Me
    -      Go upstairs: 3: Me
    -      Do work: 1: Me, Cat
    -    section Go home
    -      Go downstairs: 5: Me
    -      Sit down: 5: Me
    -
    +
    CatMe
    Go to work
    Go to work
    Me
    Make tea
    Make tea
    Me
    Go upstairs
    Go upstairs
    MeCat
    Do work
    Do work
    Go home
    Go home
    Me
    Go downstairs
    Go downstairs
    Me
    Sit down
    Sit down
    My working day
    Figuur 7 Journey diagram
    -
    gantt
    -    title A Gantt Diagram
    -    dateFormat YYYY-MM-DD
    -    section Section
    -        A task          :a1, 2014-01-01, 30d
    -        Another task    :after a1, 20d
    -    section Another
    -        Task in Another :2014-01-12, 12d
    -        another task    :24d
    -
    +
    2014-01-052014-01-122014-01-192014-01-262014-02-022014-02-092014-02-16A task          Task in Another another task    Another task    SectionAnotherA Gantt Diagram
    Figuur 8 Gantt chart
    -
    pie title Pets adopted by volunteers
    -    "Dogs" : 386
    -    "Cats" : 85
    -    "Rats" : 15
    -
    +
    Pets adopted by volunteers79%17%3%Pets adopted by volunteersDogsCatsRats
    Figuur 9 Pie charts

    7. Niet-normatieve deel

    Dit onderdeel is niet normatief.

    Bijvoorbeeld een introductie.