Comments (4)
@pflotscher - we are heavy users of nested subtopics. We like that the DITA topic/subtopic structure directly corresponds to the HTML topic structure, which allows our technical writers to craft the customer content experience that they want (no topic merging/splitting during transformation).
We explicitly include nested subtopic references in our maps:
<topicref href="path/to/topic.dita" keys="topic">
<topicref href="path/to/topic.dita#subtopic1" keys="subtopic1">
<topicref href="path/to/topic.dita#subsubtopic" keys="subsubtopic"/>
</topicref>
<topicref href="path/to/topic.dita#subtopic2" keys="subtopic2"/>
</topic>
We also use keys, so we need these explicit topic references to specify the key values.
Adding these explicit subtopic references is a bit of a pain for the technical writers. If you are using Oxygen, you might also want to put your support behind this issue:
EXM-48539 Automatically update topicrefs to nested topics in the DITA Map
from dita-ot.
This feature would need to be under a toggle, because we don't want to break backwards compatibility.
from dita-ot.
@pflotscher - do you use topic keys and keyrefs in your flow?
from dita-ot.
@pflotscher - your request is reasonable, considering that the pdf2
transform does include implicit nested subtopics in its TOC.
If it makes you feel better in the meantime, explicit nested topic references are normal for those of us that use keys and keyrefs, so they are not inherently bad or inelegant if you update your DITA XML generation to generate them.
Regarding your reply item 1, if a nested topic has no explicit reference, the topic content is generated but the HTML TOC entry is not.
Regarding your reply item 2, that is indeed the tricky part! Oxygen has a graphical map view (called the DITA Maps Manager) that nicely shows topic/subtopic structure and key values. But currently, it does not automatically search inside topics for unreferenced subtopics. That is not an easy problem because users can do thinks like rearrange subtopics and even move them from one file to another, and ideally a best-effort attempt should be made to keep their key values in the process.
from dita-ot.
Related Issues (20)
- Fail to replace temp files on Windows with looping referenced ditamaps HOT 2
- Error in nested DITA-OT project file is not properly reported. HOT 1
- DOTJ031I is triggered four times
- Echo current deliverable in non-verbose mode HOT 2
- preprocess2 fails when topicref is missing regardless of processing-mode HOT 2
- Output is not named as expected when using root-chunk-override=to-content HOT 2
- Chunking does not work when using xsd
- --nav-toc=full is not full when topicrefs have no href
- DITAVAL "passthough" action does not work for profiling applied to top-level (root) topic element
- Topic cross reference links in generated HTML are broken in case of chunk=to-content
- Cannot use the same mark for pushbefore and pushafter conactions
- Should be able to change severity for Java based messages HOT 1
- DOTJ049W should help me to find the not compliant attribute value HOT 1
- xref link to a list is not working when the topic is used as conref in another topic and published with transtype xhtml HOT 1
- docker: permission issue on pdf compilation when specifying user-id/group HOT 5
- PDF Theme not Obeying Heading title-numbering
- Dita 2.0 chunk="combine" on root element produces incorrect output
- Handling content outside the map directory: incorrect links in nav toc (HTML5)
- foreign xlink:href attributes are processed, resulting into NullPointer exception HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from dita-ot.