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: Question: XML as data-tranfer tool - metadata in DTD
Subject:Re: Question: XML as data-tranfer tool - metadata in DTD From:"Guy K. Haas" <ghaas -at- selectica -dot- com> To:TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 31 Mar 2000 12:38:33 -0800
I want to lay out the DTD to show the programmer what to expect
in the XML string that comes back as the result of a call.
Probably, I can just use "read DTD" to tell them what SOLID things are
coming AND "meta DTD" to show them where MUTABLE things will appear.
Thanks,
g
Tim Altom wrote:
>
> I guess I'm losing track of why you have to describe the DTD at all, unless
> you have to paraphrase it. A DTD is just a text file and anybody who doesn't
> know how to read one probably won't know how to read a representation of
> one, either.
>
> Your question presents a common problem, however, that of what to do when
> the software, manual, or both are highly mutable. You see that a lot,
> especially with enterprise software that can be modified on-site. Most
> companies I'm familiar with supply two manuals: an operations manual for the
> default operations, and an API for how to change things. But WHAT'S changed
> and documenting it is the province of the user, not of the supplier.
>
> Maybe if I could visualize the situation more clearly, I could recommend
> something.
>
> Tim Altom
> Simply Written, Inc.
> Featuring FrameMaker and the Clustar(TM) System
> "Better communication is a service to mankind."
> 317.562.9298
> Check our Web site for the upcoming Clustar class info
>http://www.simplywritten.com
>