[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Notation for XML nested tags?

Subject: Re: Notation for XML nested tags?
From: "Mike O." <obie1121 -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 19 May 2004 16:26:35 -0400


Stevenson, Rebecca wrote:

I am documenting a mess of XML stuff right now for
> an audience that is not necessarily savvy in the topic.
> Something I was thinking of doing was trying to capture
> in the text the relationship between nested tags. If tag
> foo is always used inside tag bar,

when I refer to tag foo I wanted to mention bar so my users
> keep the relationship in mind as they make their changes to the file.

1) Is this a dumb idea?
2) Is there a standard way of noting these relationships as there is for code? foo.bar, or something?

Sounds like you want to refer to the full "path" to each tag every time you mention it in your document. This would produce a lot of visual clutter in the text.

Also, what if foo may be contained in multiple tags? Think <p> or <a> tags in HTML - how would you note the container tags for those?

IMHO I would provide a brief overview of XML concepts, explaining how some tags are required, and some tags must be contained by others, etc. Then provide a tag reference that documents all the relationships; for example see the DocBook tag reference:

http://docbook.org/tdg/en/html/part2.html

Mike O.


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo
From a single set of Word documents, create online Help and printed
documentation with ComponentOne Doc-To-Help 7 Professional, a new yearly
subscription service offering free updates and upgrades, support, and more.
http://www.doctohelp.com

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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.


Previous by Author: Re: Drop term "user's guide"?
Next by Author: Re: XML app
Previous by Thread: Re: Notation for XML nested tags?
Next by Thread: Submitting PDF form

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads