Isis Documentation Schema
XML schema for describing the documentation available on the Isis web site
Designed by Deborah Lee Soltesz, dsoltesz@usgs.gov, 10/11/2002, USGS Astrogeology Research Program, Flagstaff, AZ
container describing a single electronic document. "hidden" attribute should prevent this document from being linked in an autogenerated TOC.
enumeration for categories the document should be filed under
marks the document as "hidden", thus should not be linked to or otherwise referenced publicly
a document that gives general information about the software system and developers - history, policies, contact information, etc.
a document that serves as a guide (how-to or tutorial) for using the software or API, modifying the software, etc.
a document that serves as a tutorial on some subject regarding using, programming, maintaining, etc. Isis
a document that provides information about the installation of the software
document that gives information about maintaining the software installation
a document that contains highly technical information about the software
document related to support of the software by the software developers (i.e. USGS Isis Programming Team)
a document that serves simply to provide information
a document that serves as a reference (as opposed to a guide/how-to/tutorial)
a document outlining a policy
a document about the Isis XML languages
a document about the Isis API
a document about the previous version of Isis, Isis 2.1
enumeration for target audience types
A basic user, generally one who does not install, maintain, or program for the software system, but simply uses the software
An advanced user
A person who installs and maintains the software package (generally a systems administrator)
A programmer who uses the API to develop applications
A programmer who modifies the software system (Isis), i.e. develops Objects
all audiences
list of files that represent this document - for example, if the document is avaible in Word, PDF, and HTML, there would be three files listed here, one for each format
list of categories this document should be linked under
a single category in the list (enumerated type)
list of target audience types
bibliographic information about the document
list of history of changes to the document
container of link (and potentially content) information for files representing the document. "hidden" attribute should prevent this file/subdocument from being linked. "primary" attribute should make this the favored file out of a selection of multiple files.
name of the format or other descriptor for this file
size of the file if applicable (ie. not HTML or text)
electronic source information
full URL to a document at another location
filename of document in this document structure (including desired name for HTML output of this document)
subtitle (useful for multipage documents)
inline document content- this file will be generated as an HTML document. Body must contain either a URI to an external XML file (with root element BODY) or the HTML formatted content
XML-legal HTML formatted document text
filename for external XML source of content. External file must have a root element BODY that contains HTML formatted content
a single target audience type: user, advanced, administrator, developer, programmer
title of the document
brief description of this document
long description of this document
author's name
publisher's information
date of publication
single history entry