<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="documentationTransformation_v1.1.xsl"?>
<schemaDocumentation xmlns="http://services.natureserve.org/docs/schemas/biodiversityDataFlow/1"
                     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                     xsi:schemaLocation="http://services.natureserve.org/docs/schemas/biodiversityDataFlow/1
                                        http://services.natureserve.org/docs/schemas/biodiversityDataFlow/1/">

    <!--
    ____________________________
    How to edit this document - that is, until a Database can be designed to hold this content.

    1) Mostly cut and paste and use previous examples
    2) Use the pipe "|" character to separate parts of the xpath expression. The XSL will correctly turn these into forward slashes.
    3) If you use the forward slash directly, it will be printed as-is.
    4) VALIDATE! This document has a schema, and if you violate, you have to fix it!

    REASON FOR USING THE PIPE IN XPATH: The xpath can get really long, and in a table output, it may need to be word-wrapped.
       In order to enhance the "human-readable" feature of the output, we put weak line breaks where the slashes are like this:
         /root<wbr/>/child<wbr/>/lowerLevel
       But as you can see, that is very difficult to maintain. Therefore, please enter the same value like this:
         /root|child|lowerLevel
       ... which is a lot easier to read and maintain. If you start the whole line with a pipe, that's OK too:
         |root|child|lowerLevel

    NO! THE PIPE TRICK DOES NOT WORK ANYWHERE EXCEPT IN THE XPATH ELEMENT.

    REASON FOR USING <![CDATA[ ... ]]> elements: If you want to hard-code some HTML, you have to put them inside these
       elements. That is because this document will not validate without doing that, and the XSLT will preserve the HTML
       so that it will render as HTML in the final output document.

    REASON FOR ESCAPING THE ampersand AND less-than SYMBOLS: if you don't escape them, they will never appear...
       &amp; &lt;

    -->
    <schemaDocumentationHeader>
        <schemaHtmlHeadTitle>Image Metadata Schema version 1.1</schemaHtmlHeadTitle>
        <schemaDescription>
            <![CDATA[This document is an easy-to-read (html) representation of the NatureServe Image Metadata Schema
            version 1.1. This schema describes the output of the Species Image Service.<br/>
			<br/>
			The root element of Species Image Service responses is 'images'.<br/>
			<br/>
			<b>Note:</b> 'Qualified Dublin Core' metadata elements are imported and used in the service output.  These are
			prefixed with the 'dc' namespace abbreviation.  See http://dublincore.org for full details of
			the usage of these elements.
            ]]>
        </schemaDescription>
        <descriptionAddenda>
            This is not the normative representation of the draft standard.
            In the case of any conflict between the two representations, definitions
            and values in XML schema take precedence.
        </descriptionAddenda>
        <schemaStatusDetails>
            <schemaStatus>Final 1.0 Release</schemaStatus>
        </schemaStatusDetails>
        <schemaSubmissionDetails>
            <submittedBy>NatureServe</submittedBy>
            <submissionDate>2008-10-27</submissionDate>
        </schemaSubmissionDetails>
        <changeLogDetails>
            <changeNote changeDate="2008-09-17">First version 1.1 - schema versioning synchronizes with Biodiversity Data Flow version</changeNote>
        </changeLogDetails>
        <!--
        <schemaReviewQuestions>
            <dataQuestionDetails>
                <dataQuestion questionDate="2006-12-26">If a user executes a search that returns 100 results, is the content expressed in this schema likely to be suitable for a cursory list of results?</dataQuestion>
                <dataQuestion questionDate="2006-12-26">Is there too much data for a cursory list? Do you have specific suggestions as to content?</dataQuestion>
            </dataQuestionDetails>
        </schemaReviewQuestions>
        <schemaGeneralNoteDetails>
            <schemaGeneralNote>If an optional attribute or element is not present in an instance document, that means that either the data is not being released, or the value is unknown.</schemaGeneralNote>
        </schemaGeneralNoteDetails>
        -->
    </schemaDocumentationHeader>
    <schemaDocumentationDetails>
        <documentationHtmlWeakLineBreak><![CDATA[<wbr/>]]></documentationHtmlWeakLineBreak>
        <documentationColumnHeadings>
            <dataElementName>Data Element</dataElementName>
            <dataElementDescription>Description</dataElementDescription>
            <nonDescriptiveNotes>Notes</nonDescriptiveNotes>
            <xpath><![CDATA[XPath to Schema Element or Attribute Name<br/>(Attributes <wbr/>preceded by <wbr/>"@" character)]]></xpath>
        </documentationColumnHeadings>
        <documentationDetails>
            <documentationGroup name="Image Service Response">
                <documentationItem>
                  <dataElementName>Images Response Root</dataElementName>
                  <dataElementDescription>
						The root element of the response, which may be empty.
                  </dataElementDescription>
                  <nonDescriptiveNotes/>
                  <xpath>/images</xpath>
                </documentationItem>
                <documentationItem>
                  <dataElementName>Terms and Conditions</dataElementName>
                  <dataElementDescription>
						Provides the general user with the terms and conditions governing
						the usage of the web service. It will cover such items as the need
						to periodically refresh image metadata to obtain any changes in
						copyright detail, etc.
                  </dataElementDescription>
                  <nonDescriptiveNotes/>
                  <xpath>/images|termsAndConditions</xpath>
                </documentationItem>
            </documentationGroup>
            <documentationGroup name="Image Metadata">
                <documentationItem>
                  <dataElementName>Image Container</dataElementName>
                  <dataElementDescription>
                      Each 'image' element contains the metadata for one image.
                  </dataElementDescription>
                  <nonDescriptiveNotes/>
                  <xpath>/images|image</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Image ID</dataElementName>
                    <dataElementDescription>
                        NatureServe unique ID for this image.
                    </dataElementDescription>
                    <nonDescriptiveNotes>E.g. 8845</nonDescriptiveNotes>
                    <xpath>/images|image|id</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Title</dataElementName>
                    <dataElementDescription>
						The title of the image.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
						Always the species common name plus scientific name in parentheses (e.g., 'Golden Eagle (Aquila chrysaetos)').
					</nonDescriptiveNotes>
                    <xpath>/images|image|dc:title</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Creator Name</dataElementName>
                    <dataElementDescription>
						Credited creator name (usually photographer) (e.g., 'John Doe').
						This element may be repeated, where there are multiple creators credited for the image.
						Names will be served as they were originally supplied. In the majority of cases this
						will be as first name plus last name.
                    </dataElementDescription>
                    <nonDescriptiveNotes></nonDescriptiveNotes>
                    <xpath>/images|image|dc:creator</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Publisher</dataElementName>
                    <dataElementDescription>
						Entity publishing this image. In this case, always 'NatureServe'.
                    </dataElementDescription>
                    <nonDescriptiveNotes></nonDescriptiveNotes>
                    <xpath>/images|image|dc:publisher</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Subject</dataElementName>
                    <dataElementDescription>
						<![CDATA[The second level of NatureServe's informal taxonomy for this species
						(e.g., 'Birds', 'Amphibians', 'Reptiles', 'Fishes').  This is as shown on the
						NatureServe Explorer comprehensive species report at
						<a href="http://natureserve.org/explorer">http://natureserve.org/explorer.</a>]]>
                    </dataElementDescription>
                    <nonDescriptiveNotes></nonDescriptiveNotes>
                    <xpath>/images|image|dc:subject</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Description</dataElementName>
                    <dataElementDescription>
						Where an image description was provided to NatureServe, this element
						will contain that text (e.g., 'Male with anal fin inserted into crevice').
						Where no individual description was provided, this element will contain
						the species common name (e.g., 'Spotfin Chub').
                    </dataElementDescription>
                    <nonDescriptiveNotes></nonDescriptiveNotes>
                    <xpath>/images|image|dc:description</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Identifier</dataElementName>
                    <dataElementDescription>
						Unique identifier for the image - the full NatureServe URL of the species image.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
						<![CDATA[E.g. 
						<a href="http://www.natureserve.org/imagerepository/GetImage?SRC=2&BATCH=10&FMT=jpg&RES=768X512&NAME=goldeneagle4">
						http://www.natureserve.org/imagerepository/GetImage?
						SRC=2&amp;BATCH=10&amp;FMT=jpg&amp;RES=768X512&amp;NAME=goldeneagle4</a>.]]>
					</nonDescriptiveNotes>
                    <xpath>/images|image|dc:identifier</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Type</dataElementName>
                    <dataElementDescription>
						The Species Image service only publishes metadata on species images.
						Therefore this will always be 'Image'
                    </dataElementDescription>
                    <nonDescriptiveNotes></nonDescriptiveNotes>
                    <xpath>/images|image|dc:type</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Format</dataElementName>
                    <dataElementDescription>
						<![CDATA[There will be two dc:format elements:<br/>
							1. Image MIME type (e.g., 'image/jpeg').<br/>
							2. Resolution (e.g., '512X768').<br/>
						]]>
                    </dataElementDescription>
                    <nonDescriptiveNotes></nonDescriptiveNotes>
                    <xpath>/images|image|dc:format</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Rights</dataElementName>
                    <dataElementDescription>
						Rights statement for the usage of the species image.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
						E.g. 'This photo may be freely used for noncommercial, educational purposes.
						All uses must include the copyright line and photographer credit
						listed with the image'.
					</nonDescriptiveNotes>
                    <xpath>/images|image|dc:rights</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Rights Holder</dataElementName>
                    <dataElementDescription>
						<![CDATA[
						There may be multiple dc:rightsHolder elements, containing:<br/>
							Holder name (e.g., 'John Doe').</br>
							Holder type (e.g., 'Copyright held by Creator',</br>
							'Copyright held by Source', 'Copyright held by Publisher', 'Public Domain').
						Public domain images will contain a single element with the holder type	value 'Public Domain'.<br/>
						Non-public domain images should be marked with the copyright symbol,
						plus holder name(s).<br/>
						Regardless of the number of holder names,
						the <b>last</b> dc:rightsHolder element will always contain the holder type.
						]]>
					</dataElementDescription>
                    <nonDescriptiveNotes></nonDescriptiveNotes>
                    <xpath>/images|image|dc:rightsHolder</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Issued Date</dataElementName>
                    <dataElementDescription>
						Date the image was created, in YYYY-MM-DD format. Where only a partial date
						was supplied to NatureServe, the element will not contain all components of the date
						(e.g., '2008-01', where only the year and month components are known). When a partial
						date cannot be converted to partial YYYY-MM-DD format, the original recorded date text
						will be provided (e.g., 'July'). Where no date was supplied, this element will be omitted.
                    </dataElementDescription>
                    <nonDescriptiveNotes></nonDescriptiveNotes>
                    <xpath>/images|image|dc:issued</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>'Is Version Of'</dataElementName>
                    <dataElementDescription>
						<![CDATA[
						There may be zero or more dc:isVersionOf elements, each one holding the unique URL
						(dc:identifier) of another version of this image.<br/>
						A typical usage would be where a thumbnail image pointed to its fullsize counterpart,
						or vice versa.
						]]>
                    </dataElementDescription>
                    <nonDescriptiveNotes>
						<![CDATA[
						E.g. <a href="http://www.natureserve.org/imagerepository/GetImage?SRC=2&BATCH=10&FMT=jpg&RES=192X128&NAME=goldeneagle4">
						http://www.natureserve.org/imagerepository/GetImage?SRC=2&amp;BATCH=10&amp;FMT=jpg&amp;RES=192X128&amp;NAME=goldeneagle4</a>
						]]>
					</nonDescriptiveNotes>
                    <xpath>/images|image|dc:isVersionOf</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Coverage</dataElementName>
                    <dataElementDescription>
						Where a description of the location depicted in the species image was supplied,
						this element will contain that description -
						otherwise this element will be omitted.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
						E.g., 'Tallapoosa River System, Thomasson Creek, Paulding Co., GA'
					</nonDescriptiveNotes>
                    <xpath>/images|image|dc:coverage</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Continent</dataElementName>
                    <dataElementDescription>
						Where a geographic continent for the location depicted in the species image was supplied,
						this element will contain that data, otherwise this element will be omitted.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
						E.g., 'North America'
					</nonDescriptiveNotes>
                    <xpath>/images|image|continent</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Country</dataElementName>
                    <dataElementDescription>
						Where a geographic country for the location depicted in the species image was supplied,
						this element will contain that data, otherwise this element will be omitted.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
						E.g. 'USA'
					</nonDescriptiveNotes>
                    <xpath>/images|image|country</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>State/Province</dataElementName>
                    <dataElementDescription>
						Where a geographic state or province for the location depicted in the species image was supplied,
						this element will contain that data, otherwise this element will be omitted.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
						E.g., 'Virginia'
					</nonDescriptiveNotes>
                    <xpath>/images|image|state</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Scientific Name</dataElementName>
                    <dataElementDescription>
						Natureserve species primary scientific name.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
						E.g., 'Glyptocephalus zachirus'
					</nonDescriptiveNotes>
                    <xpath>/images|image|scientificName</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Synonym</dataElementName>
                    <dataElementDescription>
						There may be zero or more synonym elements, each one holding a synonymous scientific name
						for the species.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
						E.g., 'Errex zachirus'
					</nonDescriptiveNotes>
                    <xpath>/images|image|synonym</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Common Name</dataElementName>
                    <dataElementDescription>
						NatureServe species primary common name. The optional lang attribute
						may indicate a language other than English.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
						E.g., 'Rex Sole'
					</nonDescriptiveNotes>
                    <xpath>/images|image|commonName</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Other Common Name</dataElementName>
                    <dataElementDescription>
						There may be zero or more otherCommonName elements, each one holding another name commonly
						used for the species. The optional lang attribute may indicate
						a language other than English.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
						E.g., 'Aigle royal'
					</nonDescriptiveNotes>
                    <xpath>/images|image|otherCommonName</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>ITIS Scientific Name</dataElementName>
                    <dataElementDescription>
						The species scientific name as used in ITIS when
						this information is available, otherwise this element will be omitted.
						Note that the ITIS scientific name is not currently part of NatureServe's data holdings,
						though plans in place cover the creation and storage of some of this information. As these
						plans progress, it is currently expected that this element will begin to appear,
						where the ITIS scientific name exists.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
						E.g., 'Glyptocephalus zachirus'
					</nonDescriptiveNotes>
                    <xpath>/images|image|ITISScientificName</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Gender</dataElementName>
                    <dataElementDescription>
						Where a description of the depicted gender of the species was supplied,
						this element will contain that description,
						otherwise this element will be omitted.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
						E.g., 'male'
					</nonDescriptiveNotes>
                    <xpath>/images|image|gender</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Life Stage</dataElementName>
                    <dataElementDescription>
						Where a description of the depicted life stage of the species was supplied,
						this element will contain that description,
						otherwise this element will be omitted.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
						E.g., 'Juvenile'
					</nonDescriptiveNotes>
                    <xpath>/images|image|lifeStage</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Global Species UID</dataElementName>
                    <dataElementDescription>
						NatureServe&apos;s globally unique ID for a single species, as shown in NatureServe Explorer.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
						E.g., ELEMENT_GLOBAL.2.453627
					</nonDescriptiveNotes>
                    <xpath>/images|image|globalSpeciesUID</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>NatureServe Explorer URI</dataElementName>
                    <dataElementDescription>
						If additional information is needed on the species depicted, it may be found
						in the complete species report, accessed using this URL.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
						<![CDATA[
						E.g. <a href="http://www.natureserve.org/explorer/servlet/NatureServe?searchName=Aquila+chrysaetos">
						http://www.natureserve.org/explorer/servlet/NatureServe?searchName=Aquila+chrysaetos</a>
						]]>
					</nonDescriptiveNotes>
                    <xpath>/images|image|natureServeExplorerURI</xpath>
                </documentationItem>
            </documentationGroup>
            <documentationGroup name="Permissions Contact Information">
                <documentationItem>
                    <dataElementName>Image Permissions</dataElementName>
                    <dataElementDescription>
						This is a container element for image permission related details -
						contact name, organization, etc.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
					</nonDescriptiveNotes>
                    <xpath>/images|image|imagePermission</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Permissions Contact Name</dataElementName>
                    <dataElementDescription>
						The name of the contact for questions on image permissions.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
					</nonDescriptiveNotes>
                    <xpath>/images|image|imagePermission|name</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Permissions Contact Organization</dataElementName>
                    <dataElementDescription>
						The organization of the contact for questions on image permissions, where available.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
					</nonDescriptiveNotes>
                    <xpath>/images|image|imagePermission|organization</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Permissions Address</dataElementName>
                    <dataElementDescription>
						The street address of the contact for questions on image permissions, where available.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
					</nonDescriptiveNotes>
                    <xpath>/images|image|imagePermission|address</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Permissions Address Line 2</dataElementName>
                    <dataElementDescription>
						The second line of the street address of the contact for questions on image permissions, where available.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
					</nonDescriptiveNotes>
                    <xpath>/images|image|imagePermission|addressLine2</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Permissions City</dataElementName>
                    <dataElementDescription>
						The city of the contact for questions on image permissions, where available.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
					</nonDescriptiveNotes>
                    <xpath>/images|image|imagePermission|city</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Permissions State/Province</dataElementName>
                    <dataElementDescription>
						The state or province of the contact for questions on image permissions, where available.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
					</nonDescriptiveNotes>
                    <xpath>/images|image|imagePermission|state</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Permissions Postal Code</dataElementName>
                    <dataElementDescription>
						The ZIP or postal code of the contact for questions on image permissions, where available.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
					</nonDescriptiveNotes>
                    <xpath>/images|image|imagePermission|postalCode</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Permissions Phone Number</dataElementName>
                    <dataElementDescription>
						The phone number of the contact for questions on image permissions, where available.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
					</nonDescriptiveNotes>
                    <xpath>/images|image|imagePermission|phone</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Permissions Email Address</dataElementName>
                    <dataElementDescription>
						The email address of the contact for questions on image permissions, where available.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
					</nonDescriptiveNotes>
                    <xpath>/images|image|imagePermission|email</xpath>
                </documentationItem>
                <documentationItem>
                    <dataElementName>Permissions Website</dataElementName>
                    <dataElementDescription>
						The website address of the contact for questions on image permissions, where available.
                    </dataElementDescription>
                    <nonDescriptiveNotes>
					</nonDescriptiveNotes>
                    <xpath>/images|image|imagePermission|website</xpath>
                </documentationItem>
            </documentationGroup>
            </documentationDetails>
        </schemaDocumentationDetails>
    </schemaDocumentation>
    