Linking to model elements in doc element markdown strings

Syside Feature Requests
1

Hi,

The Modeler feature that shows a tooltip with formatted markdown of a model elements’ `doc` object is very nice. Is it possible to reference/ add hyperlinks in the doc text to actual model elements? Something like

part def MyPart {
  doc /* here is my part */
}

part useIt : MyPart {
  doc /* this usage is defined by @$::MyModel::MyPart.
}

Then the user can hover over a definition, read the text, if there is a hyperlink, they can click it in the tooltip and be transported to that definition (in vs code), or in built documentation (eg a static site), transported to that page of the model reference docs.

It would probably also be useful to know if Modeler can interpret / navigate markdown anchor links?

A further application - users create a glossary of system terms in the model, and in doc strings, can reference them:

package ModelGlossary {
    item def State {
        doc
        /* A specific condition of a system at a point in time. */
    }
}

package MyModel {
  part def MyState {
    doc /* A [state]($::ModelGlossary::State) of the system. */
  }
}

thanks!

2

Hi,

Resolving links to symbols is something we could definitely add in the future, we just have more important issues/features to resolve in the meantime.

Currently, Syside simply forwards the source docstring(s) to the client for rendering so all hyperlinks will have to be written manually.