NITE XML Toolkit - Filenaming Convention

NITE Filenaming Convention

We assume you are familiar with the terms observation, agent, coding, signal, object set, ontology and style as used by NITE. If not, these terms are described in this paper and also on the metadata page .

General storage policy

Annotations will be stored in the directory named in the path attribute of the codings element in the metadata file. Similarly, signals, ontologies and object sets should be stored in the directories as similarly defined in the metadata. There will be no subdirectory structure for any of these directories.

Codings and Annotations

For all codings, the directory is specified by the path attribute of the codings element in the metadata.

There are two kinds of coding: interaction codings and agent codings (see the metadata page for details). For interaction codings, the full filename is derived from:

observation-name.coding-name.xml

Example: obs1.words.xml

For agent codings there will be one file per agent conforming to this formula:

observation-name.agent-name.coding-name.xml

Example: obs1.g.words.xml

Object Sets

For all object sets, the directory is specified by the path attribute of the object-sets element in the metadata.

The full filename is simply:

objectset-name.xml

Ontologies

For all ontologies, the directory is specified by the path attribute of the ontologies element in the metadata.

The full filename is simply:

ontology-name.xml

Signals

For all signals, the directory is specified by the path attribute of the signals element in the metadata.

There are two kinds of signal: interaction signals and agent signals (see the metadata page for details). For interaction signals, the full filename is derived from:

observation-name.signal-name.signal-extension

Example: obs1.interaction-video.avi

For agent signals there will be one file per agent conforming to this formula:

observation-name.agent-name.signal-name.signal-extension

Example: obs1.g.audio.au

Note that the signal name and signal extension are both part of the signal definition in the metadata file.

Styles

For all styles, the directory is specified by the path attribute of the styles element in the metadata.

The full filename is simply:

style-name.style-extension

For example display.xsl could be the name of a stylesheet for display using the NITE Interface engine. The style name and extension are both attributes of the style in the metadata file.

Last modified 04/13/06