Literate Documentation for XML Schema

The Certificate of Advanced Study Project of Kevin Reiss at the Graduate School of Library and Information Science at the University of Illinois at Urbana-Champaign.

Thursday, September 07, 2006

Project Notes and Outline

Detailed Project Outline (Unfinished)

The major hole in this document is the identification of some instructive examples from real-world document instances, schemas, and documentation from XML applications. I hope to identify some shortly to help guide the creation of the project demonstration application.

The Document Types I'm looking at are:
  1. METS
  2. Atom
  3. OAI-PMH
  4. Open Office Document Format
  5. XHTML/TEI/Docbook - in order to provide a document centric example
I also need to develop a much more fully realized discussion of how this system relates to other proposals to deal with semantics and XML.

I also need more discussion regarding the capabilities of the TEI One Document Does it All (ODD) literate programming system as a documentation tool for important semantic characteristics of XML.

Proposed Application Sketch

Use the TEI existing Tagset Documention (Chapter 27 of the Guidelines) as the Base of the application. Extend this to support the general purpose authoring of XML schema using the ODD format. This extension will contain the prescribed DSS elements outlined in the Project Outline.

The major component of this will be structured natural language prose that clearly describes the semantics of the markup language. This extension will also involve modifying the TEI sytlesheet package to make sure that well-formatted documentation for the extensions to the ODD will created.

Several Extreme Papers from this year's conference seemed highly relevant to this project. I plan to give these more thorough review. They are:

Implementing XML Schema Naming and Design Rules

A Natural Language Approach to Modeling: Why is some XML so difficult to write?

0 Comments:

Post a Comment

<< Home