Tree [2327d9] default tip /
History



File Date Author Commit
src 2008-08-07 Paul Turner Paul Turner [2327d9] Import of initial take on a XML file validation...
AUTHORS 2008-08-07 Paul Turner Paul Turner [2327d9] Import of initial take on a XML file validation...
COPYING 2008-08-07 Paul Turner Paul Turner [2327d9] Import of initial take on a XML file validation...
ChangeLog 2008-08-07 Paul Turner Paul Turner [2327d9] Import of initial take on a XML file validation...
Makefile.am 2008-08-07 Paul Turner Paul Turner [2327d9] Import of initial take on a XML file validation...
README 2008-08-07 Paul Turner Paul Turner [2327d9] Import of initial take on a XML file validation...
bootstrap 2008-08-07 Paul Turner Paul Turner [2327d9] Import of initial take on a XML file validation...
configure.ac 2008-08-07 Paul Turner Paul Turner [2327d9] Import of initial take on a XML file validation...

Read Me

CEXMLValidator 0.1.0
Command line tool to validate CEGUI XML data files.

Copyright ©2008 The CEGUI Development Team & Contributing Authors

Introduction
============
Crazy Eddie's GUI System uses XML files as it's primary data file type, and
supports the use of various external XML parser libraries in order to get the
data from the XML files into a form that can be used internally.  While CEGUI
comes with a set of .xsd schema files that describe what the 'correct' format
is for these XML files, with the exception of the Xerces C++ parser, the
supported XMl parser libraries are not able to use these files to perform
validation - this has left the data files open to much abuse and / or
misunderstanding.

Many developers prefer to use a more lightweight XML parser, and so develop
and deploy their applications without the benefit of the validation that
the Xerces C++ XML parser is able to perform.

CEXMLValidator attempts to bridge the gap somewhat, by providing a tool that
uses Xerces c++ to perform validation outside of the normal CEGUI environment,
thus enabling developers to continue not to use Xerces C++ with CEGUI, but still
have a means to easily validate their XML data files.


Usage
=====
The CEXMLValidator executable accepts one or more filenames as arguments, each
file specified is validated against an internal copy of the .xsd schema for the
type of file being examined - file types are established by the file extension
in use, as follows:
+------------------+-----------------+
|   File Type      |    Extension    |
+------------------+-----------------+
| CEGUI Config     | .config or .cfg |
| Font             | .font           |
| Imageset         | .imageset       |
| GUI Layout       | .layout         |
| LookNFeel (skin) | .looknfeel      |
| GUI Scheme       | .scheme         |
+------------------+-----------------+
NB: Other, unrecognised, file types are skipped.

CEXMLValidator will output any parsing and / or validation issues with the input
file(s) to the standard output.


Other Documentation
===================
See also the following files:
COPYING   - Contains the license terms for using the application.
AUTHORS   - Contains a list of authors and contributors.
ChangeLog - Contains a list of changes made between releases.

For the very latest information and help, visit the project home page at
http://www.cegui.org.uk.


Supported Systems
=================
CEXMLValidator is currently known to compile and run on the following systems:

* Various flavors of Linux using gcc.

It is very possible that the system will compile and run on other systems and
compilers, though the above systems have been tested.


Requirements
============
As well as one of the above supported systems, CEXMLValidator also requires
the use of some third party external libraries.  These libraries are as
follows:

* Xerces-C++ XML parser (http://xml.apache.org/xerces-c/)