Data files
Previous  Top  Next

The primary input to Structure101g is an XML data file.

Broadly speaking, this contains four sets of information:

·A flavor name and information about the site where the flavor is defined  
·A bunch of items, possibly nested, representing the entities that you wish to model  
·A bunch of dependencies between those items  
·Information about parameters that were set when the file was generated (optional)  

Here is what a minimalist hallo-world.xml looks like:

<
data flavor="com.headway.examples.halloworld" version="1.0.0" site="https://structure101.com/structure101/g/flavors">
   <
modules>
      <
module name="hallo" id="1" type="word"/>
      <
module name="world" id="2" type="word"/>
   <
/modules>
   <
dependencies>
      <
dependency from="1" to="2" type="comes before"/>
   <
/dependencies>
<
/data>

In this case, the flavor of the data is com.headway.examples.halloworld. Whenever Structure101g reads in a data file, it needs to also read in some metadata about the flavor, e.g. to help it decide what icons to use to represent different item types.

In this case, we have just 2 items, hallo and world, both of which are of type word.

There is also a dependency from hallo to world, of type comes before.

Items are discussed in detail in the next section, and dependencies in the following section.

Note:
Future versions of Structure101g may additionally support (1) an alternative more concise data file format and/or (2) reading of compressed (e.g. gzipped) data files.