Search results

DITA: References to non-DITA files

Making references to non-DITA resources requires you to reference the resource in the ditamap as well as the topic.

If you don't reference the resource in the DITA map, then it won't be included in the output. Add the following to your map, marking the resource as processing-role="resource-only".

     <topicref href="nondita_resources/docmap.pdf" format="pdf" processing-role="resource-only"/>

Now that you've ensured the resource will be included with the output files, use an xref and point to the resource:

       <xref format="pdf" href="nondita_resources/docmap.pdf" scope="peer">sample pdf</xref>

Set the format. You can type any value you want there, not just those listed in the value choices. Also add the scope attribute: scope="peer".

sample pdf sample pdf 2 logo

About Tom Johnson

Tom Johnson

I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.

If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.