<!-- ====================================================================
FILE : metadata.dtd
ROOT : MetaDataFile
DESCRIPTION : This file contains the DTD for the Meta Data functionality.
This functionality allows the Administrator to define custom information 
that will be required from the User at the moment of scanning. This 
custom information can either be related to a particular destination (for
instance an Invoice number when an invoice destination is selected) or it
can be requested regardless of the destination.
===================================================================== -->
<!-- ====================================================================
ENTITY : MD_DTD_VERSION
DESCRIPTION : This entity contains the version number of this DTD.
===================================================================== -->
<!ENTITY MD_DTD_VERSION '1.00'>
<!-- ====================================================================
ENTITY : MD_DOMAIN
DESCRIPTION : This entity contains the domain of this DTD.
===================================================================== -->
<!ENTITY MD_DOMAIN 'XML meta data'>
<!-- ====================================================================
ELEMENT : MetaDataFile
PARENT : None
CHILD : AlwaysAsk (optional)
Ask (zero or more)
ATTRIBUTES : None
DESCRIPTION : This element is the root element. It allows the 
Administrator to define meta data that will always be requested (gathered
in the 'AlwaysAsk' section) regardless of the destination, and meta data
that will be requested only when a particular destination is selected
(gathered in the 'Ask' section).
===================================================================== -->
<!ELEMENT MetaDataFile (AlwaysAsk?, Ask*) >
<!ATTLIST MetaDataFile
Version CDATA #FIXED '&MD_DTD_VERSION;'
Domain CDATA #FIXED '&MD_DOMAIN;'>
<!-- ====================================================================
PARENT : MetaDataFile
CHILD : MetaData (one or more)
Output (optional)
ATTRIBUTES : None
DESCRIPTION : This element gathers the meta data that is requested from 
the user regardless of the destination. This does not imply that the 
different meta data is required but just that it is not destination 
dependent as the meta data gathered in the 'Ask' section is. For instance
the Administrator can always ask the User to identify himself. This is 
not destination dependent.
===================================================================== -->
<!ELEMENT AlwaysAsk (MetaData+, Output?) >
<!-- ====================================================================
ELEMENT : Ask
PARENT : MetaDataFile
CHILD : When (one)
MetaData (one or more)
Output (optional)
ATTRIBUTES : None
DESCRIPTION : This element gathers the different meta data that is 
Destination dependent. The Administrator is able to specify the meta data
which is to be requested from the User on selecting a specific 
destination (gathered in the 'When' element). This section also allows
the Administrator to define the specific format of the output for this
set of MetaData. For instance, the Administrator can ask for an invoice
number when the User selects the invoice destination. He can also define
a particular output format that can easily be processed (by a database
for instance).
===================================================================== -->
<!ELEMENT Ask (When, MetaData+, Output?) >
<!-- ====================================================================
ELEMENT : MetaData
PARENT : AlwaysAsk
Ask
CHILD : Value (zero or more)
ATTRIBUTES : 
Required:
This attribute is an enumerated value that defines if the User must
enter the MetaData (='yes') or if it can be skipped (='no') or if it is
hidden to the User (='hidden'). MetaData with the 'Required' attribute
defined as 'yes', is mandatory and must be entered before the User can
proceed with the scanning. MetaData with the 'Required' attribute
defined as 'hidden', is useful when the administrator wants to define a
default value that will help in processing the information entered by
the User.
Id:
This attribute indicates the system and name the MetaData is known by. 
This identifier must be unique among all the MetaData elements.
Prompt:
This attribute contains the string that will be displayed on the LCD 
display when requesting this particular MetaData from the User. If the
Administrator does not specify the text the User will be prompted with
the 'Id' attribute.
Label:
This attribute contains the output string when the Administrator has
not defined an output format. If no labels are defined, the 'Id' 
attribute will be used instead.
ErrorMessage:
This attribute contains the string that will be displayed when the
value entered by the User does not match the 'Pattern' attribute. If 
the Administrator does not specify this attribute, the default string 
'Incorrect value!' will be displayed instead.
DefaultValue:
This attribute contains the output string for when the MetaData is not
required and not entered by the User (attribute 'Required' equal 'no')
or hidden (attribute 'Required' equal 'hidden'). The default value for
this attribute is the empty string.
Pattern:
This attribute contains the regular expressions that describe the 
expected format in the value entered by the User. For more details on
the Regular Expression syntax see the User's Manual. The default value
for this attribute is the match-everything pattern ('.*').
Editable:
This attribute is an enumerated value that defines if the User is
allowed to enter a value different from the one purposed in the list of
value defined for this Meta Data. The User will be allowed if the 
attribute is set to 'yes' and will not be if the attribute is et to 
'no'
DESCRIPTION : This element contains the information specific to the meta 
data itself. See the attribute descriptions for more details.
===================================================================== -->
<!ELEMENT MetaData (#PCDATA | Value)* >
<!ATTLIST MetaData
Required (yes | no | hidden) 'no'
Id ID #REQUIRED
Prompt CDATA #IMPLIED
Label CDATA #IMPLIED
ErrorMessage CDATA #IMPLIED
DefaultValue CDATA #IMPLIED
Pattern CDATA #IMPLIED
Editable (yes | no) 'yes'>
<!-- ====================================================================
ELEMENT : Value
PARENT : MetaData
CHILD : None
ATTRIBUTES : None
DESCRIPTION : This element contains a specific value for a Meta Data.
This allow the User to choose the value of a certain Meta Data among 
several value.
===================================================================== -->
<!ELEMENT Value (#PCDATA)>
<!-- ====================================================================
ELEMENT : When
PARENT : Ask
CHILD : Destination (one or more)
ATTRIBUTES : None
DESCRIPTION : This element contains a list of the different destinations 
that trigger the request of the dependent MetaData elements from the 
User. When one or more of the specified destinations is selected by the 
User, the following MetaData will be requested.
===================================================================== -->
<!ELEMENT When (Destination+) >
<!-- ====================================================================
ELEMENT : Destination
PARENT : When
To
CHILD : None
ATTRIBUTES :
Description:
This is the Id of the Destination. One restriction is that the 
destination's description attribute must be a valid destination 
description. This means that the Administrator cannot define a new 
destination here.
DESCRIPTION : This element contains the description of the defined
destination
===================================================================== -->
<!ELEMENT Destination (#PCDATA) >
<!ATTLIST Destination
Description CDATA #REQUIRED>
<!-- ====================================================================
ELEMENT : Output
PARENT : AlwaysAsk
Ask
CHILD : To (optional)
Format (optional)
ATTRIBUTES : 
FileName :
This attribute indicate to the AXIS 7000 which template it should use
in order to determine the remote file name. This template can contain 
references to Meta Data's Id, in order to create a file name that is 
created with the values entered by the User. This attribute overrides
the value set for the Destination.
Description :
This attribute indicate to the AXIS 7000 which template it should use
in order to determine the description of the Information File. This 
does actually matter only for Send-to-E-mail destinations. This will,
then appear into the subject line of the e-mail. As for the attribute 
FileName it can contain references to Meta Data'Id. For other type 
destinations, this is discarded.
DESCRIPTION : This element contains the specific information for when the
Administrator wants to specify a format different from the traditional
one. The Administrator can also specify a destination for the output 
file. 
===================================================================== -->
<!ELEMENT Output (To | Format | (To, Format))? >
<!ATTLIST Output
FileName CDATA #IMPLIED
Description CDATA #IMPLIED>
<!-- ====================================================================
ELEMENT : To
PARENT : Output
CHILD : Destination
ATTRIBUTES : None
DESCRIPTION : This element contains the particular destination to which
the output file should be sent.
===================================================================== -->
<!ELEMENT To (Destination)>
<!-- ====================================================================
ELEMENT : Format
PARENT : Output
CHILD : None
ATTRIBUTES : None
DESCRIPTION : This element contains the custom declaration that defines
the output format defined by the Administrator for this specific 
destination.
===================================================================== -->
<!ELEMENT Format (#PCDATA)>