Re: GUI elements - how do you format them in your docs?

Subject: Re: GUI elements - how do you format them in your docs?
From: Yves Barbion <ybarbion -at- uni-learning -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 03 Nov 2005 15:33:24 +0100


Hello Carla (and fellow techwhirlers),

I call these GUI elements "controls" and I tag them as follows:

1. Click the <control>Start</control> button. 2. Choose <control>Tools</control> > <control>Options</control>, and then click the
<control>View</control> tab.

Using a dedicated tag has the following benefits:

- The formatting can vary, depending on the medium (e.g. bold in print or PDF; colored text in Help).

- The user can easily distinguish between regular text and UI text.

- Localization: you can generate lists of text in "controls" for your translators and they will know that they have to pay special attention to these <control>s.

- Localization: if you use a tool like FrameMaker, you can use different language settings for "controls" and regular text. For example, suppose I'm writing a French user guide about an English software program. I will use French in my paragraph tags for regular text (for hyphenation and spell checking) and English in the settings of my <control> tag. FrameMaker will automatically switch between both dictionaries when hyphenating and spell checking the text.

Best regards



Yves Barbion Senior Technical Writer
Adobe-Certified FrameMaker Instructor
____________________________________

U&I Learning NV (formerly ATEK NV)
Molenaarsstraat 111 B-9000 Gent Belgium Tel.: +32 9 265 74 72 Fax: +32 9 265 74 84 www.uni-learning.com
____________________________________

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

Try WebWorks ePublisher Pro for Word today! Smooth migration of legacy
RoboHelp content into your new Help systems. EContent Magazine Decision-
maker review (October 2005) is here: http://www.webworks.com/techwr-l

Doc-To-Help 2005 converts RoboHelp files with one click. Author with Word or any HTML editor. Visit our site to see a conversion demo movie and learn more. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



References:
GUI elements - how do you format them in your docs?: From: Martinek, Carla

Previous by Author: Re: techwr-l digest: November 06, 2005 - ISO Project 11
Next by Author: Re: DITA, XMetaL and FrameMaker Together ???
Previous by Thread: RE: GUI elements - how do you format them in your docs?
Next by Thread: AW: {*} GUI elements - how do you format them in your docs?


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

Sponsored Ads


Sponsored Ads