cdisc-org / DDF-RA

This is the repository for all code and documentation for the DDF-RA project.
MIT License
19 stars 1 forks source link

Resolve issue with brackets in IG attribute list [CT] #299

Open BSnoeijerCD opened 10 months ago

BSnoeijerCD commented 10 months ago

Square brackets are now interpreted in the IG as an reference link. The tool for creating the CT overview list for the IG needs to add escape characters to the CT text in order to resolve this issue.

dih-cdisc commented 7 months ago

Given that tooling appears to be OK for release 3, going to close this ticket.

dih-cdisc commented 7 months ago

Reopen issue as apparently the issue still exists

gerrycampion commented 7 months ago

@BSnoeijerCD @dih-cdisc I see this is assigned to me. I am not familiar with the tool for creating the CT overview list for the IG. Can you point me to:

drewcdisc commented 6 months ago

@gerrycampion @dih-cdisc We are looking at a possible solution solely within the content. We will get back in touch if further tooling work needs to be done.

ASL-rmarshall commented 2 weeks ago

I did some investigation and found that the unwanted hyperlinks are not created if the markdown is copied from GitHub and then pasted into the wiki page using the add Markup function:

image

and selecting the "Markdown" option:

image

No tooling changes are required if this method is used to insert the markdown into the IG

ASL-rmarshall commented 2 weeks ago

It looks like a modification was made to the original terminology definition for the Study entity to try to prevent the hyper link issue (possibly the "solution solely within the content" mentioned in the comment above) - "[ClinicalTrials.gov]" was changed to "[[http://ClinicalTrials.gov]]". When the markdown is now inserted into the the IG using the method described in the previous comment, this modified text appears as defined in the content (i.e., with the double square brackets and the "http://" that did not appear in the original terminology definition), which is not ideal.

We discussed this at the scrum meeting on 2024-11-12 and agreed to remove "[[http://ClinicalTrials.gov]]" completely from the definition of the Study entity (C15206) because we actually just want to use the defined CDISC Glossary description, which does not contain the reference to ClinicalTrials.gov.

@EMuhlbradt FYI @BSnoeijerCD @dih-cdisc