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.
Subject:RE: General formatting question for a TOC From:"Tammy Van Boening" <Tammy -dot- VanBoening -at- healthlanguage -dot- com> To:"Karen L. Zorn" <k -dot- zorn -at- zorntech -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 12 Nov 2007 15:17:03 -0700
Thanks everyone. It seems that what I am doing is indeed the 'norm' just
for all of the reasons that I cited to the developer. I appreciate the
feedback. On to different fish to fry.
TVB
Tammy Van Boening
Senior Technical Writer
Health Language, Inc.
Office: +1 (303) 307-4400 x254
www.healthlanguage.com
-----Original Message-----
From: Karen L. Zorn [mailto:k -dot- zorn -at- zorntech -dot- com]
Sent: Monday, November 12, 2007 2:54 PM
To: Tammy Van Boening; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: General formatting question for a TOC
Tammy Van Boening wrote:
However, an edit that I received recently indicated that the editor's
(i.e., developer's) preference was to put in only Heading 1 levels - it
looked different/funky to him to have more than one level in the TOC.
****
A 3-level TOC presents an outline of the document helping the reader
find
what they want, especially if the document is not indexed. When only one
level is presented, the reader may not see a related sub-topic,
therefore
"the document is worthless."
YMMV
Karen L. Zorn
Zorn Technologies, Inc.
Mesa, AZ
-----Original Message-----
From: techwr-l-bounces+k -dot- zorn=zorntech -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+k -dot- zorn=zorntech -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf
Of Tammy Van Boening
Sent: Monday, November 12, 2007 2:41 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: General formatting question for a TOC
_____________________________________________
From: Tammy Van Boening
Sent: Monday, November 12, 2007 2:40 PM
To: TechComm Discuss (techcomm-discuss -at- stcrmc -dot- org)
Subject: General formatting question for a TOC
All,
Have a general formatting question - it's definitely a matter of
personal preference versus any hard and fast rule I would think, but
then again. . . .when I create any TOC (Word or Framemaker), I have
always been rigorously edited to include at least the first two heading
levels of your heading styles, and sometimes the first three. I have
HeadingLevel1/Heading 1 aligned to the left and subsequent heading
levels indented accordingly - Heading2 Levels slightly indented beneath
Heading1 Levels, and Heading3 Levels slightly indented beneath Heading 2
levels. I don't go for a bunch of different fonts, bolding, etc. The
fonts are all the same for the TOC entries, just different in
indentation and font size.
I truly don't have heartburn about this either way - there's much bigger
fish to fry, but I just wanted some feedback from the writing community
to get a general feel about what's the "norm" and what's not - so I can
support the decision either way (because another developer wants all of
the heading levels in - of course~)
Thanks,
TVB
Tammy Van Boening
Senior Technical Writer
Health Language, Inc.
Office: +1 (303) 307-4400 x254
www.healthlanguage.com
NOTICE BY HEALTH LANGUAGE, INC.
This message, as well as any attached document, contains information
from
Health Language, Inc. that is confidential. The information is intended
only for the use of the addressee named above. If you are not the
intended
recipient, you are hereby notified that any disclosure, copying,
distribution or the taking of any action in reliance on the contents of
this
message or its attachments is strictly prohibited, and may be unlawful.
If
you have received this message in error, please delete all electronic
copies
of this message and its attachments, if any, destroy any hard copies you
may
have created, without disclosing the contents, and notify the sender
immediately. Unless expressly stated otherwise, nothing contained in
this
message should be construed as a digital or electronic signature, nor is
it
intended to reflect an intention to make an agreement by electronic
means.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats
or
printed documentation. Features include support for Windows Vista & 2007
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as k -dot- zorn -at- zorntech -dot- com -dot-
To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/ for more resources and info.
NOTICE BY HEALTH LANGUAGE, INC.
This message, as well as any attached document, contains information from Health Language, Inc. that is confidential. The information is intended only for the use of the addressee named above. If you are not the intended recipient, you are hereby notified that any disclosure, copying, distribution or the taking of any action in reliance on the contents of this message or its attachments is strictly prohibited, and may be unlawful. If you have received this message in error, please delete all electronic copies of this message and its attachments, if any, destroy any hard copies you may have created, without disclosing the contents, and notify the sender immediately. Unless expressly stated otherwise, nothing contained in this message should be construed as a digital or electronic signature, nor is it intended to reflect an intention to make an agreement by electronic means.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
