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.
Subject:Re: Using button bitmaps in text From:Kirsty -dot- Taylor -at- mincom -dot- com To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Mon, 3 Sep 2007 09:14:19 +1000
Hi Ben,
Our standard used to be:
Click <button bitmap>. If it was an icon (no words on it), then we would
add the 'name' of the icon in angle brackets after its use.
A few people had issues with this standard over the years, but we stuck to
it.
A new manager with experience in translation, and the addition to the
group of a bunch of experienced translation staff, has meant we're getting
rid of this standard. Apparently, images in-line with text cause fewer
text matches with translation memory tools like Trados. I'm not sure if
we've decided how we're still going to keep the buttons/icons that are
more obscure (the Commit icon is an engagement/wedding ring ...), but they
won't be inline with text, they'll need to be in a separate glossary table
or something like that.
I would think that adding the bitmap after the hard return breaks up the
bitmap from the text for your translation memory tool, and that's why
having the bitmap at the end of the sentence is incorrect.
Hope this helps,
KT
Kirsty Taylor
Project Manager - Technical Writing
kirsty -dot- taylor -at- mincom -dot- com
Mincom. The People. The Experience. The Vision.
This transmission is for the intended addressee only and is confidential
information. If you have received this transmission in error, please
notify the sender and delete the transmission. The contents of this e-mail
are the opinion of the writer only and are not endorsed by Mincom Limited
unless expressly stated otherwise.
Ben <baj357 -at- gmail -dot- com>
Sent by: techwr-l-bounces+kirsty -dot- taylor=mincom -dot- com -at- lists -dot- techwr-l -dot- com
01/09/2007 07:14 AM
Please respond to
baj357 -at- gmail -dot- com
To
techwr-l -at- lists -dot- techwr-l -dot- com
cc
Subject
Using button bitmaps in text
Hello Everyone.
Has anyone heard about the style guideline that suggests putting button
bitmaps on a new line rather than in line? For example:
Correct:
Click the xyz button.
<button bitmap>
Incorrect:
Click the xyz button. <button bitmap>
I have not seen that guideline in the MSFT Style Guide and have no luck
with Google. But, I have heard that this guideline makes translation
easier, though I'm not sure how.
Also, what if the sentence does not end with the button? For example:
Click the xyz button
<button bitmap>
to open something.
I know I can easily re-write it to put the button at the end, but would
I do that every time?
Thanks for your help!
--
This transmission is for the intended addressee only and is confidential information. If you have received this transmission in error, please notify the sender and delete the transmission. The contents of this e-mail are the opinion of the writer only and are not endorsed by the Mincom Group of companies unless expressly stated otherwise.
--
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-