[XML-DEV Mailing List Archive Home] [By Thread] [By Date] [Recent Entries] [Reply To This Message]

RE: XML Schema 1.1 Best Practice

• From: "Utzinger, Melissa L." <mutzinger@mitre.org>
• To: "Costello, Roger L." <costello@mitre.org>
• Date: Fri, 12 Nov 2010 04:48:03 -0500

Okay Roger here is one Best Practice to start with...  
 
Best Practice:  Create Structured Annotations

Why:  It makes it easier to apply certain style sheets, cleaner way to document and verify information, enables improved search capabilities, etc.

Recommendation:  Provide an XML Schema which documents and validates your structured annotations.  If you choose to add this idea to the Best Practices, I also recommend we add an example. I recall attempting to insert the xs:schema tag statement which would link the current schema to the structured annotation schema for validation purposes to be a bit challenging. It might help readers if we provided a working example.
 
Does anyone know of a standard which is designed as generic structured documentation?  If there is one, is it extendable?  I was in a few program where they each created their own structured annotation schemas (of course style sheets couldn't easily be reused)...I could provide a sample structured documentation schema for the Best Practices if you like.  Some terms found in that schema, although I'm sure I'm forgetting something, are found below:
 
-Full Name
-Description
-References (i.e. ISO 6133 trigraph)
-Acronym
-Synonym
-Omission (i.e. if this element is missing what does that mean? In the case of Altitude does this mean an Altitude is unknown or there is no Altitude?)
 
I believe there was also a way of specifying if an element was being deprecated, but I’d have to look that up.  Comments?

~Melissa

________________________________________
From: Costello, Roger L.
Sent: Thursday, November 11, 2010 9:40 AM
To: Utzinger, Melissa L.
Subject: RE: XML Schema 1.1 Best Practice

Hi Melissa,

     Either version!

/Roger

-----Original Message-----
From: Utzinger, Melissa L.
Sent: Thursday, November 11, 2010 9:32 AM
To: Costello, Roger L.
Subject: RE: XML Schema 1.1 Best Practice

Roger,

Do they have to be specific to XML version 1.1 or to either versions?

~Melissa