Diff for /storage/meta/meta-format.tex between versions 1.12 and 1.22

version 1.12, 2003/12/05 16:11:59 version 1.22, 2010/02/22 18:15:22
Line 16 Line 16
   
 \author{Robert Casties, Dirk Wintergrün, Hans-Christoph Liess}  \author{Robert Casties, Dirk Wintergrün, Hans-Christoph Liess}
   
 \date{V1.1.0 of 5.12.2003}  \date{V1.3.6 of 22.2.2010}
   
 \begin{document}  \begin{document}
   
Line 59  files are possible: Line 59  files are possible:
 \begin{itemize}  \begin{itemize}
 \item a file named \texttt{index.meta} in a directory.  \item a file named \texttt{index.meta} in a directory.
   
 \item a file named like the data file it describes with an  \item a file with the same name as the data file it describes and an
   additional extension \texttt{.meta}. For example metadata for the    additional extension \texttt{.meta}. For example metadata for the
   file \texttt{0001.tif} would be in a file \texttt{0001.tif.meta}.    file \texttt{p0001.tif} would be in a file \texttt{p0001.tif.meta}.
 \end{itemize}  \end{itemize}
   
 The resource directory must contain an \texttt{index.meta} file with  The resource directory must contain an \texttt{index.meta} file with
 information about the resource as a whole. Other directories can  information about the resource as a whole. Subdirectories can
 contain \texttt{index.meta} files.  contain additional \texttt{index.meta} files.
   
 Additional information about single data files that are part of the  Additional information about single data files that are part of the
 resource can either be put in \texttt{file} tags in the  resource can either be put in \texttt{file} tags in the
 \texttt{index.meta} file or in separate \emph{filename}\texttt{.meta}  \texttt{index.meta} file or in separate \emph{filename}\texttt{.meta}
 files for each data file. Information from the directory level file is  files for each data file. Information from the directory level file is
 inherited at the file level.  inherited at the file level when it is not overwritten.
   
   
 \section{Resource format}  \section{Resource format}
Line 96  The outer container element is \texttt{r Line 96  The outer container element is \texttt{r
 \item[type] sub-type of resource (e.g. ``ECHO'', ``MPIWG'') --  \item[type] sub-type of resource (e.g. ``ECHO'', ``MPIWG'') --
   optional.    optional.
       
 \item[version] version number of metadata format (currently 1.1) --  \item[version] version number of metadata format (currently 1.2) --
   required.    required.
 \end{description}  \end{description}
   
 \noindent The allowed \textbf{elements} inside \texttt{resource} are:  \noindent The allowed \textbf{elements} inside \texttt{resource} are:
   
 \begin{description}  \begin{description}
 \item[description] An informal textual description of the  \item[description] An informal textual description of the resource --
   resource -- optional.    optional\footnote{At least one description of the resource's content
       is required. The description can be an informal
       \texttt{description} element or a descriptive element (like
       \texttt{bib}) in a \texttt{meta} container.}.
   
 \item[name] The filename of the resource (name of the directory this  \item[name] The filename of the resource (name of the directory this
   file is contained in) -- required.    file is contained in) -- required.
Line 122  The outer container element is \texttt{r Line 125  The outer container element is \texttt{r
   whole archive collection, including the resource directory -- deduced.    whole archive collection, including the resource directory -- deduced.
   
 \item[archive-id] The ID for this document in the archive --  \item[archive-id] The ID for this document in the archive --
   required.    optional.
       
 \item[derived-from] Container for the description of the original  \item[derived-from] Container for the description of the original
   resource if this resource is a modified version of another resource    resource if this resource is a modified version of another resource
Line 130  The outer container element is \texttt{r Line 133  The outer container element is \texttt{r
   
   \begin{description}    \begin{description}
   \item[archive-id] The ID of the original resource    \item[archive-id] The ID of the original resource
     -- required.      -- required (or archive-path).
   
   \item[archive-path] The full path to the original resource    \item[archive-path] The full path to the original resource
     -- deduced.      -- required (or archive-id).
   
     \item[description] An informal textual description of the relation
     of this resource to the original resource -- optional.
     \end{description}
     
   \item[used-by] Container for the description of modified resources
     if this resource is the source of another resource
     -- optional.
   
     \begin{description}
     \item[archive-id] The ID of the derived resource
       -- required (or archive-path).
   
     \item[archive-path] The full path to the derived resource
       -- required (or archive-id).
   
   \item[description] An informal textual description of the relation    \item[description] An informal textual description of the relation
   of this resource to the original resource -- optional.    of this resource to the original resource -- optional.
Line 145  The outer container element is \texttt{r Line 163  The outer container element is \texttt{r
   
   \begin{description}    \begin{description}
   \item[archive-id] The ID of the linked resource    \item[archive-id] The ID of the linked resource
     -- required.      -- required (or archive-path).
   
   \item[archive-path] The full path to the linked resource    \item[archive-path] The full path to the linked resource
     -- deduced.      -- required (or archive-id).
   
   \item[description] An informal textual description of the relation    \item[description] An informal textual description of the relation
   of this resource to the linked resource -- optional.    of this resource to the linked resource -- optional.
Line 209  The outer container element is \texttt{r Line 227  The outer container element is \texttt{r
   \item[name] The name of the file -- required.    \item[name] The name of the file -- required.
           
   \item[original-name] A text string associated with the file as    \item[original-name] A text string associated with the file as
     original name -- optional. (E.g. if this file came from an      original name -- optional. (e.g. if this file came from an
     external source and had a name that had to be changed according to      external source and had a name that had to be changed according to
     section~\ref{sec:file-directory-names} but it should be possible      section~\ref{sec:file-directory-names} it is possible
     to reference the original name.)      to preserve the original name.)
           
   \item[path] The directory path of this file relative to the    \item[path] The directory path of this file relative to the
     resource's root directory (excluding the file itself) -- required      resource's root directory (excluding the file itself) -- required
Line 247  The outer container element is \texttt{r Line 265  The outer container element is \texttt{r
 All elements with \texttt{meta} tags can contain an arbitrary number  All elements with \texttt{meta} tags can contain an arbitrary number
 of the following additional metadata elements.  of the following additional metadata elements.
   
 \subsection{workflow state}  \subsection{Workflow state}
 \label{sec:workflow-state}  \label{sec:workflow-state}
   
 All additional metadata elements can have a \texttt{workflow-state}  All additional metadata elements can have a \texttt{workflow-state}
Line 314  on the page Line 332  on the page
 \subsection{Collection context}  \subsection{Collection context}
 \label{sec:collection-context}  \label{sec:collection-context}
   
 The context of a resource as part of a collection or part of a project can be  The context of a resource as part of a collection or part of a project
 specified in the \texttt{context} element. All elements in the  can be specified in the \texttt{context} element. The context element
 container can appear multiple times.  can appear multiple times if the resource is part of multiple
   collections or projects.
   
 \begin{description}  \begin{description}
 \item[context] information on collection or project context.  \item[context] information on collection or project context.
   
   \begin{description}    \begin{description}
   \item[link] URL to additional context information.    \item[link] URL to additional context information -- optional.
       
     \item[name] Textual description of project or collection -- optional.
   
     \item[meta-datalink] description of external sources of canonical meta
       information -- optional
       \begin{description}
       \item[db] \textbf{attribute} to identify different sets of meta data
         links to the same resource -- optional
   
       \item[object] \textbf{attribute} to identify different objects or
         parts of the same resource -- optional
   
       \item[label] textual label for the link -- optional
   
       \item[url] URL to present to the client -- optional
   
       \item[metadata-url] URL to an external server to be queried -- optional
       \end{description}
   
     \item[meta-baselink] description of external server for canonical meta
       information -- optional
       \begin{description}
       \item[db] \textbf{attribute} to identify different sets of meta data
         links to the same resource -- optional
   
       \item[label] textual label for the link -- optional
   
       \item[url] URL to present to the client -- optional
           
   \item[name] Textual description of project or collection.      \item[metadata-url] URL to an external server to be queried --
         required (the parameter \texttt{object=} with an object id has
         to be appended to this URL)
       \end{description}
   \end{description}    \end{description}
 \end{description}  \end{description}
   
Line 367  the commonly used program ``EndNote''. Line 417  the commonly used program ``EndNote''.
     published in multiple volumes.      published in multiple volumes.
   \item [translator] Name of the translator.    \item [translator] Name of the translator.
   \item [isbn-issn]    \item [isbn-issn]
     \item[call-number] Call number in holding library
     \item[holding-library] Holding library
   \end{description}    \end{description}
 \end{description}  \end{description}
   
Line 395  the commonly used program ``EndNote''. Line 447  the commonly used program ``EndNote''.
     published in multiple volumes.      published in multiple volumes.
   \item [translator] Name of the translator    \item [translator] Name of the translator
   \item [isbn-issn]    \item [isbn-issn]
     \item[call-number] Call number in holding library
     \item[holding-library] Holding library
   \end{description}    \end{description}
 \end{description}  \end{description}
   
Line 423  the commonly used program ``EndNote''. Line 477  the commonly used program ``EndNote''.
   \item [number-of-volumes] Number of volumes, if the the book is    \item [number-of-volumes] Number of volumes, if the the book is
     published as multiple volumes.      published as multiple volumes.
   \item [isbn-issn]    \item [isbn-issn]
     \item[call-number] Call number in holding library
     \item[holding-library] Holding library
   \end{description}    \end{description}
 \end{description}  \end{description}
   
Line 448  the commonly used program ``EndNote''. Line 504  the commonly used program ``EndNote''.
   \item [number-of-volumes] Number of volumes, if the the book is    \item [number-of-volumes] Number of volumes, if the the book is
     published as multiple volumes.      published as multiple volumes.
   \item [isbn-issn]    \item [isbn-issn]
     \item[call-number] Call number in holding library
     \item[holding-library] Holding library
     \end{description}
   \end{description}
   
   \subsubsection{Journal Volume}
   
   \begin{description}
   \item [bib type="journal-volume"] a volume of a scientific journal.
     \begin{description}
     \item [title] Name of the journal.
     \item [editor] The editor of the journal.
     \item [publisher] Name of the publishing company.
     \item [city] City where the journal is published.
     \item [year] The year of publication.
     \item [volume] Volume number.
     \item [numer-of-pages] Number of pages of the volume.
     \item [isbn-issn]
     \item[call-number] Call number in holding library
     \item[holding-library] Holding library
   \end{description}    \end{description}
 \end{description}  \end{description}
   
Line 465  the commonly used program ``EndNote''. Line 541  the commonly used program ``EndNote''.
   \item [pages] Number of pages of the article.    \item [pages] Number of pages of the article.
   \item [alternate-journal] Alternate Journal    \item [alternate-journal] Alternate Journal
   \item [isbn-issn]    \item [isbn-issn]
     \item[call-number] Call number in holding library
     \item[holding-library] Holding library
   \end{description}    \end{description}
 \end{description}  \end{description}
   
Line 481  the commonly used program ``EndNote''. Line 559  the commonly used program ``EndNote''.
   \item [issue-number] Number of the issue the article is part of.    \item [issue-number] Number of the issue the article is part of.
   \item [pages Number] of pages of the article.    \item [pages Number] of pages of the article.
   \item [date] Date when the article appeared.    \item [date] Date when the article appeared.
     \item[call-number] Call number in holding library
     \item[holding-library] Holding library
   \end{description}    \end{description}
 \end{description}  \end{description}
   
Line 496  the commonly used program ``EndNote''. Line 576  the commonly used program ``EndNote''.
   \item [pages] Number of pages of the article.    \item [pages] Number of pages of the article.
   \item [issue-date] Date of the issue the article is part of.    \item [issue-date] Date of the issue the article is part of.
   \item [city] City of the newspaper.    \item [city] City of the newspaper.
     \item[call-number] Call number in holding library
     \item[holding-library] Holding library
   \end{description}    \end{description}
 \end{description}  \end{description}
   
Line 514  the commonly used program ``EndNote''. Line 596  the commonly used program ``EndNote''.
   \item [University] Name of the university where the thesis was    \item [University] Name of the university where the thesis was
     handed in.      handed in.
   \item [isbn-issn]    \item [isbn-issn]
     \item[call-number] Call number in holding library
     \item[holding-library] Holding library
   \end{description}    \end{description}
 \end{description}  \end{description}
   
Line 531  the commonly used program ``EndNote''. Line 615  the commonly used program ``EndNote''.
   \item [institution] Institution where the report was produced.    \item [institution] Institution where the report was produced.
   \item [type] Type of report.    \item [type] Type of report.
   \item [report-number] Report number.    \item [report-number] Report number.
     \item[call-number] Call number in holding library
     \item[holding-library] Holding library
   \end{description}    \end{description}
 \end{description}  \end{description}
   
Line 552  the commonly used program ``EndNote''. Line 638  the commonly used program ``EndNote''.
     annotations etc.      annotations etc.
   \item [description] This can be any kind of description.    \item [description] This can be any kind of description.
   \item [keywords] Keywords related to the manuscript.    \item [keywords] Keywords related to the manuscript.
     \item[call-number] Call number in holding library
     \item[holding-library] Holding library
     \end{description}
   \end{description}
   
   
   \subsubsection{Correspondence}
   
   \begin{description}
   \item [bib type="correspondence"] a piece of correspondence e.g. letter, telegram, in the following called ``letter''
   
     \begin{description}
     \item[type] The type of correspondence, e.g. ``letter'', ``postcard'', ``telegram'', ``letter draft''
     \item [author] The author/sender of the letter.
     \item [recipient] The recipient of the letter.
     \item [date] normalised date of the letter.
     \item [date-range-end] end of range of uncertain dating -- optional.
     \item [date-original] the date in its original form as noted on the letter -- optional.
     \item [place] place where the letter was written/sent.
     \item [title] Title of the letter -- optional.
     \item[incipit] The opening phrase of the letter -- optional.
     \item[excipit] The closing phrase of the letter -- optional.
     \item [pages] Number of pages of the manuscript.
     \item [signature] Canonical signature/call number of the manuscript.
     \item [description] This can be any kind of description.
     \item [keywords] Keywords related to the manuscript.
     \item[call-number] Call number in the current holding library
     \item[holding-library] current holding library
   \end{description}    \end{description}
 \end{description}  \end{description}
   
Line 793  on page\pageref{tag-content-type}} ``ful Line 907  on page\pageref{tag-content-type}} ``ful
   
 The relation between the full text and optional images of  The relation between the full text and optional images of
 whole pages or parts of pages must be specified in a  whole pages or parts of pages must be specified in a
 \texttt{text-tool} container.  \texttt{texttool} container.
   
 \begin{description}  \begin{description}
 \item[text-tool] representation of full text with images  \item[texttool] representation of full text with images
   
   \begin{description}    \begin{description}
   \item[text-file] the file name of the full text file (with path    \item[text] the file name of the full text file (path
     inside document directory)      inside document directory)
           
   \item[page-images] the directory name of the directory containig the    \item[text-url-path] a characteristic part of the URL with which the
     page image files (with path inside document directory)      full text can be retrieved (the form and content of this element
       is dependent on the specific text retrieval mechanism)
   
   \item[xslt-file] the file name of an additional XSL transformation    \item[image] the directory name of the directory containig the
     file      page image files (path inside document directory)
   
   \item[text-config] container for configuration options    \item[figure] the directory name of the directory containig the
     \begin{description}      in-page figure image files (path inside document directory)
     \item[container-tag] the name of the text root element (default  
       ``text'')  
               
     \item[ref-element-tag] the name of the element that is used as    \item[xslt] the file name of an additional XSL transformation
       unit of reference when results are presented      file
           
     \item[pagebreak-tag] the name of the element that indicates page    \item[pagebreak] the name of the element that indicates page breaks
       breaks (default ``pb'')      (default ``pb'')
     \end{description}  
   \end{description}    \end{description}
 \end{description}  \end{description}
   
Line 829  whole pages or parts of pages must be sp Line 941  whole pages or parts of pages must be sp
   
 If the access to a resource is bound to conditions for technical or legal  If the access to a resource is bound to conditions for technical or legal
 reasons then the conditions can be put in a \texttt{access-conditions}  reasons then the conditions can be put in a \texttt{access-conditions}
 container. Other access rights conditions like copyright can also be  container. Other usage conditions like copyright can also be
 documented in this container.  documented in this container.
   
 \begin{description}  \begin{description}
Line 845  documented in this container. Line 957  documented in this container.
   
     \item[url] a URL (with an optional \texttt{label} attribute to show      \item[url] a URL (with an optional \texttt{label} attribute to show
       as text)        as text)
   
       \item[description] more information (free text, e.g. holding
         library call number)
     \end{description}      \end{description}
   
   \item[copyright] the copyright owner and it's conditions    \item[copyright] the copyright holder and it's conditions
     \begin{description}      \begin{description}
     \item[owner] the name of the copyright owner      \item[owner] the name of the copyright holder
       \begin{description}        \begin{description}
       \item[name] a name (free text)        \item[name] a name (free text)
   
Line 859  documented in this container. Line 974  documented in this container.
   
     \item[date] the date when the copyright was issued      \item[date] the date when the copyright was issued
   
     \item[duration] the duration of the copyright (if known)      \item[duration] the duration of the copyright term (if known)
   
     \item[description] free-text field for special or additional      \item[description] free-text field for special or additional
       conditions        conditions
     \end{description}      \end{description}
   
   \item[access] conditions of access to this resource  
     \item[publish-metadata] metadata about this resource can be made
       freely available when this tag is present (otherwise metadata has
       the same access conditions as the rest of the resource). Access to
       the resource itself is regulated separately by the \texttt{access}
       element.
   
     \item[access] conditions of access to this resource. Different
       access types are specified by a \texttt{type} attribute:
     \begin{description}      \begin{description}
     \item[internal] access should be restricted to a group of users. The      \item[type=group] access restricted to the members of this named
       type of group is defined by one of the following        group. The method to identify a user belonging to a named group
         is not specified in this document.
         \begin{description}
         \item[name] name of the group.
   
         \item[only-before] the access condition is only valid before the
           given date (format: ``YYYY/MM/DD'').
   
         \item[only-after] the access condition is only valid after the
           given date (format: ``YYYY/MM/DD'').
         \end{description}
       
       \item[type=institution] access restricted to the members of this
         institution. The method to identify a user to belong to the
         institution is not specified in this document.
       \begin{description}        \begin{description}
       \item[institution] the members of this institution. The method        \item[name] name of the group.
         to identify a user to belong to the institution is not  
         specified in this document.  
   
       \item[subnet] all computers with an IP-address in this subnet. The        \item[only-before] the access condition is only valid before the
         subnet is defined in ``truncated-quad'' (e.g. ``141.14'') or          given date (format: ``YYYY/MM/DD'').
         ``adress/netmask'' (e.g. ``141.14.0.0/255.255.0.0'') notation.  
                   
       \item[group] the members of this named group. The method to        \item[only-after] the access condition is only valid after the
         identify a user to belong to a named group is not specified in          given date (format: ``YYYY/MM/DD'').
         this document.  
       \end{description}        \end{description}
   
     \item[scientific] access to this resource should be restricted to  
       \item[type=subnet] access restricted to all computers with an
         IP-address in this subnet.
         \begin{description}
         \item[range] subnet range defined in
         truncated-quad (e.g. ``141.14''), network-netmask
         (e.g. ``141.14.0.0/255.255.0.0''), or network-range
         (e.g. ``141.14.0.0/16'') notation.
   
         \item[only-before] the access condition is only valid before the
           given date (format: ``YYYY/MM/DD'').
   
         \item[only-after] the access condition is only valid after the
           given date (format: ``YYYY/MM/DD'').
         \end{description}
       
           
       \item[type=scientific] access to this resource should be restricted to
       scientific work        scientific work
         \begin{description}
         \item[only-before] the access condition is only valid before the
           given date (format: ``YYYY/MM/DD'').
   
         \item[only-after] the access condition is only valid after the
           given date (format: ``YYYY/MM/DD'').
         \end{description}
   
     \item[free] access to this resource is not restricted  
               
     \item[special] if none of the above conditions seems appropriate,      \item[type=free] access to this resource is not restricted
         \begin{description}
         \item[only-before] the access condition is only valid before the
           given date (format: ``YYYY/MM/DD'').
   
         \item[only-after] the access condition is only valid after the
           given date (format: ``YYYY/MM/DD'').
         \end{description}
       
         
       \item[type=special] if none of the above conditions seems appropriate,
       a free-form text can be specified here.        a free-form text can be specified here.
         \begin{description}
         \item[description] description of special access conditions.
   
         \item[only-before] the access condition is only valid before the
           given date (format: ``YYYY/MM/DD'').
   
         \item[only-after] the access condition is only valid after the
           given date (format: ``YYYY/MM/DD'').
         \end{description}
       
     \end{description}      \end{description}
   \end{description}    \end{description}
 \end{description}  \end{description}
   
 \noindent  \noindent
 It should be noted that control over the access to the resource has to  It should be noted that control over access to the resource has to be
 be provided by additional technical measures. Access conditions in the  provided by additional technical measures. Access conditions in the
 metadata file only state that conditions \emph{should} be observed,  metadata file only state that conditions \emph{should} be observed, it
 not that they \emph{are} necessarily observed, as the enforcement of  is not implied that they \emph{are} necessarily observed, as the
 conditions depends on additional technical measures.  enforcement of conditions depends on additional measures.
   
   
   
Line 923  provided in an \texttt{acquisition} cont Line 1099  provided in an \texttt{acquisition} cont
     \item[contact] contact person at the provider (i.e. name and email)      \item[contact] contact person at the provider (i.e. name and email)
   
     \item[url] URL related to the provider      \item[url] URL related to the provider
   
       \item[provider-id] id of the provider (internally used) -- deduced
     \end{description}      \end{description}
   
   \item[date] date of acquisition -- required    \item[date] date of acquisition -- required

Removed from v.1.12  
changed lines
  Added in v.1.22


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>