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 images was RE: Elementwise userguide
Subject:RE: referring to images was RE: Elementwise userguide From:Ben Davies <bdavies -at- imris -dot- com> To:"Kay A. Pentecost" <kayp -at- ix -dot- netcom -dot- com>, "Combs,Richard" <richard -dot- combs -at- Polycom -dot- com>, Ken Stitzel <kstitzel -at- symplified -dot- com>, Tech Whirl <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 10 Jan 2013 21:16:10 +0000
I put figure references at the end of instructions in brackets. This makes the reference stand out on the page a little better, and allows me to keep a consistent convention for all references in the same manual.
For example:
Continue routing the cable from the base of the enclosure to the control panel (figure x).
-----Original Message-----
From: techwr-l-bounces+bdavies=imris -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+bdavies=imris -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Kay A. Pentecost
Sent: January-10-13 2:45 PM
To: Combs,Richard; Ken Stitzel; Tech Whirl
Subject: referring to images was RE: Elementwise userguide
Hi, Richard,
My apologies for not changing the subject. In answer to your question "how is this related to Elementwise," it isn't. My bad.
I agree that "Figure" is more popular, I just inherited "Exhibit" and wondered if others were using it.
Thanks,
Kay Pentecost
-----Original Message-----
>From: "Combs, Richard" <richard -dot- combs -at- Polycom -dot- com>
>Sent: Jan 10, 2013 3:09 PM
>To: "Kay A. Pentecost" <kayp -at- ix -dot- netcom -dot- com>, Ken Stitzel
><kstitzel -at- symplified -dot- com>, Tech Whirl <techwr-l -at- lists -dot- techwr-l -dot- com>
>Subject: RE: Elementwise userguide
>
>Kay A. Pentecost wrote:
>
>> What is the standard now for referring to images in the file? Word
>> won't make a link to a page number, and I've been using (see above)
>> when the image is above the text.
>>
>> Also, for User Manual type documents, are people now using "Figure"
>> for captions? The document I inherited uses "Exhibit."
>
>How is this related to "Elementwise" user guides?
>
>In any case, Word certainly lets you create page-number
>cross-references. And I suspect that different people use different
>terms for their figure captions, although I'd bet that "Figure" is more
>popular than "Exhibit" by several orders of magnitude. :-)
>
>Richard G. Combs
>Senior Technical Writer
>Polycom, Inc.
>richardDOTcombs AT polycomDOTcom
>303-223-5111
>------
>rgcombs AT gmailDOTcom
>303-903-6372
>------
>
>
>
>
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Writer Tip: Create 10 different outputs with Doc-To-Help -- including Mobile and EPUB.
Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com
Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives
_______________________________________________
This email has been scanned by the IMRIS Email Security System.
This email has been scanned by the IMRIS Email Security System
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Writer Tip: Create 10 different outputs with Doc-To-Help -- including Mobile and EPUB.
