TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
RE: Two TOCs (Was: Transitioning user expectations...)
Subject:RE: Two TOCs (Was: Transitioning user expectations...) From:"Jones, Donna" <DJones -at- zebra -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 3 Feb 2005 08:41:24 -0600
> -----Fred Ridder wrote:-----
>
> The run-in paragraph trick works great to include two related
> paragraphs
> in each entry of a regular TOC since the paragraph pairs occur in the
> proper order in the book. I use that trick all the time; for
> example, the
> TOC entries for my API reference pages combine separate name and
> description paragraphs.
>
> But unfortunately, I don't think this approach will work for an a
> alphabetically sorted LOP because the two paragraphs in each pair will
> be sorted to different locations in the list based on their content.
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
I was in the process of writing a message almost identical to Fred's. He beat me when I went to get some coffee!
I tried the run-in approach yesterday because that's what we do in the standard TOC. However, the commands and command descriptions are treated as independent paragraphs rather than as pairs, so the things that are on the same page were not necessarily next to each other in the alphabetized list. Sometimes there were half a dozen run-in paragraphs strung together, followed by one or two single entries, followed by another bunch of run-ins (you get the point).
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.com/techwr-l
Technical Communication Certificate online - Malaspina-University College, Canada. Online training in technical writing, software (FrameMaker, RoboHelp, Dreamweaver, Acrobat), document & web design, writing manuals, job search. www.pr.mala.bc.ca/tech_comm.htm for details.
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
