> > After looking at the example xml document for the MEG detector I would like to make the following suggestion.
> > Only a small portion of the power of XML is used with the MEG example i.e., the ability to express the data as a
> > hierarchical tree. Missing is the powerful feature of XML to establish a schema for the XML document specific
> > to ROME that enforces a valid structure.
> >
> > XML uses the XML Schema language, which is in turn based on XML, to define a schema for a document. I
> > propose that a ROME schema be developed that defines an XML document that the ROME builder can read
> > and process. By having such a schema, general purpose XML editors can validate the XML document prior to
> > invoking the ROME builder. Thus the schema greatly simplifies a user's task of developing a ROME xml
> > document describing their experiment. In addition, a good XML editor uses the schema to indicate to the user
> > the elements available at any particular point in the document so that the user doesn't have to remember all the
> > entries, which are required or optional to describe an experiment.
> >
> > With this e-mail I include two documents. The first is an example schema for ROME. This schema is
> > incomplete, but illustrates the major concepts of using a schema to specify the acceptable format of the XML
> > document and providing help to the user for building the document. The second is an example XML document
> > built using the ROME sample schema. It is for an experiment currently in production at the Los Alamos
> > National Laboratory.
> >
> > To get this example to work you will have to change the second line of DANCESchema.xml so that it properly
> > points to the ROME.xsd document. For this example I used the Java based XML editor Oxygen.
> >
> > Notes on Schema:
> > 1) Every element in the schema has a fixed name. All experimental data is included as either xml data or an
> > xml attribute.
> > 2) Based on the suggestion by <a
> href="<a
href="http://www.xmlfiles.com/xml/xml_attributes.asp">http://www.xmlfiles.com/xml/xml_attributes.asp</a>">http://www.xml
files.com/xml/xml_attributes.asp"><a
href="http://www.xmlfiles.com/xml/xml_attributes.asp</a>">http://www.xmlfiles.com/xml/xml_attributes.asp</a></a></a>
attributes
> are used sparingly or
> > not at all. Instead data is specified as XML data e.g. <data>the actual data</data>.
> >
> > If you have any questions concerning this example please e-mail jwouters@lanl.gov.
>
>
> Thank you for your advice.
>
> I have implemented the suggested xml format in rome. I have also inluded a rome.xsd schema file in the rome
> distribution under ROMESYS/.
>
> Now, the current cvs version of rome expects the new format.
> The samples are updated.
>
> The documentation is not yet updated.
> Is there any way of using the .xsd file for documentation?
>
> For example I'd like to have somting like this:
> I would like to have a docu attribute in the xsd file :
>
> <xs:element name="Folders" minOccurs="1" maxOccurs="1" docu="Defines all folder of the framework">
> <xs:complexType>
> <xs:sequence>
> <xs:element name="Folder" type="FolderDesc" minOccurs="1" maxOccurs="unbounded"
> docu="Defines a folder of the framework"/>
> </xs:sequence>
> </xs:complexType>
> </xs:element>
>
> The xsd file should then be translated into an html file, that documents the structure of my xml file with comments
> on every field.
>
> Is there any tool, that provides a documentation mechanism like that.
>
> If not I will write that by myself.
For get my question, I have found some schema documentation generators. |