Question

I prefer to have my XML documents structured in the following way:

<root>
   <node info1="blah" info2="blah" />
   <node info1="blah" info2="blah" />
</root>

Instead of:

<root>
   <node>
      <info1>blah</info1>
      <info2>blah</info2>
   <node>
   <node>
      <info1>blah</info1>
      <info2>blah</info2>
   <node>
</root>

I think this makes things easier to read and makes navigation simpler. Are there any reasons that the second example would be better? Is it same to assume my structure is better?

Obviously if there is a one to many relationship in the data I have no problem moving it to it’s own child node.

Answer 1

I like the attributes in the interest of brevity and expressiveness.

I would go with the sub node in the following cases:

• When I anticipate the sub node to have its own additional information. Ex: if info1 happens to be (or potentially can become) a structure rather than a simple type.
• Let us say info1 is a SQL statement or a script or one of those things that require a lot of escape sequences. Then it is cumbersome to write that as an attribute. Far easier to make it a sub node so that you can benefit from the [!CDATA[ syntax.

Sometimes, in my configuration files I support both syntaxes so that the author of the configuration file can make the decision to use one of them as they deem appropriate.