format for references to topic headings in online help

Subject: format for references to topic headings in online help
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: TECHWR-L Writing <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 7 Oct 2009 11:40:57 -0700

How do you prefer to format references to topic headings? Double
quotes? Plain text?

When they're hyperlinked, I figure that's adequate, but I have some
where the hyperlink is e.g. "continue with <link>step 5</link> of
Installing a Widget."

Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices.

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control!

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-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

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

Please move off-topic discussions to the Chat list, at:


Previous by Author: Re: one vs. 1 (SusanT)
Next by Author: Re: Tools versus skill set
Previous by Thread: Tool questions: Font problems in PDF/X-1a files generated from Word 2000
Next by Thread: RE: format for references to topic headings in online help

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

Sponsored Ads

Sponsored Ads