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.
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.
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-