Provide searchable images

w3c / sdw-sosa-ssn

Repository of the Spatial Data on the Web Working Group for the SOSA/SSN vocabulary

8 stars 5 forks source link

Provide searchable images #231

Open sgrellet opened 3 months ago

sgrellet commented 3 months ago

Could we make diagrams searchable in the spec ?

That will help not loosing the overview when looking at class/property definition and also newcomers navigate in the spec by searching for properties & classes names

dr-shorthair commented 2 months ago

I have tried adding terms to the alt tag in the HTML, but that still does not make them searchable using ctrl-F .

dr-shorthair commented 1 week ago

@sgrellet do you have a technical solution for this that we might consider?

sgrellet commented 1 week ago

I'll ask the team here.

sgrellet commented 1 week ago

Feedback from colleagues

we could try SVG but it has to be within the HTML page not a reference to an external SVG image : and see how this work
or, more crappy solution, fill in image accesibility tags with the name of the classes and properties etc...

ldesousa commented 1 week ago

Alternative solutions to consider:

Mermaid: currently interpreted in Markdown documents by must code forges, therefore usable directly in GitHub issues, etc.
PlantUML: popular at the moment, although not as integrated with code forges.

In both cases the diagram sources can be provided alongside the main HTML.