6.2.1. The file header element

Prev		Next

The fileHeader element contains information about the source of the data contained within the DAVEfunc major element, including the author, creation date, description, reference information, and modification history.

    fileHeader : [name]
        author+ : name, org, [email]
            contactInfo* : [contactInfoType, contactLocation]
                {text describing contact information for author}
        creationDate : date {in ISO 8601 YYYY-MM-DD format}
        fileVersion? 
            {file version identifier}
        description?
            {textual description of model}
        reference* : refID, author, title, date, [classification, accession, href]
            description? :
                {textual information about reference}
        modificationRecord* : modID, date, [refID]
            author+ : name, org, [email]
                contactInfo* : [contactInfoType, contactLocation]
                    {text describing contact information for author}
            description?
                {textual description of modification}
            extraDocRef* : refID
        provenance* :
                author+ : name, org, [email]
                    contactInfo* : [contactInfoType, contactLocation]
                        {text describing contact information for author}
                creationDate : date {in ISO 8601 YYYY-MM-DD format}
                documentRef* : [docID,] refID
                modificationRef* : modID
                description?
                    {textual description of the background of the model}

fileHeader sub-elements:

author: Name, organization, optional email address and other contact information for each author.
creationDate: Creation date of this file. See Section 6.5.4, “Date format” for the recommended format for encoding dates.
fileVersion: A string that indicates the version of the document. No convention is specified for the format, but a good practice would include an automated revision number from a version control system.
description: An optional but recommended text description: what does this DAVE-ML file represent?
reference: An optional list of one or more references with a document-unique ID (must begin with alpha character), author, title, date, and optional accession and URL of the reference. This sub-element can include a description of the reference.
modificationRecord: An optional list of one or more modifications with optional reference IDs, as well as author information and descriptions for each modification record. These modifications are referred to by individual function tables and/or data points, using the AIAA modification letter convention. If more than one document is associated with the modification, multiple sub-element extraDocRefs may be used in place of the modificationRecord's refID attribute.
provenance: An optional list of one or more provenance elements allows the author to describe the source and history of the data within this model. Since the model may be constructed from several sources, more than one provenance may be provided, one for each source of data. Use of a provID attribute in the fileHeader is unnecessary since this provenance applies to the entire model unless otherwise specified.

Example 1. An excerpt with an example of a fileHeader element

<!--                          =================                          --> 
<!-- =========================   FILE HEADER   ========================= -->
<!--                          =================                          -->


  <fileHeader> 
    <author name="Bruce Jackson" org="NASA Langley Research Center">
      <contactInfo contactInfoType='address' contactLocation='professional'>
         MS 308 NASA, Hampton, VA 23681
      </contactInfo>
      <contactInfo contactInfoType='email' contactLocation='professional'>
        [email protected]
      </contactInfo>
    </author>
    <creationDate date="2003-03-18"/> 

    <fileVersion>$Revision: 1.24 $</fileVersion> 

    <description>
     Version 2.0 aero model for HL-20 lifting body, as described in
     NASA TM-107580. This aero model was used for HL-20 approach and
     landing studies at NASA Langley Research Center during 1989-1995
     and for follow-on studies at NASA Johnson Space Center in 1994
     and NASA Ames Research Center in 2001. This DAVE-ML version was
     created in March 2003 by Bruce Jackson to demonstrate DAVE-ML.
    </description>

    <reference refID="REF01" 
        author="Jackson, E. Bruce; Cruz, Christopher I. & and Ragsdale, W. A." 
        title="Real-Time Simulation Model of the HL-20 Lifting Body" 
        accession="NASA TM-107580"
        date="1992-07-01"
    />

    <reference refID="REF02" 
        author="Cleveland, William B. <[email protected]>" 
        title="Possible Typo in HL20_aero.xml" 
        accession="email" 
        date="2003-08-19"
    />

    <modificationRecord modID="A" refID="REF02"> 
      <author name="Bruce Jackson" org="NASA Langley Research Center">
        <contactInfo contactInfoType='address' contactLocation='professional'>
           MS 308 NASA, Hampton, VA 23681
        </contactInfo>
      </author>
      <description>
        Revision 1.24: Fixed typo in CLRUD0 function description which
        gave dependent signal name as "CLRUD1." Bill Cleveland of NASA
        Ames caught this in his xml2ftp script. Also made use of 1.5b2
        fileHeader fields and changed date formats to comply with
        convention.
      </description>
    </modificationRecord>

  </fileHeader>

	Use of comments make models more readable by humans.
	Start of the `fileHeader` element.
	Creation date of file, in ISO-8601 format. See Section 6.5.4, “Date format”
	In this example, the revision number is automatically inserted by a version control system.
	All documents referenced by notation throughout the file should be described in the `fileHeader` as `reference` elements.
	All modifications made to the contents of this file should be listed in the `fileHeader` as `modificationRecord` sub-elements for easy reference by later `modificationRef` elements.