Skip to content

add colophon to figures #503

@VladimirAlexiev

Description

@VladimirAlexiev

Currently figures are inserted bare in the spec, eg see
https://raw.githack.com/vladimiralexiev/data-shapes/issue-486-ValidationReport-UML/shacl12-core/index.html#validation-report

https://respec.org/docs/#figure describes some things we can add; and I've added more from discussions:

  • <figure id>
  • <figcaption>
  • table of figures.
  • optional: references eg
    The figure shown in <a href="#figure"></a> is quite impressive
  • @TallTed asked: a longer description for visually impaired people (don't know how to do it for embedded <svg> rather than <img> tag)
  • @HolgerKnublauch asked: any such diagram needs to be wrapped with a warning

The figure is purely informative and illustrative. In case of discrepancies, the written specification text has precedence.

  • @afs and @HolgerKnublauch asked: hide in something like <detail> and have a switch on top to show/hide all figures
    • I could agree, as soon as jumping to the figure's anchor automatically reveals it. Else we can't share figures in email/discussions

@YoucTagh please comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions