Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
melsk-r authored Jul 29, 2024
1 parent 376dc6b commit f295a26
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,17 @@ Voor het publiceren van alle Respec documenten in de GitHub repository 'publicat
| cim | Het publicatie domein |
|     [project-mnemonic] | De afkorting van het project. 'Open Raadsinformatie' wordt bijv. afgekort als 'ori'. |
|         [x.x.x] | Het versienummer van het Respec document. Deze folder kan zich herhalen met steeds een ander versienummer. Komt minimaal 1x voor met als naam het huidige versienummer. |
|             media | Folder waarin evt. illustratie bestanden zijn opgenomen |
|             media | Folder waarin evt. illustratie bestanden zijn opgenomen (optioneel). |
|             index.html | Gegenereerde statische html (snapshot.html) welke overeenkomt met de versie, hernoemd. |
|             cim-[project-mnemonic]-[x.x.x].pdf | Gegenereerd pdf bestand welke overeenkomt met de versie. |
|         media | Folder waarin evt. illustratie bestanden zijn opgenomen |
|         media | Folder waarin evt. illustratie bestanden zijn opgenomen (optioneel). |
|         index.html | Gegenereerde statische html (snapshot.html), welke overeenkomt met de huidige versie, hernoemd. |
|         cim-[project-mnemonic]-[x.x.x].pdf | Gegenereerd pdf bestand welke overeenkomt met de huidige versie. |

In dit overzicht vertegenwoordigd `x.x.x` het versienummer van het Respec document. De folder met die naam kan zich herhalen maar komt minimaal 1x voor, de huidige versie. De inhoud van die folder wordt dan eveneens geplaatst in de folder [project-mnemonic]. `project-mnemonic`. Hieronder zie je een voorbeeld van deze structuur:

![image](https://github.com/user-attachments/assets/fff462a1-7cb0-49d6-a389-0a6503a4ceb8)

Tijdens het samenstellen van de inhoud van een nieuwe versie of een geheel nieuw Respec document kun je de structuur in de 'publicatie' repository al aanpassen.
Betreft het de eerste versie van een Respec document creëer dan direct in de folder 'cim' een nieuwe folder die als naam de mnemonic van het project krijgt. Daarbinnen creëer je een versiefolder met als naam het versienummer waaronder je de eerste versie publiceert.
Bestaat de projectfolder al wel dan creëer je in die folder een nieuwe versiefolder met als naam het versienummer waaronder je de nieuwe versie publiceert. In beide folders creëer je voorlopig een leeg 'index.html' bestand.
Expand Down

0 comments on commit f295a26

Please sign in to comment.