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: Managing "comments" in XML documents like any other XML conte nt
Subject:RE: Managing "comments" in XML documents like any other XML conte nt From:Jason Willebeek-LeMair <jlemair -at- cisco -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 18 Nov 2003 15:48:17 -0600
-----Original Message-----
From: Scott Abel [mailto:abelsp -at- netdirect -dot- net]
Subject: Managing "comments" in XML documents like any other XML content
I'm trying to make the case for treating code 'comments' written in XML
documents as content....
There are likely to be many benefits of tagging comment content in XML
documents....
But, why exactly? What could we do with it? Has anyone done anything using
this technique? Are you doing it now? And, if so, in what ways has the
ability to manipulate comment data in XML documents helped your
organization?
-----Reply-----
We do that. There are several benefits:
1) we use metadata to track who added the comment and when it was added. We
can run queries against the comments to find old, outstanding comments,
comments made by specific people, etc.
2) we define various views using CSS and xslt to either highlight or hide
the comments
You had a pretty good idea, it seemed, of some of the benefits. There was
one drawback, however. SGML-style comments are ignored by the processors.
These are not, so some times content in the comment tags can get picked up
by a transform if you do not account for it carefully.
RoboHelp for FrameMaker is a NEW online publishing tool for FrameMaker that
lets you easily single-source content to online Help, intranet, and Web.
The interface is designed for FrameMaker users, so there is little or no
learning curve and no macro language required! Call 800-718-4407 for
competitive pricing or download a trial at: http://www.ehelp.com/techwr-l4
---
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.
