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

Using Mermaid within Madcap Flare #2186

Open
niglon opened this issue Jul 14, 2021 · 0 comments
Open

Using Mermaid within Madcap Flare #2186

niglon opened this issue Jul 14, 2021 · 0 comments

Comments

@niglon
Copy link

niglon commented Jul 14, 2021

Hi,
We use Madcap Flare for our documentation and have been experimenting with Mermaid charts within a topic, and are impressed with the results :-)

We have come across one problem. Flare has the ability to use variables and snippets within it's syntax.
So, as an example, if we are using our product name "COINS" within the text, it would be written as

Our software is called <MadCap:variable name="General.ProductName" />

The <MadCap:variable name="General.ProductName" /> part is replaced with "COINS" when we display the topic. If we ever change our software name, we change the variable, and all text across our product switches from "COINS" to the new value.

On a node in Mermaid, we would like to use this so that the node text can contain a variable, but the render does not like it.

We tried encapsulating the variable in "" and replacing the double quotes within the variable to #quot; but that just reproduces the variable code verbatim and does not display COINS as the text.

I appreciate this not a bug in mermaid, but we would like to be able to reference the Flare assets within Mermaid charts. Is this feasible?

Example:
Here is a mermaid diagram: <div class="mermaid"> graph LR; A--&gt;B; B--&gt;C; C--&gt;D(<MadCap:snippetText src="../Resources/Button Snippets/Button_Add.flsnp" />;) click A callback "Tooltip" click B "http://www.github.com" "This is a link" click C call callback() "Tooltip" click D href "http://www.github.com" "This is a link" </div><

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant