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: Referring to the name of a system (aka FrameMaker Variables vs. Conditional Text)
Subject:RE: Referring to the name of a system (aka FrameMaker Variables vs. Conditional Text) From:"Butler, Darren J Ctr 584 CBSS/GBHAC" <Darren -dot- Butler -dot- ctr -at- Robins -dot- af -dot- mil> To:"techwr-l List" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 16 Oct 2007 12:29:38 -0400
Caroline Tabach asked: "What is the difference between using a variable
and using a condition...."
I suppose that you could use a Variable, but the Conditional Text
feature was created for situations such as yours, so I think it would be
preferable. I'm not sure that it would be *more* work to set up, but I
do think it would be easier to keep track of what's-what for the very
reason you stated. It also makes it easier for anyone who might inherit
your document for editing/updating. Having to "look under the hood" of
every user-created Variable would be a pain for the next person if you
weren't available to answer questions or left good notes. Personally,
I'd leave Variables for things like headers and footers, tabular
material, etc.
-----Original Message-----
From:
techwr-l-bounces+darren -dot- butler -dot- ctr=robins -dot- af -dot- mil -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+darren -dot- butler -dot- ctr=robins -dot- af -dot- mil -at- lists -dot- techwr-l -dot-
com] On Behalf Of Caroline Tabach
Sent: Tuesday, October 16, 2007 7:43 AM
To: techwr-l List
Subject: Referring to the name of a system
Hi,
I am documenting a safety instructions, unpacking and assembly for a
hardware box (unit), which has a different name when it is part of
different systems.
i.e, when it is part of the Toyshop System, it is called the AB1000 ,
When it is part of the Airplane system it is called the CD7000,
When it is part of the Railway System is the called the MN2000. (all
names and numbers are imaginary)
The person before me set up the 3 files (in FrameMaker) using
conditional text. If you are running Toyshop apply Toyshop condition
and the word AB1000 appears everywhere, etc.
I am now adjusting the documentation for the new use of Railway system
using MN2000, this is theoretically pasting in the conditionalized
word MN2000 next to the first 2 conditions.
I was wondering, is it possible to not use the name of the unit at
all. Just refer to it every time as "the unit"
Would there be a better way of doing it?
What is the difference between using a variable and using a condition
(apart from the fact using a condition I can see exactly what is going
on, as well as the fact that it would be a lot of work to change it)
--
Caroline Tabach
Technical Writer
e-mail: caroline -dot- tabach -at- gmail -dot- com
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
