Geonovum / MIM-Werkomgeving

Werkomgeving van MIM. Bevat werk en alle pre-publicatieversies.
https://geonovum.github.io/MIM-Werkomgeving/
7 stars 15 forks source link

Documentatie: bijschriften ontbreken bij (lijst met) figuren #318

Closed Gtrouborst closed 1 year ago

Gtrouborst commented 1 year ago

Issue

De werkversie van de documentatie voor MIM1.2 maakt gebruik van de meest actuele versie van ReSpec. Hierin worden figuren op een andere manier beschreven dat in de MIM-documentatie tot dusver gebruikelijk was. De figuren worden in de nieuwe versie wel weergegeven, maar bijschriften ontbreken. Hierdoor heeft de geautomatiseerde lijst met figuren (Table of Figures; ToF) geen functie.

Voorstel

Maak optimaal gebruik van de mogelijkheden die ReSpec biedt door alle figuren te voorzien van een bijschrift.

Format oud in markdown format

![](media/informatiemodel.png)

Format nieuw in html format

<figure id="informatiemodel">
  <img src="media/informatiemodel.png" alt="" />
  <figcaption>Wat is een informatiemodel?</figcaption>
</figure>

Invulinstructie

html tag/attribute instructie
id Korte unieke naam ter identificatie van de figuur
src Relatieve locatie van de figuur in de repo (Voor het omzetten de oorspronkelijke url).
figcaption Voeg een bijschrift toe
Gtrouborst commented 1 year ago

@dkrijtenburg-GNM Er staat een branch klaar met de naam: 318-documentatie-bijschriften-figuren. Ik heb alle figuren omgezet in het nieuwe format (zie het voorbeeld in de issue-omschrijving).

Wil jij in onderstaande bestanden de figuren voorzien van een bijschrift en dan naar die branch pushen? Als je met de GitHub desktop client werkt: Push Origin, maar nog niet Create Pull Request.

bestandsnaam aantal figuren
AfsprakenRegels.md 1
Diagrammen.md 10
Inleiding.md 1
MetamodelAlgemeen.md 10
MetamodelLD.md 10
MetamodelUML.md 9
dkrijtenburg-GNM commented 1 year ago

Gerard,

Even gecheckt, maar ik zie nog geen tekst bij de lijst met figuren staan, of ben ik te voorbarig?

Groet

Dick

Van: Gtrouborst @.> Verzonden: donderdag 6 juli 2023 11:50 Aan: Geonovum/MIM-Werkomgeving @.> CC: Dick Krijtenburg @.>; Mention @.> Onderwerp: Re: [Geonovum/MIM-Werkomgeving] Documentatie: bijschriften ontbreken bij (lijst met) figuren (Issue #318)

Closed #318https://github.com/Geonovum/MIM-Werkomgeving/issues/318 as completed via #323https://github.com/Geonovum/MIM-Werkomgeving/pull/323.

— Reply to this email directly, view it on GitHubhttps://github.com/Geonovum/MIM-Werkomgeving/issues/318#event-9741775570, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AKUA6VIDVOZY7RHP2RKMYTDXO2C4VANCNFSM6AAAAAAZ5U4PR4. You are receiving this because you were mentioned.Message ID: @.**@.>>