--- storage/meta/meta-format.tex	2004/07/16 13:45:49	1.15
+++ storage/meta/meta-format.tex	2010/08/27 15:30:21	1.23
@@ -16,7 +16,7 @@
 
 \author{Robert Casties, Dirk Wintergrün, Hans-Christoph Liess}
 
-\date{V1.2 of 16.7.2004}
+\date{V1.3.7 of 27.8.2010}
 
 \begin{document}
 
@@ -59,20 +59,20 @@ files are possible:
 \begin{itemize}
 \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
-  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}
 
 The resource directory must contain an \texttt{index.meta} file with
-information about the resource as a whole. Other directories can
-contain \texttt{index.meta} files.
+information about the resource as a whole. Subdirectories can
+contain additional \texttt{index.meta} files.
 
 Additional information about single data files that are part of the
 resource can either be put in \texttt{file} tags in the
 \texttt{index.meta} file or in separate \emph{filename}\texttt{.meta}
 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}
@@ -96,7 +96,7 @@ The outer container element is \texttt{r
 \item[type] sub-type of resource (e.g. ``ECHO'', ``MPIWG'') --
   optional.
   
-\item[version] version number of metadata format (currently 1.1) --
+\item[version] version number of metadata format (currently 1.2) --
   required.
 \end{description}
 
@@ -125,7 +125,7 @@ The outer container element is \texttt{r
   whole archive collection, including the resource directory -- deduced.
 
 \item[archive-id] The ID for this document in the archive --
-  required.
+  optional.
   
 \item[derived-from] Container for the description of the original
   resource if this resource is a modified version of another resource
@@ -133,10 +133,25 @@ The outer container element is \texttt{r
 
   \begin{description}
   \item[archive-id] The ID of the original resource
-    -- required.
+    -- required (or archive-path).
 
   \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
   of this resource to the original resource -- optional.
@@ -148,10 +163,10 @@ The outer container element is \texttt{r
 
   \begin{description}
   \item[archive-id] The ID of the linked resource
-    -- required.
+    -- required (or archive-path).
 
   \item[archive-path] The full path to the linked resource
-    -- deduced.
+    -- required (or archive-id).
 
   \item[description] An informal textual description of the relation
   of this resource to the linked resource -- optional.
@@ -212,10 +227,10 @@ The outer container element is \texttt{r
   \item[name] The name of the file -- required.
     
   \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
-    section~\ref{sec:file-directory-names} but it should be possible
-    to reference the original name.)
+    section~\ref{sec:file-directory-names} it is possible
+    to preserve the original name.)
     
   \item[path] The directory path of this file relative to the
     resource's root directory (excluding the file itself) -- required
@@ -250,7 +265,7 @@ The outer container element is \texttt{r
 All elements with \texttt{meta} tags can contain an arbitrary number
 of the following additional metadata elements.
 
-\subsection{workflow state}
+\subsection{Workflow state}
 \label{sec:workflow-state}
 
 All additional metadata elements can have a \texttt{workflow-state}
@@ -402,6 +417,8 @@ the commonly used program ``EndNote''.
     published in multiple volumes.
   \item [translator] Name of the translator.
   \item [isbn-issn]
+  \item[call-number] Call number in holding library
+  \item[holding-library] Holding library
   \end{description}
 \end{description}
 
@@ -430,6 +447,8 @@ the commonly used program ``EndNote''.
     published in multiple volumes.
   \item [translator] Name of the translator
   \item [isbn-issn]
+  \item[call-number] Call number in holding library
+  \item[holding-library] Holding library
   \end{description}
 \end{description}
 
@@ -458,6 +477,8 @@ the commonly used program ``EndNote''.
   \item [number-of-volumes] Number of volumes, if the the book is
     published as multiple volumes.
   \item [isbn-issn]
+  \item[call-number] Call number in holding library
+  \item[holding-library] Holding library
   \end{description}
 \end{description}
 
@@ -483,6 +504,26 @@ the commonly used program ``EndNote''.
   \item [number-of-volumes] Number of volumes, if the the book is
     published as multiple volumes.
   \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}
 
@@ -500,6 +541,8 @@ the commonly used program ``EndNote''.
   \item [pages] Number of pages of the article.
   \item [alternate-journal] Alternate Journal
   \item [isbn-issn]
+  \item[call-number] Call number in holding library
+  \item[holding-library] Holding library
   \end{description}
 \end{description}
 
@@ -516,6 +559,8 @@ the commonly used program ``EndNote''.
   \item [issue-number] Number of the issue the article is part of.
   \item [pages Number] of pages of the article.
   \item [date] Date when the article appeared.
+  \item[call-number] Call number in holding library
+  \item[holding-library] Holding library
   \end{description}
 \end{description}
 
@@ -531,6 +576,8 @@ the commonly used program ``EndNote''.
   \item [pages] Number of pages of the article.
   \item [issue-date] Date of the issue the article is part of.
   \item [city] City of the newspaper.
+  \item[call-number] Call number in holding library
+  \item[holding-library] Holding library
   \end{description}
 \end{description}
 
@@ -549,6 +596,8 @@ the commonly used program ``EndNote''.
   \item [University] Name of the university where the thesis was
     handed in.
   \item [isbn-issn]
+  \item[call-number] Call number in holding library
+  \item[holding-library] Holding library
   \end{description}
 \end{description}
 
@@ -566,6 +615,8 @@ the commonly used program ``EndNote''.
   \item [institution] Institution where the report was produced.
   \item [type] Type of report.
   \item [report-number] Report number.
+  \item[call-number] Call number in holding library
+  \item[holding-library] Holding library
   \end{description}
 \end{description}
 
@@ -587,6 +638,107 @@ the commonly used program ``EndNote''.
     annotations etc.
   \item [description] This can be any kind of description.
   \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{Extended Manuscript}
+
+\begin{description}
+\item [bib type="extended-manuscript"] a handwritten/typewritten manuscript
+with detailed information about the manuscripts appearance.
+
+  \begin{description}
+  \item [title] Title of the manuscript.
+  \item [author] The author of the text.
+   \item[holding-library] Holding library
+   \item[call-number] Call number/Shelf mark in holding library
+  \item[location] Place/City/Country where the manuscript is
+    currently located.
+  \item[date calendar="type"] The date of publication with attribute which
+  calendar used. If no attribute used, CE is the default. Can also be
+  descriptive.
+  \item[year calendar="type"] approximate year or century 
+  \item[number-of-folios] Number of folios/pages of the manuscript.
+  \item[signature] Signature(s) of the manuscript, under which a manuscript is
+  known.
+  \item[abstract] Interpretative abstract of the text's content
+  \item[incipit] Incipit
+  \item[explicit] Explicit
+  \item[contents] Formal description of the text structure (e.g. table of
+  contents)
+  \item[writing-surface] material of the writing surface (e.g. non-european
+  paper, palm leaf,\ldots)
+  \item[foliation] Text giving list or range of folios 
+  \item[page-dimensions] height and width in cm
+  \item[written-area-dimensions] height and width in cm
+  \item[lines-per-page] number of lines and columns
+  \item[catchwords] Quire signatures and catchwords
+  \item[scripts] Description of the script
+  \item[copyist] Copyist
+  \item[collation-corrections] Notes on collation and corrections
+  \item[binding] Binding
+  \item[notes] Additional notes
+  \item[secondary-literature] Notes on secondary literature related to the
+  manuscript
+  \item [editorial-remarks] Remarks related to the online
+    publication of the manuscript.
+
+  \item [keywords] Keywords related to the manuscript.
+ 
+ 
+  \end{description}
+\end{description}
+
+\subsubsection{Codex}
+
+\begin{description}
+\item [bib type="codex"] Codex
+
+  \begin{description}
+  
+   \item[holding-library] Holding library
+   \item[call-number] Call number/Shelf mark in holding library
+  \item[location] Place/City/Country where the codex is
+    currently located.
+  \item[date calendar="type"] Date of the collation of the codex.
+  \item[year calendar="type"] approximate year or century 
+  \item[number-of-folios] Number of folios/pages of the manuscript.
+  \item[signature] Signature(s) of the manuscript, under which a manuscript is
+  known.
+  \item[contents] Formal description of the text structure (e.g. table of
+  contents)
+  \item[dimensions] height + width in cm
+   \item[binding] Binding
+  \item[notes] Additional notes
+  \item[notes-on-ownership] Notes on ownership
+  \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}
 
@@ -828,32 +980,30 @@ on page\pageref{tag-content-type}} ``ful
 
 The relation between the full text and optional images of
 whole pages or parts of pages must be specified in a
-\texttt{text-tool} container.
+\texttt{texttool} container.
 
 \begin{description}
-\item[text-tool] representation of full text with images
-
+\item[texttool] representation of full text with images
+  
   \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)
     
-  \item[page-images] the directory name of the directory containig the
-    page image files (with path inside document directory)
+  \item[text-url-path] a characteristic part of the URL with which the
+    full text can be retrieved (the form and content of this element
+    is dependent on the specific text retrieval mechanism)
+    
+  \item[image] the directory name of the directory containig the
+    page image files (path inside document directory)
+
+  \item[figure] the directory name of the directory containig the
+    in-page figure image files (path inside document directory)
 
-  \item[xslt-file] the file name of an additional XSL transformation
+  \item[xslt] the file name of an additional XSL transformation
     file
 
-  \item[text-config] container for configuration options
-    \begin{description}
-    \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
-      unit of reference when results are presented
-    
-    \item[pagebreak-tag] the name of the element that indicates page
-      breaks (default ``pb'')
-    \end{description}
+  \item[pagebreak] the name of the element that indicates page breaks
+    (default ``pb'')
   \end{description}
 \end{description}
 
@@ -864,7 +1014,7 @@ whole pages or parts of pages must be sp
 
 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}
-container. Other access rights conditions like copyright can also be
+container. Other usage conditions like copyright can also be
 documented in this container.
 
 \begin{description}
@@ -880,11 +1030,14 @@ documented in this container.
 
     \item[url] a URL (with an optional \texttt{label} attribute to show
       as text)
+
+    \item[description] more information (free text, e.g. holding
+      library call number)
     \end{description}
 
-  \item[copyright] the copyright owner and it's conditions
+  \item[copyright] the copyright holder and it's conditions
     \begin{description}
-    \item[owner] the name of the copyright owner
+    \item[owner] the name of the copyright holder
       \begin{description}
       \item[name] a name (free text)
 
@@ -894,7 +1047,7 @@ documented in this container.
 
     \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
       conditions
@@ -902,44 +1055,100 @@ documented in this container.
 
 
   \item[publish-metadata] metadata about this resource can be made
-  freely available when this tag is present. Access to the resource
-  itself is regulated separately by the \texttt{access} element.
+    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
+  \item[access] conditions of access to this resource. Different
+    access types are specified by a \texttt{type} attribute:
     \begin{description}
-    \item[internal] access should be restricted to a group of users. The
-      type of group is defined by one of the following
+    \item[type=group] access restricted to the members of this named
+      group. The method to identify a user belonging to a named group
+      is not specified in this document.
       \begin{description}
-      \item[institution] the members of this institution. The method
-        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
-        subnet is defined in ``truncated-quad'' (e.g. ``141.14'') or
-        ``adress/netmask'' (e.g. ``141.14.0.0/255.255.0.0'') notation.
-        
-      \item[group] the members of this named group. The method to
-        identify a user to belong to a named group is not specified in
-        this document.
+      \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}
+      \item[name] name of the group.
+
+      \item[only-before] the access condition is only valid before the
+        given date (format: ``YYYY/MM/DD'').
 
-    \item[scientific] access to this resource should be restricted to
+      \item[only-after] the access condition is only valid after the
+        given date (format: ``YYYY/MM/DD'').
+      \end{description}
+    
+
+    \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
+      \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=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[free] access to this resource is not restricted
+      \item[only-after] the access condition is only valid after the
+        given date (format: ``YYYY/MM/DD'').
+      \end{description}
+    
       
-    \item[special] if none of the above conditions seems appropriate,
+    \item[type=special] if none of the above conditions seems appropriate,
       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}
 
 \noindent
-It should be noted that control over the access to the resource has to
-be provided by additional technical measures. Access conditions in the
-metadata file only state that conditions \emph{should} be observed,
-not that they \emph{are} necessarily observed, as the enforcement of
-conditions depends on additional technical measures.
+It should be noted that control over access to the resource has to be
+provided by additional technical measures. Access conditions in the
+metadata file only state that conditions \emph{should} be observed, it
+is not implied that they \emph{are} necessarily observed, as the
+enforcement of conditions depends on additional measures.