Re: Cross Referencing/first timer

Subject: Re: Cross Referencing/first timer
From: "Richard G. Combs" <richard -dot- combs -at- voyanttech -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 14 Nov 2002 13:55:48 -0700


<dan -dot- gallagher -at- pulsartech -dot- com> wrote:

> Hi Folks,
> Could anyone shed any light on cross referencing a large manual? I'm about
> to undertake this task and thought it would help to plan and hear from
some
> experienced cross-referencers.
>
> Overview:
> 300 page system manual with 23 chapters and 4 appendices
> Change page at the beginning listing pages with changes since the last
> printing
> multiple sections, figures and tables in each chapter labeled with chap.
> no. -endash- fig. or table number
> typical references in text i.e. "as shown in Figure 12-1" or "table 13-3"
> etc.
>
> I think I should have some clear guidelines before undertaking this. What
> say you?

I think we need more information about what the question is:

-- Are you _really_ talking about cross-referencing (pointing from one place
in the text to another), or are you talking about indexing?

Cross-references are normally created as the document is authored, not all
at once at the end. Indexing, OTOH, can be done productively when the doc is
nearly complete.

-- Are you asking how to convert typed-in (static) references like "as shown
in Figure 12-1" into real (linked, auto-updating) xrefs? Then you'll have to
tell us at least what software you're working in -- Word? FM? WP? Ventura?

If it's Word, is the manual all one file, multiple files with a "master
document," or multiple independent files?

What kind of output are you producing -- hardcopy, PDF (for printing, online
viewing, or both?), HTML, some flavor of Help?

-- Or are you asking about strategies and guidelines for deciding when/where
to cross-reference, what information to include in the xrefs, how
extensively to xref, etc?

Richard


------
Richard G. Combs
Senior Technical Writer
Voyant Technologies, Inc.
richardDOTcombs AT voyanttechDOTcom
303-223-5111
------
rgcombs AT freeDASHmarketDOTnet
303-777-0436
------








^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Order RoboHelp X3 in November and receive $100 mail in rebate, FREE WebHelp
Merge Module and the new RoboPDF - add powerful PDF output functionality
to RoboHelp X3. Order online today at http://www.ehelp.com/techwr-l

Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!

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


Previous by Author: Re: Anyone ever heard of this book or program
Next by Author: Re: Placing TOC Entries into Separte Hyperlinked Table Cells to Show Links Between Processes
Previous by Thread: RE: Cross Referencing/first timer
Next by Thread: RE: Cross Referencing/first timer


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


Sponsored Ads