Entries by Katriel Reichman

Including equations in DITA content

There are three possible containers for equations in the equation domain: equation-inline, equation-block, and equation-figure. Choose the DITA elements that makes the most sense for your equations: inline, in a separate block, and/or an equation or series of equation with a caption.

Should you use tables in DITA?

Writers are conditioned to using tables. We are creatures of habit, and using tables in DITA seems to come naturally if you are used to writing in Word or FrameMaker. Bottom line: When you need to present information that will be table-like when read, your default preference should be for definition lists. We know that you […]

How to describe choices in a DITA task topic?

Why use <choices> or <choicetables> instead of <ol> or <ul> in a task topic when you need to choose what to do next? DITA markup offers different options for describing choices in a DITA task topic. The benefit of <choices> or <choicetables> is that the markup is semantic! When you use <choices> or <choicetables>, the machine (and […]

Polygamous or Monogamous DITA Topics?

Embedding multiple topics inside one topic file (polygamous topics) is not good practice. We call these topics, “polygamous topics”. If, in real life, polygamy tends to be a really bad idea, the same is true for DITA topics. The golden rule for DITA topics is

Is Google Apps for Work for you?

What is Google Apps for Work? Google Apps is a cloud-based productivity suite that helps teams communicate, collaborate and get things done from anywhere and on any device. It’s simple to set up, use and manage, so your business can focus on what really matters. Who uses Google Apps for Work? Millions of organizations around the […]

Nest DITA topics under a topic or under a topichead?

When you have a collection of DITA topics to nest, or individual DITA topics to next, you have a lot of choices. Often, too many choices. In a ditamap, you can nest DITA topics under a topic, <topichead> or <topicgroup>. In a bookmap, you can nest DITA topics or a ditamap under the <part> or […]

Group topics in DITA maps

Referring to DITA maps from a bookmap or from another DITA map provides a great way for grouping topics. You can refer to the DITA map in the bookmap, or in a parent ditamap, whenever you want to include the collection of topics in the bookmap. Tip: