[BACK]Return to meta-format.tex CVS log [TXT] [DIR] Up to [Repository] / storage / meta

Diff for /storage/meta/meta-format.tex between versions 1.15 and 1.16

version 1.15, 2004/07/16 13:45:49 version 1.16, 2005/11/24 18:52:57
Line 16 Line 16
   
 \author{Robert Casties, Dirk Wintergrün, Hans-Christoph Liess}  \author{Robert Casties, Dirk Wintergrün, Hans-Christoph Liess}
   
 \date{V1.2 of 16.7.2004}  \date{V1.3 of 24.11.2005}
   
 \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}
   
Line 125  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 133  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 148  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 212  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 250  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 864  whole pages or parts of pages must be sp Line 879  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 882  documented in this container. Line 897  documented in this container.
       as text)        as text)
     \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 894  documented in this container. Line 909  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
Line 902  documented in this container. Line 917  documented in this container.
   
   
   \item[publish-metadata] metadata about this resource can be made    \item[publish-metadata] metadata about this resource can be made
   freely available when this tag is present. Access to the resource      freely available when this tag is present (otherwise metadata has
   itself is regulated separately by the \texttt{access} element.      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[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}      \begin{description}
     \item[internal] access should be restricted to a group of users. The        \item[name] name of the group.
       type of group is defined by one of the following  
         \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[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}        \begin{description}
       \item[institution] the members of this institution. The method        \item[range] subnet range defined in
         to identify a user to belong to the institution is not        truncated-quad (e.g. ``141.14''), network-netmask
         specified in this document.        (e.g. ``141.14.0.0/255.255.0.0''), or network-range
         (e.g. ``141.14.0.0/16'') notation.
   
       \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=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[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[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.        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.
   
   
   
Removed from v.1.15  
changed lines
  Added in v.1.16

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