XML Naming Conventions

  • Thread starter Thread starter clintonG
  • Start date Start date
C

clintonG

Does the use of DTD, XML Schema and similar constructs adopt
the use of C# naming conventions? If so how do I make the distinction
of how to apply C# conventions with XML elements, attributes and so
on? Any referrals to resources that discuss or document XML Naming
Conventions?
 
W3C.ORG publishes the XML standards. If you're talking about an XML
document, and naming tags (nodes) and attributes in particular, the naming
convention depends on what you're trying to do. For general purpose stuff,
you can make up your own. If you're trying to implement functionality
through an XML-based standard (like SOAP) there are specific guidelines and
structures (SOAP standards are also published by W3C on their website).

Thanks,
Michael C., MCDBA
 
Hello Michael,

I am well aware of W3C and work with their standards. As a result
of that awareness I happened upon a linked comment that alleged the
W3C had defined naming conventions but the link only resolved to the
W3C 'home page' and after rooting around at the W3C site regardless
I was not able to locate any specific naming conventions in the context
I was expecting and hoping to find as those published by Microsoft's
..NET Framework General Reference Naming Guidelines [1].

To help clarify, I have read comments that compared the declaration
of XML elements to classes and class members and so on. I'd like to
learn more about how to think when defining and declaring XML
elements that may correlate to class definitions.

For example, I know XML is case sensitive but when I name XML
elements by which naming guideline am I motivated to declare an
element, as book, Book, bookStore or BookStore and how may
the declaration and its child elements correlate to any named counterpart
which may exist in my code when used to parse and process the XML?

The Visual Studio Coding Techniques [2] is helpful but does not
make the corrolary with XML elements.

Searching MSDN has not turned up anything specific in the context
I am attempting to convey.

In a nutshell, I want to learn if it is a correct perception that a well
designed XML schemata naming convention can be thought of as
equivalent to that of designing a class library and if so how to correlate
the constituent XML elements and child decedants by name to
class library counterparts?

Clear as mud :-)

--
<%= Clinton Gallagher, "Twice the Results -- Half the Cost"
Architectural & e-Business Consulting -- Software Development
NET (e-mail address removed)
URL http://www.metromilwaukee.com/clintongallagher/

[1]
http://msdn.microsoft.com/library/d...en-us/cpgenref/html/cpconNamingGuidelines.asp
[2]
http://msdn.microsoft.com/library/d...y/en-us/vsent7/html/vxconcodingtechniques.asp
 
Apart from the standard naming rules (don't start element names with "xml",
element names can't contain spaces, yadda yadda), the naming conventions are
pretty much set by the application you're using. If you're asking whether
you should prefix elements that are supposed to contain int values with
"int", that's pretty much your choice, unless the particular protocol or
application you're using dictates differently. The only addition I would
make is that personally I try to stay away from using custom element names
that are the same as commonly used tags in other protocols (i.e., using a
<title> tag). I've heard of people having issues with using HTML-type tag
names when they are using HTTP. In fact, that's one of the reasons the
soap: namespace was added to the SOAP standard... to avoid conflicts like
this.

If you want to know how .NET converts your object names to XML elements,
serialize some of them and look at the resultant XML docs.

Thanks,
Michael C., MCDBA

clintonG said:
Hello Michael,

I am well aware of W3C and work with their standards. As a result
of that awareness I happened upon a linked comment that alleged the
W3C had defined naming conventions but the link only resolved to the
W3C 'home page' and after rooting around at the W3C site regardless
I was not able to locate any specific naming conventions in the context
I was expecting and hoping to find as those published by Microsoft's
.NET Framework General Reference Naming Guidelines [1].

To help clarify, I have read comments that compared the declaration
of XML elements to classes and class members and so on. I'd like to
learn more about how to think when defining and declaring XML
elements that may correlate to class definitions.

For example, I know XML is case sensitive but when I name XML
elements by which naming guideline am I motivated to declare an
element, as book, Book, bookStore or BookStore and how may
the declaration and its child elements correlate to any named counterpart
which may exist in my code when used to parse and process the XML?

The Visual Studio Coding Techniques [2] is helpful but does not
make the corrolary with XML elements.

Searching MSDN has not turned up anything specific in the context
I am attempting to convey.

In a nutshell, I want to learn if it is a correct perception that a well
designed XML schemata naming convention can be thought of as
equivalent to that of designing a class library and if so how to correlate
the constituent XML elements and child decedants by name to
class library counterparts?

Clear as mud :-)

--
<%= Clinton Gallagher, "Twice the Results -- Half the Cost"
Architectural & e-Business Consulting -- Software Development
NET (e-mail address removed)
URL http://www.metromilwaukee.com/clintongallagher/

[1]
http://msdn.microsoft.com/library/d...en-us/cpgenref/html/cpconNamingGuidelines.asp
[2]
Click to expand...
http://msdn.microsoft.com/library/d...y/en-us/vsent7/html/vxconcodingtechniques.asp


Michael C said:
W3C.ORG publishes the XML standards. If you're talking about an XML
document, and naming tags (nodes) and attributes in particular, the naming
convention depends on what you're trying to do. For general purpose stuff,
you can make up your own. If you're trying to implement functionality
through an XML-based standard (like SOAP) there are specific guidelines and
structures (SOAP standards are also published by W3C on their website).

Thanks,
Michael C., MCDBA
Click to expand...
Click to expand...
 
Back
Top