Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for cross-references in descriptions #44

Open
toTheSky opened this issue Sep 14, 2023 · 1 comment
Open

Add support for cross-references in descriptions #44

toTheSky opened this issue Sep 14, 2023 · 1 comment
Assignees
Labels
feature request New feature or request

Comments

@toTheSky
Copy link

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 toTheSky changed the title Does it has a cross-reference feature? Does it have a cross-reference feature? Sep 14, 2023
@amykyta3
Copy link
Member

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 amykyta3 changed the title Does it have a cross-reference feature? Add support for cross-references in descriptions Sep 17, 2023
@amykyta3 amykyta3 self-assigned this Sep 17, 2023
@amykyta3 amykyta3 added the feature request New feature or request label Sep 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants