For AI agents: a documentation index is available at https://idratherbewriting.com/llms.txt. Markdown versions of all pages are available by appending .md to any page URL.

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>
    

Sponsored

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, agent skills, tech comm careers, and more. Check out my AI courses for more on the latest in AI and tech comm. If you're looking for info about documenting APIs, see my API documentation course.

If you're a technical writer and want to keep on top of the latest trends in tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me.

Finally, I want to note a couple of things. I usually write the first drafts of my posts myself and then use AI to improve accuracy, clarity, and detail in places, so my writing is a mix of human and AI. (Hopefully that's not too off-putting.) Also, the opinions I express on my blog are my own perspectives, not those of my employer.