RE: Using conditions in multi-destination docs

Subject: RE: Using conditions in multi-destination docs
From: "Combs, Richard" <richard -dot- combs -at- Polycom -dot- com>
To: "McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 22 Dec 2009 14:17:34 -0700

McLauchlan, Kevin wrote:

> For a doc set that can be used with either Prod1 or
> Prod2, can I get away with just two condition tags:
>
> - notProductOne
> - notProductTwo
>
> Example text would be something like:
>
> "Your [Prod1][Prod2] arrives from the factory with default
> network settings. Before using the appliance configure
> for your network as follows: "
>
> Each time a product name appeared it would be a pair with
> both elements condition tagged. [Prod1] would have condition
> notProductTwo, and [Prod2] would be tagged notProductOne.
>
> I would do the same with paragraphs and whole topics/pages
> that applied to just one or the other.

All together now: It depends. :-)

Do you (or will you potentially) have multiple deliverables to derive
from the single source, like print/PDF plus online help? What
application and version are you using?

In FrameMaker 7.x or earlier, conditions could only be ORed, so to AND
conditions, you had to define combination conditions, e.g., Prod1+Print,
Prod1+Help, Prod2+Print, Prod2+Help. If you add more products and/or
outputs, the number of combination conditions you need quickly becomes
large. FM 8 and 9 support logical expressions for what to show, so you
can show and hide any combination of conditions.

There's no reason to name the condition for the Prod1 text "notProd2"
unless it's easier for you to think of it that way and no one else will
ever need to understand it. Me, I'd want to tag the text for Prod1 as
"Prod1."

I second Tammy's warning about conditionalizing mid-sentence snippets --
it's much less error-prone and messy (and better for translation) to
conditionalize only complete sentences or paragraphs.

If you're using FM, you shouldn't use conditions for "Your
[Prod1][Prod2]..." anyway. Use variables for the product names, model
numbers, doc titles, etc. Then import one set of variable definitions to
output Prod1 deliverables and another set to output Prod2 deliverables.

If you're using Word, my sympathies. ;-)


Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-777-0436
------





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

Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at:
http://www.doctohelp.com/

Help & Manual 5: The all-in-one help authoring tool. True single- sourcing --
generate 8 different formats and as many different versions as you need
from just one project. Fast and intuitive. 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


Follow-Ups:

References:
Using conditions in multi-destination docs: From: McLauchlan, Kevin

Previous by Author: RE: job market Q4 2009
Next by Author: RE: Politically Correct Christmas...er Holiday Poem
Previous by Thread: RE: Using conditions in multi-destination docs
Next by Thread: RE: Using conditions in multi-destination docs


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

Sponsored Ads


Sponsored Ads