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: the theory of x-refs in a modular writing environment
Subject:RE: the theory of x-refs in a modular writing environment From:"Chris Vickery" <cvickery -at- arenasolutions -dot- com> To:"Kevin McGowan" <thatguy_80 -at- hotmail -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 13 Feb 2008 13:54:14 -0800
I am in the same position...my DITA content started as Docbook books
with xrefs. I thought about using Related Links, even in PDF output,
with a Read More About It type of section at the bottom of each topic.
That way, I could define all the links in the map or a relationship
table on a per-deliverable basis.
My understanding of best practices is to remove all xrefs from DITA
content because, as you say, you get hosed when you reuse a topic with
xrefs.
c
-----Original Message-----
From: techwr-l-bounces+cvickery=arenasolutions -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+cvickery=arenasolutions -dot- com -at- lists -dot- techwr-l -dot- com]
On Behalf Of Kevin McGowan
Sent: Wednesday, February 13, 2008 8:10 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: the theory of x-refs in a modular writing environment
Hi all,
A philisophical question for this snowy Wednesday. I'm starting to do a
lot of reuse of my DITA topics through my user guides, training guides,
etc.
I find myself in the position of having to go through and either "fix"
or "remove" a lot of X-references simply because I'm not always sure
which topics will be reused, and where they may end up. I certainly
don't want to build a series of new guides and have broken references
everywhere.
has anyone got any thought on x-refs? Typically, they take the format of
"for more information on Topic A, see "AAA on page 15" and really just
serve as a guide to some extra or related data. Would a thorough Index
be sufficient for readers who may want to read more on a topic?
Cheers,
K
_________________________________________________________________
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 cvickery -at- arenasolutions -dot- com -dot-
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-