Skip to content

URIs in Documentation annotation #2701

Description

@maltelenz

Section 13.5 has:

In order to reference external resources from documentation (such as links and images in html-text) and/or to reference images in the Bitmap annotation (see section 18.6.5.6). URIs should be used...

I would like clarification which of these is true:
A: It is restricted to the full-blown URI (always starting with the scheme like modelica, file, or similar)

B: URI is used in the wider sense of an URI reference, which can be either the thing that starts with a scheme (modelica, file, ...), or it is a relative reference (and if so, the natural base URI it is relative to would presumably be the (file) location of the class?)

In particular, with a file structure like this:

MyPackage/
-- package.mo
-- image.png

Is this expected to work?

package MyPackage
  annotation(Documentation(info = "<html>
<img src=\"./image.png\"/>
</html>"));
end MyPackage;

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions