RE: format for references to topic headings in online help

Subject: RE: format for references to topic headings in online help
From: "Chinell, David F (GE EntSol, Security)" <David -dot- Chinell -at- GE -dot- com>
To: "Robert Lauriston" <robert -at- lauriston -dot- com>, "TECHWR-L Writing" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 9 Oct 2009 09:25:02 -0400

Robert:

We use the Chicago Manual of Style as a base, supplemented by the
Microsoft Manual of Style for Technical Publications.

Chicago says you can set x-refs either italic (not common) or in double
quotes.

MS MoS agrees with you, that hyperlinks provide enough formatting by
themselves, but they don't address your question specifically. However,
every other example of an x-ref in the manual uses double quotes.

That's what we use.

Bear

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.
http://www.doctohelp.com/SuperPages/Webcasts/

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! http://www.helpandmanual.com/

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
format for references to topic headings in online help: From: Robert Lauriston

Previous by Author: RE: Word 2007 cross-references
Next by Author: Certification and Compliance Marks
Previous by Thread: format for references to topic headings in online help
Next by Thread: Tools versus skill set


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

Sponsored Ads


Sponsored Ads