Updated 11/22/2023
Cross-Publication Links Authored in Markdown (PRD)
You can setup embedded links to topics in other publications, output from either CLC or Trisoft. The target needs to belong to the same product-release-language space and must have a topic ID in the yaml.
Adding a Topic ID
At the top of a topic use the following pattern
---
topicid: yourtopicid
---
For example
---
topicid: GUID-DBB775D1-EC66-4178-BC90-CFFD55A1C6A3
---
If the topic originated from CLC you can use the CLC generated guid created from the file path. For example:
BIM360D_Cost_Management_about_payments_pay_app_status_html
To setup an embedded cross-pub link
Use the following target pattern
topicid=<the actual topicid>
For example
[xpub link](topicid=GUID-081B7FFA-F313-464B-85A5-A060AA9EB44A)
The Markdown above was used to setup the link to this topic xpub link.
To setup an embedded cross-pub link with target topic title as link text
When link text is not provided, the title of the target topic is injected as link text.
Use the following target pattern
[](topicid=GUID-42EA9825-C1D3-4DC3-B213-BA171F239E59)
The Markdown above was used to setup the link to this topic Card Thumbnails (DITA)
To setup an embedded cross-pub link with additional anchor
Use the following target pattern
[xpub link with anchor](topicid=GUID-42EA9825-C1D3-4DC3-B213-BA171F239E59#GUID-42EA9825-C1D3-4DC3-B213-BA171F239E59__GUID-2E6B274F-F30A-48AB-BE0B-9588D35FF440)
The Markdown above was used to setup the link to this topic xpub link with anchor
The bad link
[a xpub link to junk that doesn't work](topicid=junk)
The Markdown above was used to setup a xpub link to junk that doesn't work.
When the target cannot be found, the link itself is dropped and the link text is inserted in its stead (asterisks were used to offset the link text in boldface).
To setup cross-publication related links (in progress still)
Use the related metadata in the yaml header.
related:
- topicid=whatsnewcard-two
When the target cannot be found, the link is dropped, implementing "graceful degradation" supported in DITA.
