SIL logo See Text Menu

XSEM: Documentation

Level 1 Release, 2001-05-03

One feature that was designed into XSEM was its self-contained Documentation. Doing it this way allows us to view the documentation from several different perspectives. This page will explain what different types of views are available.


Contents
Home Goto Top
Main View
Schema View
DTD View
Diagrams

The Bible is a very complex piece of literature. XSEM has attempted to capture all its different facets and create a markup environment that is flexible but at the same time stable and predictable. Much of this stability and flexibility is inherent in XML but XSEM takes some rather unique approaches to solving some structural conflicts found in the way Bibles are published today.

XSEM is for software developers and is not meant for common, everyday computer users. It will be implemented in various software packages and publishing systems that SIL is planning to do. However, for a software developer to know how to implement it he or she will need know more about it. That is the purpose of this documentation set.

Database query languages add a powerful dynamic to viewing information contained in a given database. In many ways a text file, marked up in XML, is like a database. With the flexibility of XSL (XML Stylesheet Language) we can perform a kind of database query on a given body of XML text. XSEM is a W3C compliant XML Schema. There have been several different stylesheets developed for XSEM to render the XML content of it into several different views. These different views will hopefully help developers gain greater understanding of XSEM's structure and how Biblical text can be marked up using this system.

Go to Top Main View

XSEM contains an extensive collection of examples and graphical illustrations that help developers understand how it is implemented. The Main View compilation of these examples and illustrations are in a format that we hope will be useful for general development purposes. Click on this link to see the Main View.

Go to Top Schema View

The XSEM Schema View also contains examples and graphical illustrations such as in the Main View. However, it is arranged and formatted in such a way as to more closely represent the actual internal structure of the schema it was derived from. Also, it shows documentation for the various elements and how they are represented in the schema notation. If you are a developer that really wants to know more about the what the XSEM "source code" looks like please click here to open the Schema View documentation.

Go to Top DTD View

For many who are familiar with SGML, the standard which XML is derived from, XML Schema can be a very daunting form of data structure notation. Many prefer to see data structure expressed in a DTD (Document Type Definition) type notation. In addition to this, The DTD notation is still a very valid form and has not yet been superceded by the XML Schema standard. For this reason we have provided a view of XSEM in a DTD format. In this format you can study its structure and the various dependences expressed in it in DTD notation. To see this view please click here to see the DTD View.

Go to Top Diagrams

Trying to gain an understanding of a data structure simply through documentation of its source code is often difficult. XML is well represented in a graphical tree structure. Producing documentation of this nature is not possible with common XSL. However, through the use of an XML developer's tool we have been able to produce a graphical representation of XSEM's tree structure. This is probably the easiest way to become familiar with the overall structure of XSEM. Please click here to see the XSEM Diagrams page.


[ XSEM | Computing | SIL Home ]

Created: 20-Aug-2001
Modified: 26-Aug-2001
URL: http://www.sil.org/computing/xsem/documentation/documentation.html
Contact: Dennis Drescher

Copyright © 2001—SIL International