DITA - Getting Started

This presentation addresses a low-effort-required solution for users looking to take a step into XML for their technical documentation. The Darwin Information Typing Architecture (DITA) and its associated public toolkit provide you with the DTDs, stylesheets and other tools you require to make your steps into XML.

Kravogel, Christian and Boris Horner. IDEAlliance (2005). Articles>Document Design>XML>DITA

Introduction to DITA References

DITA is quickly becoming the dominant XML schema for topic-oriented authoring. DITA is a highly practical way of moving to XML authoring in general and granular content reuse in particular. DITA distinguishes itself from predecessor standards by explicitly rejecting the book paradigm in favour of a topic-oriented model.

Prescod, Paul. IDEAlliance (2004). Articles>Information Design>XML>DITA

Low-Cost, Flat-File XML for the Masses  

When you hear about XML publishing, you mostly hear about databases, workflow tools, and content management systems. These are typically costly systems aimed towards the information management needs of larger enterprises, where the sheer volume of information pumped through these systems provides a fairly rapid return on investment. This fosters the perception that you need one of these complex, expensive, enterprise solutions to use take advantage of the modularity and flexibility of authoring in XML. That is simply not true. You can realize the benefits of publishing from modularized XML, without the expense of an enterprise publishing system, by implementing the authoring environment on top of nothing more than your operating system's file system. Although this environment is not adequate for enterprise publishing needs, it is more than adequate for the needs small writing teams, businesses with a limited number of related products, proof-of-concept demonstrations, and even home users. The AIC documentation group at Cisco Systems has implemented such an authoring environment. We have been able to reuse and re-purpose modular, XML-based information without implementing a database back end. By examining how the AIC team implemented XML in a flat-file environment, you will see: * the decisions you need to make before implementing a flat-file XML system * the trade-offs, drawbacks, and pitfalls of implementing a flat-file environment (as compared to a database publishing environment) * the benefits of XML that are still available, even without the database * a migration path to a more traditional publishing environment

Willebeek-LeMair, Jason. IDEAlliance (2001). Presentations>Publishing>XML>Writing

Powering Pipelines with JAXP  

The JAXP API allows Java programmers easy access to the power and flexibility of XML parsing and filtering and XSLT transformation. However, while many programmers utilize JAXP for simple XML parsing or single-shot XSLT transformation, going further to construct processing pipelines often proves difficult.

Nichols, Thomas. IDEAlliance (2005). Articles>Information Design>Programming>XML

DITA: The Mechanics of a Single-Sourcing Project

The Darwin Information Typing Architecture (DITA) is an XML-based, end-to-end architecture for authoring, producing, and delivering technical information. This paper describes how DITA-based documentation was implemented at CEDROM-SNi, one of Canada's leading on-line news content aggregators. The project delivers documentation as diverse as user training materials and Web Services reference guides targeted to programmers. We focus on the benefits, how tos, and lessons learned. Technical documentation has its own unique challenges. Its deliverables range from simple reference guides and educational material to complex, multilingual procedure manuals. Critical success factors of a documentation project are numerous and diverse – usability, deadlines, cost, language, delivery media (paper, online) – all of which have their own purpose and challenges. This paper discusses these issues and provides a framework for future DITA projects.

Baril, France. IDEAlliance (2004). Articles>Content Management>Single Sourcing>DITA

Reporting XML Errors: Optimizing the Workflow

The Darwin Information Typing Architecture (DITA) is an XML-based, end-to-end architecture for authoring, producing, and delivering technical information. This paper describes how DITA-based documentation was implemented at CEDROM-SNi, one of Canada's leading on-line news content aggregators. The project delivers documentation as diverse as user training materials and Web Services reference guides targeted to programmers. We focus on the benefits, how tos, and lessons learned. Technical documentation has its own unique challenges. Its deliverables range from simple reference guides and educational material to complex, multilingual procedure manuals. Critical success factors of a documentation project are numerous and diverse – usability, deadlines, cost, language, delivery media (paper, online) – all of which have their own purpose and challenges. This paper discusses these issues and provides a framework for future DITA projects.

Allen, Sarah. IDEAlliance (2004). Articles>Content Management>Workflow>XML

An Approach to Visually Creating and Editing Nested Compound Document

Currently, visual XML structured authoring applications can typically handle a small number of XML vocabularies. In some cases, they can even handle them in limited nested scenarios. One of the purposes of creating XML documents with compound vocabularies is to present related information on a given topic in different manners (tables, charts, etc). The synchronization of views between objects of different vocabularies in real-time editing helps authors realize this potential. In this presentation we will discuss an approach to visually creating, editing and synchronizing, nested compound XML vocabularies within one document. The open nature of the architecture enables developers to create plug-ins for new vocabularies including the ability to define synchronization. Also this architecture provides simple method to define visualization of a new vocabulary by utilizing plug-ins already developed and activated.

Wake, Nobuaki and Junpei Aoki. IDEAlliance (2004). Articles>Document Design>Information Design>XML

UBL and the Colombian Connection

This session provides a realistic tour of the process of implementing and customizing UBL, through the study of our implementation of UBL for the ministries of agriculture and commerce of the Republic of Colombia. Both through general tools (xmlroff as modified by Fabio to support UBL pdf output) and through custom made, open source software, XML-based technologies are effectively bridging the gap of B2B commerce between the United States and the rest of the world. UBL Capture, Presentation, Storage, Transfer software custom made by UBL voting member Fabio Arciniegas is demonstrated and dissected within the context of a real life example of implementation for the colombian government.

Arciniegas, Fabio. IDEAlliance (2004). (Spanish) Articles>Business Communication>XML>Case Studies

Enhanced Interoperability for Security of XML Web Services

Enterprises are adopting Web Services to ease application integration across heterogeneous environments within and across security domain boundaries. Security is an important element for the adoption of Web Services. The Organization for the Advancement of Structured Information Standards (OASIS) has recently ratified the Web Services Security standards (Web Services Security: SOAP Message Security 1.0 (WS-Security 2004 ), Web Services Security: UsernameToken Profile 1.0 , and Web Services Security: X.509 Certificate Token Profile ) to provide an extensible framework for providing message integrity, confidentiality, identity propagation, and authentication. The Web Services Interoperability Organization (WS-I) is profiling standards to provide guidelines for implementation and use of relevant standards to enhance interoperability. This paper describes the activities of the WS-I Basic Security Profile (BSP) Working Group (WG). This Working Group is chartered to improve interoperability of security technologies for Web Services by profiling the OASIS Web Service Security and HTTP Over TLS standards. This interoperability profile (known as the Basic Security Profile 1.0) is an extension of the WS-I Basic Profile . The WS-I Basic Profile addresses interoperability for implementations of core Web Services standards.

Austel, Paula, Michael McIntosh and Anthony Nadalin. IDEAlliance (2004). Articles>Web Design>XML>Security

Using XSL-FO 1.1 for Business-Type Documents

In addition to the powerful features available now, the upcoming XSL-FO 1.1 will bring several new features. In the world of business-type documents, marketing material and forms, there is currently a need for end-of-page subtotals, multiple flows, easier page number citation, things that will be possible with XSL-FO 1.1. This presentation will cover the features of XSL-FO that are needed for this type of documents. Formatting objects and properties of both XSL-FO 1.0 as 1.1 will be covered, as well as how to combine these things to create a good-looking business-type document, because these types of documents need have the perfect layout.

Bals, Klaas. IDEAlliance (2004). Articles>Business Communication>XML>XSL

Coping With Babel: How to Localize XML

Translating XML documents presents many opportunities as well as challenges. There are clear do's and don'ts when it comes to designing your documents regarding translation. You can use also use XML to your advantage to reduce costs and increase quality. One of the most exciting ways to do this is via the use of the XML Text Memory Namespace - xml:tm.

Zydron, Andrzej. IDEAlliance (2004). Articles>Language>Localization>XML

Getting Standards to Emerge, or, How to Build a Recipe Book While Everyone's Busy Cooking

The UK Local e-Government Standards Body was established late in 2003, and tasked with compiling an XML based data standards catalogue for use by UK Local Authorities. This is to be achieved by mapping existing standards, identifying gaps to be filled, advising and supporting local Councils, their partners and suppliers on the interpretation and adoption of standards, and establishing processes for developing new standards as required. However, UK Local Authorities have been developing e-services for several years already, so this new effort has to take place in a context where many projects are already under way, using a variety of business models, and with diverse approaches to XML interoperability design. An additional factor is the traditional tension between central and local government, which has led to patchy and inconsistent adoption of the national UK e-Government Interoperability framework. This paper is an account of the methodology developed by CSW Group Ltd and the LeGSB to tackle this situation.

Harvey, Anna and Ann Wrightson. IDEAlliance (2004). Articles>Information Design>XML>Standards

XML-Native Constraint Evaluation

This paper discusses approaches to validating XML documents for compliance to constraints. Our particular focus is on structural and content constraints that go beyond what is readily expressible in XML Schema technologies. We provide examples and solutions drawn from our specific experience building an XML-native constraint validator based on a mathematical language called Structural Notation (SN) . SN is used to express operational constraints as machine-processible Rules against a particular category of hierarchically structured, text-oriented military messages, called Message Text Formats (MTFs) , which have been migrated to a corresponding XML-based representation.

Malloy Mary Ann, Michael Cokus, Roger Costello, Ed Masek and Dan Winkowski. IDEAlliance (2004). Articles>Information Design>XML

Conflict Resolution in XML - Forms For All

Conflict resolution is required wherever we have multiple concurrent changes to a single information set. In practical terms this applies, for example, to concurrent editing environments, to replicated database instances which are being updated independently, to address-book changes on a PDA that must be merged into a master database that has itself been changed. Resolving these conflicts very often requires human intervention. This paper looks at the use of XML forms of various types to reduce the drudgery involved and to take advantage some of the greatest strengths of XML, using pipelining and easily-understood representations to allow a decision-maker to work with minimal drag.

Nichols, Thomas, Nigel Whitaker and Robin La Fontaine. IDEAlliance (2004). Articles>Information Design>XML>Forms

Visually Modelling Business Processes

Learn how to visually design and implement process definitions using BPSS V2 including the use of context mechanisms and workflows, signals and joins. A selection of sample industry and government applications will be provided from automotive, financial, homeland security and healthcare applications.

Webber, David. IDEAlliance (2004). Articles>Business Communication>Technical Illustration>Workflow

The Benefits of ebXML for e-Business

The ebXML specifications have matured rapidly over the past year. New components and capabilities have extended the architecture for service oriented architectures (SOA). Learn about this new comprehensive release of ebXML that is available from OASIS.

Webber, David. IDEAlliance (2004). Articles>Information Design>Business Communication>XML

Building an XPath-Powered Framework for XML Data Processing

As XML formatted content and data becomes pervasive on intranets and the Internet the requirement to minimize individual process times becomes great. XPath has been evolving into a rich expression language to query and extract data in a precise way. While it has been designed to be used by a host language such as XSLT and XQuery, an XPath processor can be used quite usefully standalone or as part of an application framework.

Scardina, Mark and Jinyu Wang. IDEAlliance (2004). Articles>Information Design>XML>XSL

Alternatives to Formatting XML Editors for Creating Structured Information

XML editors have traditionally been modeled after the first SGML editor written in 1985, a long time before creating, managing, and distributing structured information was well understood. Now, nearly 20 years later, there are more choices for users interested in creating structured information. Specifically, this presentation discusses alternatives that include Web-based distributed collaborative XML document creation, "tag-free" tools, non-formatting structured editors, and even using common office tools in creating your XML documents.

Daldt, Dale. IDEAlliance (2004). Articles>Software>Information Design>XML

Using RDF for Knowledge Management

Using new tools, RDF can be used for knowledge management, maintaining all the data’s relations, automatically building tables for RDBMS deployment, and supporting graphical navigation, multiple navigation trees, and linking across diverse content sets.

Sperberg, Roger and Rajeev Voleti. IDEAlliance (2004). Articles>Knowledge Management>XML>Metadata

Enterprise XML in Government Regulatory and Legislative Agencies

This presentation is based on a deployed enterprise system designed and integrated to support over 250 plus users for a west coast legislature. The system includes legislative authoring, legislative processing (Introducing, Amending, Enrolling, and Chaptering Bills), document publishing, and updating the State laws.

Vergottini, Grant. IDEAlliance (2004). Articles>Content Management>Government>XML

Document Model Selection: Off-the-Shelf, Altered-to-Fit, or Bespoke?

Document Model selection is a key success factor in XML. Approaches include: adopting an existing model, modifying a model to meet your needs, and creating one to meet your needs. Advantages and disadvantages of each are discussed.

Usdin, B. Tommie. IDEAlliance (2004). Articles>Information Design>Standards>XML

Lessons from the Front Line: Building Interoperable Web Services

The ability to interoperate across disparate vendors, platforms and infrastructure stacks is inherently important to the adoption of Web Services technology. For most organizations, cross platform interoperability and the move to a loosely coupled, Service Oriented Architecture (SOA) is usually the main rationale for adoption of the underlying Web Service technologies. In this paper we will discuss some of the issues and stumbling blocks towards interoperability. We will also demonstrate with an example, how an application developed in Java and deployed in a J2EE 1.4 compatible container can interoperate and be consumed from a different client, developed in C# on the .NET platform.

Tyagi, Sameer. IDEAlliance (2004). Articles>Web Design>XML>Case Studies

Accommodating XML 1.1 in XML Schema 1.0

As published the W3C XML Schema specification references XML 1.0 explicitly, and incorporates by reference certain key definitions, in particular those of the 'Char', 'Name' and 'S' character classes. XML 1.1 changes the contents of these classes, so although nothing in the existing XML Schema specification specifically bars infosets produced by XML 1.1 conformant parsers, such infosets, if they exploit any of the relevant changes in XML 1.1, will not be accepted as valid by conformant XML Schema 1.0 processors.

Thompson, Henry S. IDEAlliance (2004). Articles>Information Design>Standards>XML