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:<WilliamFLawrence -at- eaton -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 14 Feb 2008 15:20:44 -0500
Tricky, ain't it?
If the Docbook source was set up to be modular, it would have had olinks
instead of xrefs. The olink resolves through a linking database (really
just a link table) that's periodically refreshed. The olink target can
be resolved by document and by position at processing time. Soooooo, if
you really want cross-references between guides the olinks keep
everything up to date (unless of course someone deletes the link target
itself). I'm not sure if you have something similar available to you
via DITA, but I would imagine there is.
If you find that you really want to use inter-document linking, you
could also write an XSLT script that would verify your links, just to
make sure that they all resolve. I've done that a few times. Conversely,
you could create HTML output of some sort and check for broken links
(actually, you should probably have a link-checker integrated in your
build scripting anyway).
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-