DITA-OT
Defining key values in Markdown map topic references #4490
Replies: 3 comments 3 replies
-
|
@chrispy-snps It looks like you're mixing the unordered list syntax for standard topic references with the link reference syntax, which might cause problems. Have you tried removing the list marker hyphens from the last 2 lines? ---
$schema: urn:oasis:names:tc:dita:xsd:map.xsd
filename: map.md
---
# My Online Help
- User Guides
- [My User Guide](userguide.md)
- Reference Manuals
- [My Reference Manual](refman.md)
[userguide-key]: userguide.md
[refman-key]: refman.md |
Beta Was this translation helpful? Give feedback.
-
|
Hey @infotexture! When I try that, it doesn't crash, but I get unresolved keyrefs during the transformation: and indeed, the cross-references are broken in the HTML. I feel like surely others must have done this before, and I must be missing something obvious. |
Beta Was this translation helpful? Give feedback.
-
That's a very familiar feeling |
Beta Was this translation helpful? Give feedback.
-
|
Added a note to LwDITA plug-in docs that you can't define keys in topic references in Markdown. @infotexture please feel free to improve the copy. |
Beta Was this translation helpful? Give feedback.
-
For reference information, see [My Reference Manual](refman-key).The problem is here. This should be a full reference link: For reference information, see [My Reference Manual][refman-key]. |
Beta Was this translation helpful? Give feedback.
-
|
@infotexture, @jelovirt - thanks very much! Indeed, I was not using the proper full reference link syntax for keyrefs. So now I have: ---
filename: userguide.md
---
# My User Guide
## Introduction
For reference information, see [My Reference Manual][refman-key].---
filename: refman.md
---
# My Reference Manual
## Introduction
For usage information, see [My User Guide][userguide-key].---
$schema: urn:oasis:names:tc:dita:xsd:map.xsd
filename: map.md
---
# My Online Help
- User Guides
- [My User Guide][userguide.md]
- Reference Manuals
- [My Reference Manual][refman.md]
[userguide-key]: userguide.md
[refman-key]: refman.mdand the keyrefs resolve, but the map TOC shows the keydefs explicitly instead of hiding them as resource-only: <body id="my-online-help">
<h1 class="title topictitle1">My Online Help</h1>
<nav>
<ul class="map">
<li class="topicref keydef"><a href="userguide.html">My User Guide</a></li> <!-- HERE -->
<li class="topicref keydef"><a href="refman.html">My Reference Manual</a></li> <!-- HERE -->
<li class="topicref topichead">User Guides
<ul>
<li class="topicref"><a href="userguide.html">My User Guide</a></li>
</ul>
</li>
<li class="topicref topichead">Reference Manuals
<ul>
<li class="topicref"><a href="refman.html">My Reference Manual</a></li>
</ul>
</li>
</ul>
</nav>
</body>so I am still missing something about how to properly use keys for Markdown map topic references (or maybe I can't?). |
Beta Was this translation helpful? Give feedback.
-
Let's say I have the following two topics, each with a key-based cross-reference:
What is the correct Markdown map syntax to specify the topic file references, navtitle, and key definitions?
I tried this, but it crashes:
And really, I want a syntax that does all three in a single reference, the Markdown map equivalent of this:
I don't see this form explicitly mentioned here:
Markdown DITA syntax (DITA-OT docs)
Beta Was this translation helpful? Give feedback.
All reactions