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.
I have a dilemma that probably has a simple solution that I can't see...
I'm documenting an application based on Eclipse and I have to refer to
files located inside Eclipse projects, but I don't know how to format them.
For reference purposes I'll use the following image from Eclipse help: http://help.eclipse.org/kepler/topic/org.eclipse.platform.doc.user/images/Image241_nav_view.png
.
For example, my procedure would be something like this:
1. Open the TestProject project.
2. In the Explorer view, under SomeFolder, select AnotherFile.txt.
According to MS Manual of Style 4th ed, "Bold in procedures if the user
must click the file name or type the name as shown." So far, so good,
everything should be in bold (<guilabel> in DocBook).
But if I have:
1. Open the TestProject project.
2. Right-click Test.xml and select Run as Ant Build. The AnotherFile.txt
file is created under SomeFolder.
In this case, would AnotherFile.txt be in bold or Courier? You're not
supposed to click it, so it should be formatted like a regular file name
(<filename> in DocBook, which in my case is output as Courier), but then it
looks inconsistent... Am I overthinking this?
Thanks,
Jen
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.
