Skip to main content

XML Naming Conventions (Best Practices)

XML is the base of Web 2.0 development. While writing a web service to integrate products, I learned some best practices with XML naming conventions.

An XML element is everything from (including) the element's start tag to (including) the element's end tag.

An element can contain other elements, simple text or a mixture of both. Elements can also have attributes.

<bookstore>
<book category="CHILDREN">
<author>J K. Rowling</author>
<year>2005</year>
<price>29.99</price>
</book>
<book category="WEB">
<author>Erik T. Ray</author>>
<year>2003</year>
<price>39.95</price>
</book>
</bookstore>>

In the example above, and have element contents, because they contain other elements. has text content because it contains text.

In the example above only has an attribute (category="CHILDREN").

XML Naming Rules

XML elements must follow these naming rules:

1. Names can contain letters, numbers, and other characters
2. Names cannot start with a number or punctuation character
3. Names cannot start with the letters xml (or XML, or Xml, etc)
4. Names cannot contain spaces

Any name can be used, no words are reserved.

Best Naming Practices

1. Make names descriptive. Names with an underscore separator are nice: , .
2. Names should be short and simple, like this: not like this: .
3. Avoid "-" characters. If you name something "first-name," some software may think you want to subtract name from first.
4. Avoid "." characters. If you name something "first.name," some software may think that "name" is a property of the object "first."
5. Avoid ":" characters. Colons are reserved to be used for something called namespaces (more later).
6. XML documents often have a corresponding database. A good practice is to use the naming rules of your database for the elements in the XML documents.
7. Non-English letters like éòá are perfectly legal in XML, but watch out for problems if your software vendor doesn't support them.

Reference : http://www.w3schools.com/xml/xml_elements.asp

Comments

Popular posts from this blog

Drools - An overview

For Java based applications the most challenging part has always been the business logic maintenance, and pick any applications which you find complex and if we ask ourself how complex it would be moving forward, the answer will always be nX times.

What do we do ? Drools comes for Rescue as a Rule Engine.

Drools provides mechanism:

a. To write business logic in simple english language
b. Easy to maintain and very simple to extend
c. Reusability of logic by defining keywords in a DSL file and using them in DSLR file.

But be careful nothing comes free, everything takes cost in terms of memory and time space.

Use Drools if you really have :

a. Business logic which you think is getting cluttered with multiple if conditions because of variety of scenarios
b. You will have growing demand of increase in the complexity
c. The business logic changes would be frequent (1 - 2 times a year would also be frequent)
d. Your server's have enough of memory as it is a memory hungary tool, it provi…

MQTT - Eclipse Paho integration for Android

For MQTT integration, recently explored Paho Android project, very simple to use, here are the steps:

Intialize a client, set required options and connect.

    MqttAndroidClient mqttClient = new MqttAndroidClient(BaseApplication.getAppContext(), broker, MQTT_CLIENT_ID);
    //Set call back class
    mqttClient.setCallback(new MqttCallbackHandler(BaseApplication.getAppContext()));
    MqttConnectOptions connOpts = new MqttConnectOptions();
    IMqttToken token = mqttClient.connect(connOpts);


Subscribe to a topic.

    token.setActionCallback(new IMqttActionListener() {
      @Override
      public void onSuccess(IMqttToken arg0) {
           mqttClient.subscribe("TOPIC_NAME" + userId, 2, null, new IMqttActionListener() {
                @Override
                public void onSuccess(IMqttToken asyncActionToken) {
                    Log.d(LOG_TAG, "Successfully subscribed to topic.");
                }

                @Override
                public void onFailure…

Mobile Testing

Mobile application testing falls into broadly two types:

Hardware Testing This includes testing internal hardware, screen size, resolution, space, camera, Bluetooth, WIFI etc.
Software or Application Testing This includes testing the application that are running on device. Because of types of apps this can be divided into following categories: Native appsMobile web appsHybrid apps There are some key things to be considered when testing mobile apps: Native apps have single platformNative apps are written in platforms like SDKs while Mobile web are written in html, cssNative/Hybrid apps may or may not require internet connectionMobile web apps require internet connectionNative/Hybrid apps are downloaded from playstoreMobile web apps are accessible from internet Mobile Testing complexity in comparison web applications Different range of mobile devices, screen sizes etc.Various manufactures customizationsOS types iOS, Android, Windows etc.Different versions of OS e.g. Android 4.x, 5.x, 6.x, 7.x…