Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Respec template van Logius vereist figcaption in catalogus. #326

Closed
wilkoquak opened this issue Mar 15, 2023 · 18 comments
Closed

Respec template van Logius vereist figcaption in catalogus. #326

wilkoquak opened this issue Mar 15, 2023 · 18 comments

Comments

@wilkoquak
Copy link
Collaborator

wilkoquak commented Mar 15, 2023

Momenteel ben ik bezig met een catalogus te maken met Imvertor in de nieuwe Respec omgeving van Logius. (https://github.com/Logius-standaarden/ReSpec-template). Hiermee heb ik een dataspec gemaakt en als ik dan naar de list of figures kijk zie ik geen captions voor de figures die door Imvertor worden gemaakt (Zie: https://geonovum.github.io/dso-cim-template/#tof ). Zou bij het genereren van de catalogus een <figcaption> kunnen worden toegevoegd?

@ArjanLoeffen
Copy link
Contributor

ArjanLoeffen commented Mar 20, 2023

Wat je vraagt is feitelijk, als ik het goed begrijp, dat we een <figure> introduceren waar nu <img> is opgenomen:

https://www.w3schools.com/tags/tag_figcaption.asp

Dus waar het nu de vorm heeft:

<div class="imageinfo overview">
  <img src="" usemap="" alt="Diagram Overzicht van alle constructies in dit model voor bakstenen en hun producenten. " />
  <map name="">
     <area>...
     ....

wordt dit:

<div class="imageinfo overview">
  <figure>
    <img src="" usemap="" alt="Diagram Overzicht van alle constructies in dit model voor bakstenen en hun producenten. " />
    <figcaption>Diagram Overzicht van alle constructies in dit model voor bakstenen en hun producenten. </figcaption>
 </figure>
<map name="">
     <area>...
     ....

Ik weet niet hoe dit uitwerkt in het figures-overzicht van Respec, wanneer de complete caption daar wordt opgenomen.

Die caption wordt nu binnen EA geplaatst in de omschrijving (notes) van een diagram:

image

Graag je reactie.

@wilkoquak
Copy link
Collaborator Author

Ik zie het probleem. Helaas is de name die je aan het diagram geeft al in gebruik voor de titel van de paragraaf waarin het plaatje komt. Zou je die niet kunnen her-gebruiken? En dan zonder de '-overzicht' postfix. Het is een beetje dubbelop, maar het zou voor de list-of-figures wel het gewenste resultaat opleveren.

@Gtrouborst
Copy link

Langere bijschriften zijn op zich geen probleem: https://geonovum.github.io/MIM-Werkomgeving/#tof. De naam van het diagram zonder suffix - overzicht of - detail klinkt prima.

@ArjanLoeffen
Copy link
Contributor

ArjanLoeffen commented Aug 14, 2023

Het lijkt erop dat bij <figure> de figuur binnen de kolombreedte wordt gedwongen zonder de vertikale hoogte te herstellen. Dat moet dan in CSS kan worden aangepast.

Voorbeeld:

image

terwijl dit op de oude manier was:

image

ArjanLoeffen pushed a commit that referenced this issue Aug 14, 2023
In de owner parameters is de parameter diagram-encoding opgenomen; deze
is niet verplicht.
Wanneer 'figure', dan wordt eem <figure> element met caption ingevoegd.
De naam van de figure is de title zonder "- overzicht".

Zie #326

Minor. Andere owners worden niet geraakt door deze aanpassing.
@ArjanLoeffen
Copy link
Contributor

In de owner parameters is de parameter diagram-encoding opgenomen; deze is niet verplicht.
Wanneer 'figure', dan wordt een <figure> element met caption ingevoegd.
De naam van de figure is de title zonder "- overzicht".

@ArjanLoeffen
Copy link
Contributor

Beschikbaar op 15 aug.

@Gtrouborst
Copy link

Als ik dit test bij bestuurlijke gebieden gaat het nog niet helemaal goed, maar misschien komt het doordat ik de parameter nog niet correct heb opgenomen.

Geef ik de owner parameters aan in de properties file? Op deze manier: diagram-encodig = figure?

@ArjanLoeffen
Copy link
Contributor

ArjanLoeffen commented Aug 15, 2023 via email

@Gtrouborst
Copy link

Gtrouborst commented Aug 16, 2023

@wilkoquak en ik hebben hier vandaag nog even naar gekeken. Nu wordt <figcaption> samengesteld uit Diagram Name én Diagram Notes. Maar dat is teveel van het goede. De Diagram Notes gebruiken we graag voor een geschreven toelichting op een diagram. De teksten die we daar opnemen kunnen langer zijn dan prettig is als bijschrift voor een figuur. We zien die teksten wél graag terug in de documentatie, maar liever niet in de <figcaption>.

Voorstel

Graag zien wij het als volgt:

  • Alleen Diagram Name in <figcaption>, zonder - detail of - overzicht
  • De tekst in <figcaption> niet vetgedrukt maken (anders wijkt het af van de rest van het document)
  • De tekst uit de Diagram Notes als losse tekst onder de figuur, dus na de closing tag </figure>) en met behoud van opmaak zoals die in EA is meegegeven.

@ArjanLoeffen
Copy link
Contributor

Uitgevoerd.

ArjanLoeffen pushed a commit that referenced this issue Aug 16, 2023
@ArjanLoeffen
Copy link
Contributor

17 aug beschikbaar.

@Gtrouborst
Copy link

Fijn, dankjewel Arjan!

@wilkoquak
Copy link
Collaborator Author

Er gebeuren nog wat onverwachte dingen... [let op de spaties]. Als de naam van een UML diagram op '-overzicht' eindig wordt dez wel geplaatst in de catalogus, maar de tekst onder het plaatje wordt niet geprint. Als de naam van een UML diagram eindigt op '- overzicht' gaat het plaatje ook naar de catalogus maar wordt de tekst wel geprint. Voor mij is het altijd de bedoeling dat de tekst geprint wordt. Verder zou het mooier zijn om in de figcaption de postfix (-overzicht, -detail, en alle varianten niet mee te nemen.

@PalmJanssen
Copy link
Collaborator

Voor de volledigheid. Als de naam eindigt op - detail wordt het diagram wel geplaatst maar wordt de tekst van het notes veld niet geprint. Dit was natuurlijk 'vroeger' wel zo, ook met de nightlyBuild.

@ArjanLoeffen
Copy link
Contributor

ArjanLoeffen commented Sep 11, 2023

Hersteld. Graag testen! De aanpassing geldt voor respec waarin figure elementen worden ingevoegd. Dat is op dit moment alleen het geval voor Geonovum, namelijk dmv de parameter:

<parameter name="diagram-encoding">figure</parameter>

onderdeel van /input/Geonovum/cfg/owners/Geonovum.xml

ArjanLoeffen pushed a commit that referenced this issue Sep 11, 2023
ArjanLoeffen pushed a commit that referenced this issue Sep 11, 2023
@ArjanLoeffen
Copy link
Contributor

Beschikbaar in Nightly-build.10

@wilkoquak
Copy link
Collaborator Author

Dank! Ik zie dat (-overzicht) nog wel in de caption terechtkoment en (- overzicht) niet (een spatie verschil). Dat is nog niet helemaal logisch, zie in het screenshot hieronder het verschil tussen de table-of-contents en de list-of-figure maar dit issue ga ik sluiten.

afbeelding

@wilkoquak
Copy link
Collaborator Author

sorry vergeten te sluiten

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants