OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

 


 

   Re: [xml-dev] Friendly names in XML Schema best practice?

[ Lists Home | Date Index | Thread Index ]

Hi Joe,

This is a great answer and does indicate a clear best practice (especially
for those of us in the U.S.) for naming elements-- however I was looking for
one level further in terms of abstraction. Although

OfficeAddressCityText

Is abundantly clear to me-- I have seen some users on the verge of nervous
breakdown when the spaces disappear. Within your response I also see that
you use initial-cap casing in the string. Perhaps it is reliable enough to
pick the string apart and insert spaces, though something like

WWWAddressText

Would surely create problems with that. I think what I was looking for
something a step further (which does not preclude your points). e.g.

  <xs:element name="OfficeAddressCityText" >
    <xs:annotation>
      <xs:appinfo>
        <friendly xml:lang="en-US">Office City Location</friendly>
      </xs:appinfo>
      <xs:documentation>
        The city where the office is located
      </xs:documentation>
    </xs:annotation>
  </xs:element>

Obviously in this sample there is a lot of redundancy-- but that wouldn't
always be the case.

Also, as another possiblity has anyone made it a practice to decorate XML
Schemas (or RELAXNG, etc.) with RDF attributes for documentation/friendly
name purposes?

Thanks again,
Jeff Rafter





 

News | XML in Industry | Calendar | XML Registry
Marketplace | Resources | MyXML.org | Sponsors | Privacy Statement

Copyright 2001 XML.org. This site is hosted by OASIS