Need advice on cross-reference styles?

Subject: Need advice on cross-reference styles?
From: Geoff Hart <ghart -at- videotron -dot- ca>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 09 Mar 2005 09:22:09 -0500

Patrick Wright wondered: <<I'm working on a large user's manual... and have been asked not to rewrite or reorganize it in any significant way, mainly due to time constraints on the deliverable... many cross-references are necessary. I have decided that the Microsoft style guidelines for cross-references are pretty reasonable. In this approach, cross-references are usually given as the chapter or section title, and the page number. The page number seems important because of the size of the manual.>>

Hey, Microsoft's off to a great start... already two decisions I agree with this year, and it's only March! Of course, their batting average still won't earn them a place in the major leagues, but I do strive to find the silver lining. <g>

<<I've also been asked to prepare a prototype version of the manual in HTML... The problem is what to do with page numbers, which won't make sense in an HTML document.>>

The easy solution is to simply replace all instances of "page X" with "page X in the original manual". Yes, it's a bit redundant, but on the plus side, those of us who prefer to have a reference book open rather than the online help while we work in the application will find this a godsend. On the other (digital) hand, those who want to use the online help can simply ignore the page reference and simply click on the underlined link to go straight to the correct "page" of online manual.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --
Geoff Hart ghart -at- videotron -dot- ca
(try geoffhart -at- mac -dot- com if you don't get a reply)
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -


Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:

Doc-To-Help 7.5 Professional: New version with new features, improved performance and reliability, plus much more! Download your free trial today at

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 for more resources and info.

Need advice on cross-reference styles: From: Patrick Wright

Previous by Author: Biz: Errors and omissions insurance in Canada? Summary
Next by Author: Any Apple employees or contractors out there?
Previous by Thread: Need advice on cross-reference styles
Next by Thread: Re: Need advice on cross-reference styles

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

Sponsored Ads