Welcome!

Industrial IoT Authors: Elizabeth White, Stackify Blog, Yeshim Deniz, SmartBear Blog, Liz McMillan

RSS Feed Item

RE: XML Design Guidelines for Facilitating the Creation and Pr

The best advice I have comes from Dr. Charles Goldfarb:  Conserve nouns.

It's a challenge of resolution over reference space complexity. 

Even if processed, humans use the output.  As in behavioral programming
(interactive document design vs compounding), program back from the end
states of the uses of the document.   

Are the uses the reason for compounding?  IOW, is the compounding a result
of interactive screen design or printed forms?

Why compounds?

len


From: Costello, Roger L. [mailto:[email protected]] 


Hi Folks,

What guidelines would you recommend to someone who: 

   - wants to create an XML vocabulary, 

   - that will be combined with other XML vocabularies to create a compound
instance document, 

   - which will be processed by applications?

In other words, what XML designs will facilitate the creation and processing
of compound documents?

Below is a list of guidelines that I have come up with. Are there other
guidelines that you recommend?  


----------------------------------------------
   GUIDELINES FOR FACILITATING THE
      CREATION AND PROCESSING
       OF COMPOUND DOCUMENTS
---------------------------------------------- 

Namespaces are key to creating compound documents that can be effectively
processed. Applications can partition compound documents along the lines
identified by namespaces, thus enabling module-specific processing.


1. When designing a schema, associate the XML vocabulary it creates with a
namespace. Thus the first guideline is to identify each XML vocabulary via a
namespace. Here's an example of a Book XML vocabulary identified by the
http://www.book.org namespace: 


    <Book xmlns="http://www.book.org">
         <Title>Illusions</Title>
         <Author>Richard Bach</Author>
         <Date>1977</Date>
         <ISBN>0-440-34319-4</ISBN>
         <Publisher>Dell Publishing Co.</Publisher>
    </Book>

Conversely, do not identify the XML vocabulary by embedding a unique
identifier inside an element or attribute. Here's an example of the Book XML
vocabulary identified using a GUID embedded inside an element: 

    <Book>
         <Identifier>fc48ee30-0a6b-11de-8c30-0800200c9a66</Identifier>
         <Title>Illusions</Title>
         <Author>Richard Bach</Author>
         <Date>1977</Date>
         <ISBN>0-440-34319-4</ISBN>
         <Publisher>Dell Publishing Co.</Publisher>
    </Book>


2. If the schema language used to create the XML vocabulary provides the
option of namespace-qualifying all elements or namespace-qualifying only
global elements, choose the former. For example, the W3C XML Schema language
allows you to specify "all elements must be qualified in the instance
document" by setting:

    elementFormDefault="qualified"

Conversely, it allows you to specify "only qualify globally declared
elements in the instance document" by setting:

    elementFormDefault="unqualified"

Don't use the latter as it destroys the value of namespaces. Instead, use
the former as it maximizes the value of namespaces.


3. Use standard filename suffixes: .xsd (W3C XML Schema), .rng (ISO RELAX
NG), .sch (ISO Schematron), .dtd (W3C DTD). Although it is technically
accurate to, say, suffix an XML Schema file with .xml, it is preferable to
use .xsd as the latter enables applications to more easily recognize an XML
vocabulary's schema language.


4. Design your schema maximizing the use of globally declared elements. Each
globally declared component is a potential compound document component. For
example, with this schema both BookStore and Book can be used as a component
in a compound document:

    <element name="BookStore">
        <complexType>
            <element ref="Book" maxOccurs="unbounded" />
        </complexType>
    </element>

    <element name="Book"> ... </element>

Conversely, this schema only allows BookStore to be used as a component in a
compound document: 

    <element name="BookStore">
        <complexType>
            <element name="Book" maxOccurs="unbounded"> ... </element>
        </complexType>
    </element>


What else would you add to this list?

/Roger
_______________________________________________________________________

XML-DEV is a publicly archived, unmoderated list hosted by OASIS
to support XML implementation and development. To minimize
spam in the archives, you must subscribe before posting.

[Un]Subscribe/change address: http://www.oasis-open.org/mlmanage/
Or unsubscribe: [email protected]
subscribe: [email protected]
List archive: http://lists.xml.org/archives/xml-dev/
List Guidelines: http://www.oasis-open.org/maillists/guidelines.php


Read the original blog entry...

IoT & Smart Cities Stories
Digital Transformation and Disruption, Amazon Style - What You Can Learn. Chris Kocher is a co-founder of Grey Heron, a management and strategic marketing consulting firm. He has 25+ years in both strategic and hands-on operating experience helping executives and investors build revenues and shareholder value. He has consulted with over 130 companies on innovating with new business models, product strategies and monetization. Chris has held management positions at HP and Symantec in addition to ...
Dynatrace is an application performance management software company with products for the information technology departments and digital business owners of medium and large businesses. Building the Future of Monitoring with Artificial Intelligence. Today we can collect lots and lots of performance data. We build beautiful dashboards and even have fancy query languages to access and transform the data. Still performance data is a secret language only a couple of people understand. The more busine...
DXWorldEXPO LLC announced today that Big Data Federation to Exhibit at the 22nd International CloudEXPO, colocated with DevOpsSUMMIT and DXWorldEXPO, November 12-13, 2018 in New York City. Big Data Federation, Inc. develops and applies artificial intelligence to predict financial and economic events that matter. The company uncovers patterns and precise drivers of performance and outcomes with the aid of machine-learning algorithms, big data, and fundamental analysis. Their products are deployed...
All in Mobile is a place where we continually maximize their impact by fostering understanding, empathy, insights, creativity and joy. They believe that a truly useful and desirable mobile app doesn't need the brightest idea or the most advanced technology. A great product begins with understanding people. It's easy to think that customers will love your app, but can you justify it? They make sure your final app is something that users truly want and need. The only way to do this is by ...
The challenges of aggregating data from consumer-oriented devices, such as wearable technologies and smart thermostats, are fairly well-understood. However, there are a new set of challenges for IoT devices that generate megabytes or gigabytes of data per second. Certainly, the infrastructure will have to change, as those volumes of data will likely overwhelm the available bandwidth for aggregating the data into a central repository. Ochandarena discusses a whole new way to think about your next...
CloudEXPO | DevOpsSUMMIT | DXWorldEXPO are the world's most influential, independent events where Cloud Computing was coined and where technology buyers and vendors meet to experience and discuss the big picture of Digital Transformation and all of the strategies, tactics, and tools they need to realize their goals. Sponsors of DXWorldEXPO | CloudEXPO benefit from unmatched branding, profile building and lead generation opportunities.
Cell networks have the advantage of long-range communications, reaching an estimated 90% of the world. But cell networks such as 2G, 3G and LTE consume lots of power and were designed for connecting people. They are not optimized for low- or battery-powered devices or for IoT applications with infrequently transmitted data. Cell IoT modules that support narrow-band IoT and 4G cell networks will enable cell connectivity, device management, and app enablement for low-power wide-area network IoT. B...
The hierarchical architecture that distributes "compute" within the network specially at the edge can enable new services by harnessing emerging technologies. But Edge-Compute comes at increased cost that needs to be managed and potentially augmented by creative architecture solutions as there will always a catching-up with the capacity demands. Processing power in smartphones has enhanced YoY and there is increasingly spare compute capacity that can be potentially pooled. Uber has successfully ...
SYS-CON Events announced today that CrowdReviews.com has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5–7, 2018, at the Javits Center in New York City, NY. CrowdReviews.com is a transparent online platform for determining which products and services are the best based on the opinion of the crowd. The crowd consists of Internet users that have experienced products and services first-hand and have an interest in letting other potential buye...
When talking IoT we often focus on the devices, the sensors, the hardware itself. The new smart appliances, the new smart or self-driving cars (which are amalgamations of many ‘things'). When we are looking at the world of IoT, we should take a step back, look at the big picture. What value are these devices providing. IoT is not about the devices, its about the data consumed and generated. The devices are tools, mechanisms, conduits. This paper discusses the considerations when dealing with the...