RE: Arguments for NOT using topics as parents to other topics in DITA-maps

Subject: RE: Arguments for NOT using topics as parents to other topics in DITA-maps
From: "Janoff, Steven" <Steven -dot- Janoff -at- ga -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>, "Combs, Richard" <richard -dot- combs -at- Polycom -dot- com>
Date: Wed, 17 Jul 2013 10:10:13 -0700

Richard, can you expand on your objection to a topic having a single subtopic? I'm trying to understand what you mean by "bad form."

I'm reminded of the idea that a bulleted list shouldn't have a single bullet. Although it doesn't look great, it's sometimes necessary, even when there's enough time for reflection.

Thanks,

Steve

Richard Combs wrote (Wed., July 17, 2013 8:34 AM):
...
The second example would look like this:

1. Alarms overview
A. List of alarms
2. Some other topic

Bad form. A topic shouldn't have a single subtopic. Granted, many of us have occasionally broken that rule when in a hurry, but it's still a good one. I'm a bit surprised that DITA doesn't enforce it.



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.

Learn more: http://bit.ly/ZeOZeQ

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

References:
Arguments for NOT using topics as parents to other topics in DITA-maps: From: Martin Jonasson
RE: Arguments for NOT using topics as parents to other topics in DITA-maps: From: Combs, Richard

Previous by Author: Mac Equivalent for Segoe?
Next by Author: RE: Arguments for NOT using topics as parents to other topics in DITA-maps
Previous by Thread: RE: Arguments for NOT using topics as parents to other topics in DITA-maps
Next by Thread: RE: Arguments for NOT using topics as parents to other topics in DITA-maps


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads