<!-- 
	 DTD for FormProc configuration file.

	 Author: Anthony Eden (me@anthonyeden.com)
-->


<!--
	 Root element for the configuration.
-->
<!ELEMENT formproc (include*, validator-map*, shared-validator*, form*) >

<!--
	 Include the given configuration file inline.

	 For information on the loader, path, file and monitor attributes,
	 please see the ResourceLoader information at the bottom of this
	 document.
-->
<!ELEMENT include EMPTY >
<!ATTLIST include
          loader  CDATA "com.anthonyeden.lib.resource.FileResourceLoader"
          path    CDATA #IMPLIED
          file	  CDATA #IMPLIED
          monitor (true|false) "false" >

<!--
	 Map logical validator names to validator implementation classes.
	 
	 The type attribute is required and should be a unique identifier for the
	 validator.
	 
	 The classname attribute is required and must be a fully-qualified class
	 name of a class which extends from the org.formproc.validation.Validator
	 base class.
	 
	 The validator map may include any configuration information.  In addition
	 it may include one or more property elements which are accessible to the
	 validator at runtime.
-->
<!ELEMENT validator-map (#PCDATA|property)* >
<!ATTLIST validator-map
          type      CDATA #REQUIRED
          classname CDATA #REQUIRED >

<!--
	 Define a shared validator which can be used throughout the application.
	 
	 The name attribute is required and must be unique throughout the 
	 application.
-->	  
<!ELEMENT shared-validator (validator) >
<!ATTLIST shared-validator
          name	CDATA #REQUIRED >

<!--
     Define a form which is accessible to the application.
     
     The name attribute is required and must be unique throughout the 
	 application.
	 
	 For information on the loader, path, file and monitor attributes,
	 please see the ResourceLoader information at the bottom of this
	 document.
-->
<!ELEMENT form EMPTY >
<!ATTLIST form
          name    CDATA #REQUIRED 
          loader  CDATA "com.anthonyeden.lib.resource.FileResourceLoader"
          path    CDATA #IMPLIED
          file    CDATA #IMPLIED
          monitor (true|false) "false" >

<!--
	 A validator definition.  Validators must extend from the 
	 org.formproc.validation.Validator abstract base class. The validator's 
	 children can include error elements as well as any other configuration 
	 information which is passed to the validator when it is constructed.
	 
	 The type attribute is required and should match a validator type
	 defined in the formproc.xml configuration file in the validator-map
	 section.
-->
<!ELEMENT validator (#PCDATA,error*) >
<!ATTLIST validator 
          type CDATA #REQUIRED >

<!--
	 Defines an error message or means for providing error messages to the 
	 user in case the validator fails.
	 
	 Possible uses:
	 
	 1.) An inline message, with an optional lang attribute, which can be
	     displayed to the user.
	 2.) If the resource attribute is specified then the given resource bundle
	     class is used.  The element value should be the resource key for the
	     message in the bundle.
	 3.) If the classname attribute is specified then the given MessageProvider
	     class is used.
-->
<!ELEMENT error (#PCDATA) >
<!ATTLIST error
          resource CDATA #IMPLIED >
          lang     CDATA #IMPLIED >
		  
<!-- Additional Notes:

	 ** ResourceLoader information **
	 
	 All configuration resources are loaded through ResourceLoaders.
	 
	 The loader attribute is optional.  If the loader class is not specified
	 then com.anthonyeden.lib.resource.FileResourceLoader is used.  If the 
	 loader is specified then it must be the fully-qualified class name of 
	 the resource loader implementation.  The resource loader implementation
	 must implement the com.anthonyeden.lib.resource.ResourceLoader interface.
	 
	 Either the path attribute or file attribute is required.  Use the path
	 attribute if the path is relative to whatever base is provided by the 
	 resource loader.  Use the file attribute if the path is relative to the
	 formproc configuration file.
	 
	 The monitor attribute is optional.  The monitor attribute is used to
	 determine if the resource loader should monitor the specified resource
	 for changes if possible.  If specified, it must be "true" or "false".
	 The default value is "false".  Note that some ResourceLoaders may not
	 be able to monitor resources for changes.
-->