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

Re: Friendly names in XML Schema best practice?

• To: "Chiusano Joseph" <chiusano_joseph@b...>
• Subject: Re: Friendly names in XML Schema best practice?
• From: "Jeff Rafter" <jeffrafter@d...>
• Date: Sat, 27 Sep 2003 10:39:53 -0500
• Cc: <xml-dev@l...>
• References: <3F754287.8020604@o...> <01c901c384ff$45c6a8c0$6401a8c0@capernaum> <3F75A839.41892E2E@b...>

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

• References:
  • Attaching information with each Node
    • From: Ramkumar Menon <ram.menon@o...>
  • Friendly names in XML Schema best practice?
    • From: "Jeff Rafter" <jeffrafter@d...>
  • Re: Friendly names in XML Schema best practice?
    • From: "Chiusano Joseph" <chiusano_joseph@b...>

• Prev by Date: Re: Friendly names in XML Schema best practice?
• Next by Date: Re: A Few Thoughts on an Ontology as a Self Organizing System
• Previous by thread: Re: Friendly names in XML Schema best practice?
• Index(es):
  • Date
  • Thread