Diff for /storage/meta/meta-format.tex between versions 1.18 and 1.31

version 1.18, 2007/04/02 16:28:04 version 1.31, 2011/08/09 11:56:57
Line 3 Line 3
 \usepackage[latin1]{inputenc}  \usepackage[latin1]{inputenc}
 \usepackage[T1]{fontenc}  \usepackage[T1]{fontenc}
 \usepackage{ae}  \usepackage{ae}
 %\usepackage{times}  \usepackage{times}
 %\usepackage{courier}  \usepackage{courier}
   
 % create in-text links black (with PDF)  % create in-text links in black (with PDF)
 \usepackage[colorlinks=true,linkcolor=black]{hyperref}  \usepackage[colorlinks=true,linkcolor=black]{hyperref}
 % Format URLs nicely (without PDF)  % Format URLs nicely (without PDF)
 %\usepackage{url}  %\usepackage{url}
Line 16 Line 16
   
 \author{Robert Casties, Dirk Wintergrün, Hans-Christoph Liess}  \author{Robert Casties, Dirk Wintergrün, Hans-Christoph Liess}
   
 \date{V1.3.2 of 2.4.2007}  \date{V1.4.1 of 8.8.2011}
   
 \begin{document}  \begin{document}
   
Line 172  The outer container element is \texttt{r Line 172  The outer container element is \texttt{r
   of this resource to the linked resource -- optional.    of this resource to the linked resource -- optional.
   \end{description}    \end{description}
       
   \item[is-part-of] Container for the description of another resource if this 
     resource is a part of the other resource.  -- optional. It can have a 
     \texttt{type} attribute describing the type of relation .e.g. ``manuscript-codex''.
   
     \begin{description}
     \item[archive-id] The ID of the original resource
       -- required (or archive-path).
   
     \item[archive-path] The full path to the original resource
       -- required (or archive-id).
   
     \item[description] An informal textual description of the relation
     of this resource to the original resource -- optional.
     \end{description}
     
 \item[media-type] \label{tag-media-type} The main media type of this  \item[media-type] \label{tag-media-type} The main media type of this
   resource -- required.\\ The main media type can be overridden by    resource -- required.\\ The main media type can be overridden by
   \texttt{media-type}s in subdirectories. Possible types are    \texttt{media-type}s in subdirectories. Possible types are
Line 298  Metadata elements can appear multiple ti Line 313  Metadata elements can appear multiple ti
   The content type enables the choice of tools to manipulate and    The content type enables the choice of tools to manipulate and
   display the resource. There should be a common list of content    display the resource. There should be a common list of content
   types. For digital documents (books, manuscripts) this would be    types. For digital documents (books, manuscripts) this would be
   "scanned document", for other image data "scanned    ``scanned document'', for other image data ``scanned
   images".\footnote{The criterion for documents is a ordered    images''.\footnote{The criterion for documents is a ordered
     succession of image files (pages) and equal image size and      succession of image files (pages) and equal image size and
     resolution throughout the images of a resource.}      resolution throughout the images of a resource.}
 \end{description}    \end{description}  
Line 643  the commonly used program ``EndNote''. Line 658  the commonly used program ``EndNote''.
   \end{description}    \end{description}
 \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 (beginning of text).
     \item[explicit] Explicit (end of text).
     \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 and the ink used.
     \item[copyist] Copyist.
     \item[collation-corrections] Notes on collation and corrections.
     \item[binding] Description of binding.
     \item[notes-on-ownership] Notes on ownership.
     \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 i.e. bound collection of one or more manuscripts.
   
     \begin{description}
   %TODO: do we need collection information?
     \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[foliation] Text giving list or range of folios.
     \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] Description of 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[explicit] 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}
   
   
 \subsubsection{Generic}  \subsubsection{Generic}
   
Line 679  the commonly used program ``EndNote''. Line 792  the commonly used program ``EndNote''.
 \end{description}  \end{description}
   
   
 \subsection{Architectural drawings}  
 \label{sec:doc}  
   
 Specific information for architectural drawings is presented in a  
 \texttt{doc} container with an additional \texttt{type} attribute  
 giving the type of drawing. All elements inside the container can  
 appear multiple times.  
   
 \begin{description}  
   
 \item[doc type="Architectural Drawing"] architectural drawing.  
   
   \begin{description}  
   \item [person] last name and first name of a person, separated by a  
     comma. A further common name for the person can be put infront,  
     separated by a semicolon.  
   \item [location] Name of a place in its common notation. This can be  
     a city or a institution.  
   \item [date] This can be a year (or several years, separated by  
     commas) or a period (1706-1714). Years are noted with four digits.  
   \item [object] Short description of an object or signatures.  
   \item [keywords] Keywords related to the object.  
 \end{description}  
 \end{description}  
   
   
 \subsection{Document structure (table of contents)}  \subsection{Document structure (table of contents)}
 \label{sec:toc}  \label{sec:toc}
   
Line 712  Information on the structure of a docume Line 799  Information on the structure of a docume
 parts and chapters in the way of a table of contents is presented in a  parts and chapters in the way of a table of contents is presented in a
 \texttt{toc} container.   \texttt{toc} container. 
   
 The scheme allows multiple logical pages on a single page image  This scheme allows multiple logical pages on a single page image
 as it is often the case with scanned books or manuscripts. The scheme  as it is often the case with scanned books or manuscripts. The scheme
 also allows for ``loose'' numbering schemes with roman, arabic or  also allows for ``loose'' numbering schemes with roman, arabic or
 other page numbers consecutively or mixed and changes in the numbering  other page numbers consecutively or mixed and changes in the numbering
Line 739  tags. Line 826  tags.
       like ``Table 5''.        like ``Table 5''.
               
     \item[index] the \texttt{digilib} index number\footnote{The index      \item[index] the \texttt{digilib} index number\footnote{The index
         number for digilib is the index in the alphabetical order of the          number for digilib is the index in the alphabetical ordering of the
         scan file names.} of the scan image of the page.          scan file names.} of the scan image of the page.
               
     \item[url] alternatively to the \texttt{digilib} index number the      \item[file] alternatively the file name (preferrably without extension) of the
       full URL of the scan image of the page can be used.        scan image of the page.
         
       \item[url] alternatively the full URL of the scan image of the
         page can be used.
     \end{description}      \end{description}
           
   \item[chapter] describes a section or chapter of the text.    \item[chapter] describes a section or chapter of the text.
Line 764  tags. Line 854  tags.
                   
       \item[index] the index of the first page (see \texttt{page}).        \item[index] the index of the first page (see \texttt{page}).
                   
         \item[file] the file name of the first page (see \texttt{page}).
           
       \item[url] the URL of the first page (see \texttt{page}).        \item[url] the URL of the first page (see \texttt{page}).
       \end{description}        \end{description}
               
Line 775  tags. Line 867  tags.
                   
       \item[index] the index of the last page (see \texttt{page}).        \item[index] the index of the last page (see \texttt{page}).
                   
         \item[file] the file name of the first page (see \texttt{page}).
           
       \item[url] the URL of the last page (see \texttt{page}).        \item[url] the URL of the last page (see \texttt{page}).
       \end{description}        \end{description}
               
Line 875  digital image. Line 969  digital image.
 \subsection{Full text with images}  \subsection{Full text with images}
 \label{sec:full-text-with}  \label{sec:full-text-with}
   
   The relation between a full text and optional images of
   whole pages or parts of pages must be specified in a
   \texttt{texttool} container.
   
 Full text in a XML format should be specified with a  Full text in a XML format should be specified with a
 \texttt{content-type}\footnote{see section~\ref{tag-content-type}  \texttt{content-type}\footnote{see section~\ref{tag-content-type}
 on page\pageref{tag-content-type}} ``fulltext''.  on page\pageref{tag-content-type}} ``fulltext''.
   
 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.  
   
 \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      
     file    \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[page-flow] the reading direction of pages in this document:
       either ``ltr'' (left-to-right, standard western page flow) or
       ``rtl'' (right-to-left, still assuming increasing page numbers)
   
    \item[odd-scan-position] the orientation of all odd-numbered scan
       pages regardless of \texttt{page-flow}: either ``left'' (all
       odd-numbered scans are left hand sides) or ``right'' (all
       odd-numbered scans are right hand sides, i.e. the first left hand
       side is scan number 2).
   
   \item[text-config] container for configuration options    \item[title-scan-no] the index number of the scan of the title page or the
     \begin{description}      first text page
     \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 922  documented in this container. Line 1028  documented in this container.
   
 \begin{description}  \begin{description}
 \item[access-conditions] legal and technical conditions for access to  \item[access-conditions] legal and technical conditions for access to
   this resource    this resource. \\
     The \texttt{attribution}, \texttt{copyright}, and \texttt{access}
     tags can be repeated with different \texttt{resource} attributes if
     different conditions apply to different parts of the whole resource.
   
   \begin{description}    \begin{description}
   \item[attribution] The name or institution this resource should be    \item[attribution] The name or institution this resource should be
     attributed to when it's publicly presented      attributed to when it's publicly presented. \\
       The kind of resource this condition applies to can be specified with a
       \texttt{resource} attribute with the values ``original'' (the
       physical object that was scanned), ``digital-image'' (the scanned
       images), ``text'' (the textual transcript). \\
       All tags inside can be repeated.
   
     \begin{description}      \begin{description}
     \item[name] a name (free text)      \item[name] a name (free text)
Line 938  documented in this container. Line 1052  documented in this container.
       library call number)        library call number)
     \end{description}      \end{description}
   
   \item[copyright] the copyright holder and it's conditions    \item[copyright] the copyright holder and the copyright conditions. \\
       The kind of resource this condition applies to can be specified with a
       \texttt{resource} attribute with the values ``original'' (the physical object 
       that was scanned), ``digital-image'' (the scanned images), ``text'' 
       (the textual transcript).
   
     \begin{description}      \begin{description}
     \item[owner] the name of the copyright holder      \item[owner] the name of the copyright holder
       \begin{description}        \begin{description}
       \item[name] a name (free text)        \item[name] a name (free text)
   
       \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) identifying the copyright holder
       \end{description}        \end{description}
   
     \item[date] the date when the copyright was issued      \item[date] the date when the copyright was issued
Line 954  documented in this container. Line 1073  documented in this container.
   
     \item[description] free-text field for special or additional      \item[description] free-text field for special or additional
       conditions        conditions
       \item[license] the type of license if its a standardised license e.g. Creative Commons
         \begin{description}
         \item[url] a URL representing the license e.g. \url{http://creativecommons.org/licenses/by/3.0/}
     \end{description}      \end{description}
   
       \end{description}
   
   \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    \item[access] conditions of access to this resource. Different
     access types are specified by a \texttt{type} attribute:      access types are specified by a \texttt{type} attribute.
       The kind of resource this condition applies to can be specified with a
       \texttt{resource} attribute with the values ``digital-image'' (the
       scanned images), or ``text'' (the textual transcript).
   
     \begin{description}      \begin{description}
     \item[type=group] access restricted to the members of this named      \item[type=group] access restricted to the members of this named
       group. The method to identify a user belonging to a named group        group. The method to identify a user belonging to a named group

Removed from v.1.18  
changed lines
  Added in v.1.31


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