Re: XML tag usage question
In defining an XML tag, you usually use the word "attribute" to describe a defined field within an element. My guy is using the word "prop", short for property. I believe that readers familiar with XML (which will be many of them) might be confused by our renaming of a familiar term. However, if I change "prop" to "attribute" throughout the paper, I must do so in every other paper written by the software department, and that's a lot of papers.^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Should I change the word "prop" to "attribute" throughout the documents, or should I go ahead and accept this unfamiliar usage, possibly with a "disclaimer" or "definition" at the start of each chapter? The first benefits my readers, the second my client. Any thoughts?
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content delivery. Try it today!. http://www.webworks.com/techwr-l
Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at http://www.componentone.com/TECHWRL/DocToHelp2005
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
To unsubscribe send a blank email to techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com
To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.
XML tag usage question: From: siliconwriter
Search our Technical Writing Archives & Magazine