PeakRDL-html icon indicating copy to clipboard operation
PeakRDL-html copied to clipboard

Add support for cross-references in descriptions

Open toTheSky opened this issue 1 year ago • 1 comments

Hi. Does SystemRDL has any support of cross-references? For example, let's have a look at this field description:

// description of Interrupt Enable Register field
desc = "
    When set to 1, it enables ISR.DONE to generate interrupt
";

I want to create a link or a cross-reference related to ISR.DONE in this description. ISR and its fields (including DONE) exist in RDL. And when clicking on it in generated HTML, I would like to see the page related to ISR DONE field. In other words, I need a description that can store not only just text, but cross-reference to RDL entity too.

toTheSky avatar Sep 14 '23 14:09 toTheSky

SystemRDL never defined such a mechanism, but I really like the idea! Since I already run the description text through a Markdown processor, I could make an extension that adds support for cross references. Seems like a really useful feature.

amykyta3 avatar Sep 17 '23 04:09 amykyta3