wiki:Help/Schema

ESTEST UR XML Schema

This document contains links and descriptions of the schema specifications of various XML file formats used in ESTEST.

Schemas

alias.xsd
me.xsd
meta.xsd
settings.xsd
them.xsd
ur.xsd
xsearch.xsd

How the UR Schema is Written

The UR XML schema is a simple representation that is designed to store information about the physics of a simulation, information about the computational run of the simulation, and some use generated annotations about either of the aforementioned. These three categories form the top level UR XML tags underneath the document root.

All element tags beneath the three category tags are still subject to change and additions during development. Certain design goals should be kept in mind when editing the UR XML schema,

  1. Whenever possible match the schema defined at quantum-simulation.org, used by Qbox, for tags in ESTEST relating to physical simulation data.
  2. Keep tag names and attributes simple and self-explanatory as much as possible.
  3. Minor changes to the schema manifest larger changes to the xquery infrastructure that comprises the majority of ESTEST's web interface.

Extensible Energy Elements

The children of the <energy> tag are <ecomponent> are distinguished by their name attribute. Whenever possible use standard names already defined such as: total, exchange, kinetic, etc. These shall be considered comparable.

Cross-server Configuration Schemas

XML documents stored in the eXist-db server /db/estest/etc define the interface server and a list of remote ESTEST servers to query when performing searches across servers. The schemas for these XML documents are alias.xsd, me.xsd, them.xsd.

The <alias> element

The alias element describes an ESTEST server. The element data is the domain address of the ESTEST server. In addition, the following attributes carry meta information about the server

  • prefix - A unique string identifier to prefix to remote servers in order to identify them as such in transform scripts. The convention adopted is "#-": "0-", "1-", "2-" etc. The dash character '-' must terminate this string.
  • port - The port configured for the ESTEST web server by Apache. Usually this is port 80 and may be left blank. If the port is specified then the format is port=":#", i.e. port=":39999".
  • proxy - The proxy port configured for the eXist-db server. Usually this is port 8080 and should be specified as proxy=":8080".

meta schema

The meta.xsd schema specifies the document format for plugin description files named meta.xml that contain information such as the plugin name, author(s), and readme that consists of a valid HTML <div> fragment.

settings schema

The settings.xsd schema specifies the document format for user account settings in ESTEST.

xsearch schema

The xsearch.xsd schema specifies the XML document format returned by xsearch.xql that performs the search of the local eXist-db XML database. These XML fragments are collected by the search.xql XQuery transform by the interface ESTEST web server.

Last modified 6 years ago Last modified on 08/25/11 12:35:53