Isis Documentation

Home
Schema documentation.xsd

schema location: | documentation.xsd

Elements | Simple types
audience | audienceType
author | categoryType
bibliography |
body |
brief |
category |
change |
date |
description |
documentation |
file |
filename |
files |
history |
publisher |
size |
source |
src |
subtitle |
target |
title |
type |
URL |

element audience

diagram |
children | target
used by |
element | documentation
annotation |
documentation |
    list of target audience types

element author

diagram |
used by |
element | bibliography
annotation |
documentation |
    author's name

element bibliography

diagram |
children | title brief description author publisher date
used by |
element | documentation
annotation |
documentation |
    bibliographic information about the document

element body

diagram |
children | src
used by |
element | file
annotation |
documentation |
    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

element brief

diagram |
used by |
element | bibliography
annotation |
documentation |
    brief description of this document

element category

diagram |
children | categoryItem
used by |
element | documentation
annotation |
documentation |
    list of categories this document should be
                linked under

element category/categoryItem

diagram |
type | categoryType
facets |
enumeration | hidden
enumeration | about
enumeration | guide
enumeration | tutorial
enumeration | installation
enumeration | administration
enumeration | technicaldoc
enumeration | support
enumeration | information
enumeration | reference
enumeration | policy
enumeration | xml
enumeration | api
enumeration | isis2
annotation |
documentation |
    a single category in the list (enumerated type)

element change

diagram |
used by |
element | history
attributes |
Name | Type | Use | Default | Fixed | Annotation
name | xs:string | required |  |  |
date | xs:date | required |  |  |
hidden | xs:string | optional | false |  |
annotation |
documentation |
    single history entry

element date

diagram |
type | xs:date
used by |
element | bibliography
annotation |
documentation |
    date of publication

element description

diagram |
used by |
element | bibliography
annotation |
documentation |
    long description of this document

element documentation

diagram |
children | files category audience bibliography history
attributes |
Name | Type | Use | Default | Fixed | Annotation
hidden | xs:boolean | optional | false |  |
annotation |
documentation |
    container describing a single electronic
                document. "hidden" attribute should prevent this document from being linked in
                an autogenerated TOC.

element file

diagram |
children | type size source subtitle body
used by |
element | files
attributes |
Name | Type | Use | Default | Fixed | Annotation
hidden | xs:boolean | optional | false |  |
primary | xs:boolean | optional | false |  |
annotation |
documentation |
    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.

element filename

diagram |
used by |
element | source
annotation |
documentation |
    filename of document in this document structure
                (including desired name for HTML output of this document)

element files

diagram |
children | file
used by |
element | documentation
annotation |
documentation |
    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

element history

diagram |
children | change
used by |
element | documentation
annotation |
documentation |
    list of history of changes to the document

element publisher

diagram |
used by |
element | bibliography
annotation |
documentation |
    publisher's information

element size

diagram |
used by |
element | file
annotation |
documentation |
    size of the file if applicable (ie. not HTML or
                text)

element source

diagram |
children | URL filename
used by |
element | file
annotation |
documentation |
    electronic source information

element src

diagram |
used by |
element | body
annotation |
documentation |
    filename for external XML source of content.
                External file must have a root element BODY that contains HTML formatted content

element subtitle

diagram |
used by |
element | file
annotation |
documentation |
    subtitle (useful for multipage documents)

element target

diagram |
type | audienceType
used by |
element | audience
facets |
enumeration | user
enumeration | intermediate
enumeration | advanced
enumeration | administrator
enumeration | developer
enumeration | programmer
enumeration | all
annotation |
documentation |
    a single target audience type: user, advanced,
                administrator, developer, programmer

element title

diagram |
used by |
element | bibliography
annotation |
documentation |
    title of the document

element type

diagram |
used by |
element | file
annotation |
documentation |
    name of the format or other descriptor for this
                file

element URL

diagram |
used by |
element | source
annotation |
documentation |
    full URL to a document at another location

simpleType audienceType

type | restriction of xs:string
used by |
element | target
facets |
enumeration | user
enumeration | intermediate
enumeration | advanced
enumeration | administrator
enumeration | developer
enumeration | programmer
enumeration | all
annotation |
documentation |
    enumeration for target audience types

simpleType categoryType

type | restriction of xs:string
used by |
element | category/categoryItem
facets |
enumeration | hidden
enumeration | about
enumeration | guide
enumeration | tutorial
enumeration | installation
enumeration | administration
enumeration | technicaldoc
enumeration | support
enumeration | information
enumeration | reference
enumeration | policy
enumeration | xml
enumeration | api
enumeration | isis2
annotation |
documentation |
    enumeration for categories the document should
                be filed under