DITA: Notes
<note type="tip">Don't fasten the bolts too tightly. First make sure all the pieces
fit well together, and then tighten them down firmly.</note>There are actually quite a few options for note types: attention, danger, fastpath, important, notice, other, remember, restriction, tip, warning.
Some of the types have different icons and formatting associated with them. All of notes transform to HTML with a class corresponding with their name.
If you're adding a note inside a task list, add the note inside the info
element.
fig
element:
<fig><title>Bolt Warning</title>
<note type="tip">Don't fasten the bolts too tightly.
First make sure all the pieces fit well together, and then tighten them down firmly.</note>
</fig>About 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.