RE: How to reference document sections?

Subject: RE: How to reference document sections?
From: "Wollenberger, David" <David -dot- Wollenberger -at- sterling -dot- com>
To: äë <sdeichmann -at- voicemobility -dot- com>, TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 22 Feb 2000 08:18:25 -0800



If the document is an online document, I would dispense with both quotes and
italics, and use green text to indicate a link (also, make it a link). I
would not use the word section, and I would add a page number for those
users who print out the manual. That would make your sample sentence read
as follows:

See Adding Widgets on page ** for more information.

(I can't do the green in email).

David



-----Original Message-----
From: äë [mailto:sdeichmann -at- voicemobility -dot- com]
Sent: Friday, February 18, 2000 12:54 PM
To: TECHWR-L
Subject: How to reference document sections?


Is there a conventional way to reference document sections inside the same
document?

For example, in a user guide I have the following statement:

See the section "Adding Widgets" for more information.

I have been told that using quotation marks is incorrect, and that italics
should be used instead for the section name. Is one of these methods
considered correct? (Or another that I haven't mentioned?)

Thanks,

Sue Deichmann
Technical Writer
Voice Mobility Inc.
www.voicemobility.com




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sponsored by Weisner Associates Inc., Online Information Services
Training & consulting for RoboHELP, Dreamweaver, HTML, and HTML-Based Help.
More info at http://www.weisner.com/train/ or mailto:training -at- weisner -dot- com -dot-

Your web site in 32 languages? Maybe not now, but sooner than you think.
Contact ForeignExchange for the FREE paper, "3 steps to successful
translation management" (http://www.fxtrans.com/3steps.html?tw).

---
You are currently subscribed to techwr-l as: David -dot- Wollenberger -at- STERLING -dot- COM
To unsubscribe send a blank email to leave-techwr-l-9637N -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.




Previous by Author: Is Contents Singular or Plural?
Next by Author: RE: PDFs/self-extracting .exe
Previous by Thread: Re: How to reference document sections?
Next by Thread: Popup window from external help file topic; RoboHelp Classic 7.0


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

Sponsored Ads


Sponsored Ads