Re: Managing "comments" in XML documents like any other XML content

Subject: Re: Managing "comments" in XML documents like any other XML content
From: "Mike O." <obie1121 -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 13 Nov 2003 09:48:49 -0500

Scott Abel wrote:
> I'm trying to make the case for treating code 'comments' written in XML
> documents as content. That is, I want to tag comments with a <comment>
> element instead of "commenting it out" using the SGML comments notation
> <!--comment goes here--!>.
> There are likely to be many benefits of tagging comment content in XML
> documents. The ability to sort, filter, and otherwise manage them seem to
> logical benefits.
> 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?
> I'm hoping to locate articles about comment tagging (as well as feedback
> from list members) that I can use to create a business case for adopting
> approach that ensures comments in XML documents are managed in a way that
> beneficial to the business.

It depends. What are you using comments for now? (what type of information
are you storing in the comments?) In general, yes, if you find yourself
exploiting the comment feature to carry data, then you need to add a new
tag. But in the spirit of XML, you'd need to create a different comment tag
for each type of comment you want to store, depending on the purpose of the

Mike O.



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:

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 for more resources and info.

Previous by Author: Re: How good is OCR?
Next by Author: Re: An urban legend regarding documentation?
Previous by Thread: Re: Managing "comments" in XML documents like any other XML content
Next by Thread: pdf software

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

Sponsored Ads