Annotation of storage/meta/meta-format.tex, revision 1.31

1.1       casties     1: \documentclass[a4paper]{article}
                      2: 
                      3: \usepackage[latin1]{inputenc}
                      4: \usepackage[T1]{fontenc}
                      5: \usepackage{ae}
1.29      casties     6: \usepackage{times}
                      7: \usepackage{courier}
1.1       casties     8: 
1.29      casties     9: % create in-text links in black (with PDF)
1.6       casties    10: \usepackage[colorlinks=true,linkcolor=black]{hyperref}
1.1       casties    11: % Format URLs nicely (without PDF)
1.6       casties    12: %\usepackage{url}
1.1       casties    13: 
                     14: 
                     15: \title{A simple metadata format for resource bundles}
                     16: 
1.4       casties    17: \author{Robert Casties, Dirk Wintergrün, Hans-Christoph Liess}
1.1       casties    18: 
1.31    ! casties    19: \date{V1.4.1 of 8.8.2011}
1.1       casties    20: 
                     21: \begin{document}
                     22: 
                     23: \maketitle
                     24: 
                     25: \tableofcontents
                     26: 
                     27: 
                     28: \section{File and directory names}
                     29: \label{sec:file-directory-names}
                     30: 
                     31: File and directory names should not contain spaces. Allowed characters
                     32: in filenames are only the alphanumeric set a-z, A-Z, 0-9, hyphen
                     33: ``-'', underscore ``\_'' and dot ``.''.
                     34: 
1.12      casties    35: Files and directories with names that contain illegal characters must
                     36: be transformed to allowed names. A proposition for a simple
                     37: transformation rule is
                     38: 
                     39: \begin{itemize}
                     40: \item whitespace characters (e.g. blank, tab, cr, lf) are replaced by
                     41:   hyphens ``-''
                     42: 
                     43: \item other illegal characters are replaced by underscores ``\_''.
                     44: \end{itemize}
                     45: 
                     46: This rule does not provide a reversible mapping to the original
                     47: illegal file name and it does not provide a collision-free mapping,
                     48: i.e. two different illegal file names might be mapped to the same
                     49: allowed file name. Additional precautions for these cases must be
                     50: taken.
1.1       casties    51: 
1.4       casties    52: 
                     53: \section{Metadata files}
                     54: \label{sec:metadata-files}
                     55: 
                     56: The metadata information is stored in the XML format documented below
                     57: in special files in the resource directory. Two forms of metadata
                     58: files are possible:
                     59: \begin{itemize}
                     60: \item a file named \texttt{index.meta} in a directory.
                     61: 
1.16      casties    62: \item a file with the same name as the data file it describes and an
1.4       casties    63:   additional extension \texttt{.meta}. For example metadata for the
1.16      casties    64:   file \texttt{p0001.tif} would be in a file \texttt{p0001.tif.meta}.
1.4       casties    65: \end{itemize}
                     66: 
                     67: The resource directory must contain an \texttt{index.meta} file with
1.16      casties    68: information about the resource as a whole. Subdirectories can
                     69: contain additional \texttt{index.meta} files.
1.4       casties    70: 
                     71: Additional information about single data files that are part of the
                     72: resource can either be put in \texttt{file} tags in the
                     73: \texttt{index.meta} file or in separate \emph{filename}\texttt{.meta}
                     74: files for each data file. Information from the directory level file is
1.16      casties    75: inherited at the file level when it is not overwritten.
1.4       casties    76: 
                     77: 
1.1       casties    78: \section{Resource format}
                     79: \label{sec:mpiwg-doc}
                     80: 
                     81: In this description elements marked ``optional'' need not be supplied
                     82: by the provider of the resource and may be absent in all versions of
                     83: the metadata file. Elements marked ``required'' must be supplied by
                     84: the provider of the resource. Elements marked ``deduced'' can be
                     85: supplied by the provider of the resource but can also be provided by
1.4       casties    86: automatic scripts later in the process, these elements must be present
1.1       casties    87: in the final file.
                     88: 
1.12      casties    89: File and directory paths in the metadata file use the conventional
                     90: Unix file separator slash ``/''.
                     91: 
1.11      casties    92: The outer container element is \texttt{resource}. It has the following
                     93: \textbf{attributes}:
                     94: 
                     95: \begin{description}
1.12      casties    96: \item[type] sub-type of resource (e.g. ``ECHO'', ``MPIWG'') --
                     97:   optional.
1.11      casties    98:   
1.16      casties    99: \item[version] version number of metadata format (currently 1.2) --
1.11      casties   100:   required.
                    101: \end{description}
                    102: 
                    103: \noindent The allowed \textbf{elements} inside \texttt{resource} are:
1.1       casties   104: 
                    105: \begin{description}
1.14      casties   106: \item[description] An informal textual description of the resource --
                    107:   optional\footnote{At least one description of the resource's content
                    108:     is required. The description can be an informal
                    109:     \texttt{description} element or a descriptive element (like
                    110:     \texttt{bib}) in a \texttt{meta} container.}.
1.1       casties   111: 
                    112: \item[name] The filename of the resource (name of the directory this
                    113:   file is contained in) -- required.
                    114: 
                    115: \item[creator] The name of the project or person that created the
                    116:   resource -- optional.
1.4       casties   117:   
                    118: \item[archive-creation-date] The time and date the archive collection
                    119:   was created -- deduced.
1.1       casties   120: 
1.4       casties   121: \item[archive-storage-date] The time and date the archive was written
                    122:   to permanent storage -- deduced (must not be set by the user).
1.1       casties   123: 
                    124: \item[archive-path] The full path to the resource directory inside the
1.5       casties   125:   whole archive collection, including the resource directory -- deduced.
1.12      casties   126: 
                    127: \item[archive-id] The ID for this document in the archive --
1.16      casties   128:   optional.
1.1       casties   129:   
                    130: \item[derived-from] Container for the description of the original
                    131:   resource if this resource is a modified version of another resource
                    132:   -- optional.
                    133: 
                    134:   \begin{description}
1.12      casties   135:   \item[archive-id] The ID of the original resource
1.16      casties   136:     -- required (or archive-path).
1.12      casties   137: 
1.1       casties   138:   \item[archive-path] The full path to the original resource
1.16      casties   139:     -- required (or archive-id).
                    140: 
                    141:   \item[description] An informal textual description of the relation
                    142:   of this resource to the original resource -- optional.
                    143:   \end{description}
                    144:   
                    145: \item[used-by] Container for the description of modified resources
                    146:   if this resource is the source of another resource
                    147:   -- optional.
                    148: 
                    149:   \begin{description}
                    150:   \item[archive-id] The ID of the derived resource
                    151:     -- required (or archive-path).
                    152: 
                    153:   \item[archive-path] The full path to the derived resource
                    154:     -- required (or archive-id).
1.1       casties   155: 
                    156:   \item[description] An informal textual description of the relation
                    157:   of this resource to the original resource -- optional.
                    158:   \end{description}
                    159:   
                    160: \item[linked-with] Container for the description of another
                    161:   resource when this resource is a linked copy of another resource
                    162:   -- optional.
                    163: 
                    164:   \begin{description}
1.12      casties   165:   \item[archive-id] The ID of the linked resource
1.16      casties   166:     -- required (or archive-path).
1.12      casties   167: 
1.1       casties   168:   \item[archive-path] The full path to the linked resource
1.16      casties   169:     -- required (or archive-id).
1.1       casties   170: 
                    171:   \item[description] An informal textual description of the relation
                    172:   of this resource to the linked resource -- optional.
                    173:   \end{description}
                    174:   
1.24      casties   175: \item[is-part-of] Container for the description of another resource if this 
                    176:   resource is a part of the other resource.  -- optional. It can have a 
                    177:   \texttt{type} attribute describing the type of relation .e.g. ``manuscript-codex''.
                    178: 
                    179:   \begin{description}
                    180:   \item[archive-id] The ID of the original resource
                    181:     -- required (or archive-path).
                    182: 
                    183:   \item[archive-path] The full path to the original resource
                    184:     -- required (or archive-id).
                    185: 
                    186:   \item[description] An informal textual description of the relation
                    187:   of this resource to the original resource -- optional.
                    188:   \end{description}
                    189:   
1.12      casties   190: \item[media-type] \label{tag-media-type} The main media type of this
                    191:   resource -- required.\\ The main media type can be overridden by
                    192:   \texttt{media-type}s in subdirectories. Possible types are
                    193:   \begin{itemize}
                    194:   \item \texttt{image}
                    195: 
                    196:   \item \texttt{text}
                    197: 
                    198:   \item \texttt{audio}
                    199: 
                    200:   \item \texttt{video}
                    201: 
                    202:   \item \texttt{data} for other type of data
                    203:   \end{itemize}
1.1       casties   204:   
                    205: \item[meta] Additional metadata information about the resource --
                    206:   optional.\\ For a description of additional metadata see below.
                    207: 
                    208: \item[dir] Container for the description of a subdirectory -- required
                    209:   (when there are subdirectories).\\ \texttt{dir} tags should not be
                    210:   nested. Directories at lower levels are identified by their
                    211:   \texttt{path}.
                    212: 
                    213:   \begin{description}
                    214:   \item[description] An informal textual description of the
                    215:     subdirectory -- optional.
                    216: 
                    217:   \item[name] The name of the subdirectory -- required.
                    218:     
1.12      casties   219:   \item[original-name] A text string associated with the directory as
                    220:     original name -- optional. (E.g. if the data in this directory
                    221:     came from an external source and had a name that had to be changed
                    222:     according to section~\ref{sec:file-directory-names} but it should
                    223:     be possible to reference the original name.)
                    224:     
1.1       casties   225:   \item[path] The directory path of this subdirectory relative to the
1.5       casties   226:     resource's root directory (excluding the directory itself) --
                    227:     required (may be empty or omitted if the directory is a direct
                    228:     child of the resource's root directory).
1.1       casties   229:     
                    230:   \item[meta] Additional metadata information about the directory --
                    231:     optional.\\ For a description of additional metadata see below.
                    232:   \end{description}
                    233:   
                    234: \item[file] Container for the description of a file -- deduced.\\
                    235:   \texttt{file} tags should not be nested in \texttt{dir} tags. Files
                    236:   at lower directory levels are identified by their \texttt{path}.
                    237: 
                    238:   \begin{description}
                    239:   \item[description] An informal textual description of the
                    240:     file -- optional.
                    241: 
                    242:   \item[name] The name of the file -- required.
                    243:     
1.12      casties   244:   \item[original-name] A text string associated with the file as
1.16      casties   245:     original name -- optional. (e.g. if this file came from an
1.12      casties   246:     external source and had a name that had to be changed according to
1.16      casties   247:     section~\ref{sec:file-directory-names} it is possible
                    248:     to preserve the original name.)
1.12      casties   249:     
1.1       casties   250:   \item[path] The directory path of this file relative to the
1.5       casties   251:     resource's root directory (excluding the file itself) -- required
                    252:     (may be empty or omitted if the file is in the resource's root
                    253:     directory).
1.7       casties   254:     
                    255:   \item[date] The file's modification or creation date\footnote{The
                    256:       preferred time and date format is ``YYYY/MM/DD HH:MM:SS''},
                    257:     whichever is more recent -- optional.
1.1       casties   258: 
                    259:   \item[modification-date] The file's modification date -- optional.
                    260: 
                    261:   \item[creation-date] The file's creation date -- optional.
1.7       casties   262:     
1.1       casties   263:   \item[size] The file size -- deduced.
                    264:     
                    265:   \item[mime-type] The file's mime-type -- optional.
                    266: 
                    267:   \item[md5cs] MD5 checksum of the file content -- optional.
                    268:     
                    269:   \item[meta] Additional metadata information about the file --
                    270:     optional. For a description of additional metadata see below.
                    271:   \end{description}
                    272:   
                    273: \end{description}
                    274: 
                    275: 
                    276: 
                    277: \section{Additional metadata}
                    278: \label{sec:additional-metadata}
                    279: 
                    280: All elements with \texttt{meta} tags can contain an arbitrary number
1.12      casties   281: of the following additional metadata elements.
                    282: 
1.16      casties   283: \subsection{Workflow state}
1.12      casties   284: \label{sec:workflow-state}
                    285: 
                    286: All additional metadata elements can have a \texttt{workflow-state}
                    287: \textbf{attribute}. This attribute reflects the state of the
                    288: corresponding metadata element. The possible values for the
                    289: \texttt{workflow-state} attribute are
                    290: \begin{itemize}
                    291: \item \texttt{preliminary} this information is preliminary. It must
                    292:   be checked in further workflow steps.
                    293: 
                    294: \item \texttt{inwork}
                    295: 
                    296: \item \texttt{final}
                    297: \end{itemize}
                    298: 
                    299: workflow states other than \texttt{preliminary} are part of the
                    300: workflow handling of the respective projects.
                    301: 
                    302: Metadata elements can appear multiple times with different
                    303: \texttt{workflow-state} attributes. This enables metadata versioning.
                    304: 
                    305: 
                    306: 
                    307: \subsection{Content type}
                    308: \label{sec:content-type}
                    309: 
                    310: \begin{description}
                    311: \item[content-type] \label{tag-content-type} The content type of this
                    312:   resource -- required.\\
                    313:   The content type enables the choice of tools to manipulate and
                    314:   display the resource. There should be a common list of content
                    315:   types. For digital documents (books, manuscripts) this would be
1.24      casties   316:   ``scanned document'', for other image data ``scanned
                    317:   images''.\footnote{The criterion for documents is a ordered
1.12      casties   318:     succession of image files (pages) and equal image size and
                    319:     resolution throughout the images of a resource.}
                    320: \end{description}  
                    321: 
                    322: 
1.1       casties   323: 
1.4       casties   324: \subsection{Language}
                    325: \label{sec:lang}
                    326: 
                    327: The language of a resource (e.g. a text) can be specified with a
                    328: \texttt{lang} tag. Languages have to be described using the
                    329: international codes for the representation of names of languages
                    330: either in two-letter form (ISO 639-1) or in three-letter form (ISO
                    331: 639-2).  The entire catalogue of languages is documented on the page
                    332: 
                    333: \url{http://www.loc.gov/standards/iso639-2/englangn.html}
                    334: 
1.1       casties   335: 
                    336: \subsection{DRI}
                    337: \label{sec:dri}
                    338: 
                    339: The \emph{digital resource identifier} for the resource is specified
1.4       casties   340: in a \texttt{dri} element. Digital resource identifiers are documented
1.1       casties   341: on the page
                    342: 
                    343: \url{http://pythia.mpiwg-berlin.mpg.de/projects/standards/dri}.
                    344: 
                    345: 
1.4       casties   346: 
                    347: \subsection{Collection context}
                    348: \label{sec:collection-context}
                    349: 
1.15      casties   350: The context of a resource as part of a collection or part of a project
                    351: can be specified in the \texttt{context} element. The context element
                    352: can appear multiple times if the resource is part of multiple
                    353: collections or projects.
1.4       casties   354: 
                    355: \begin{description}
1.5       casties   356: \item[context] information on collection or project context.
1.4       casties   357: 
1.5       casties   358:   \begin{description}
1.15      casties   359:   \item[link] URL to additional context information -- optional.
1.5       casties   360:     
1.15      casties   361:   \item[name] Textual description of project or collection -- optional.
                    362: 
                    363:   \item[meta-datalink] description of external sources of canonical meta
                    364:     information -- optional
                    365:     \begin{description}
                    366:     \item[db] \textbf{attribute} to identify different sets of meta data
                    367:       links to the same resource -- optional
                    368: 
                    369:     \item[object] \textbf{attribute} to identify different objects or
                    370:       parts of the same resource -- optional
                    371: 
                    372:     \item[label] textual label for the link -- optional
                    373: 
                    374:     \item[url] URL to present to the client -- optional
                    375: 
                    376:     \item[metadata-url] URL to an external server to be queried -- optional
                    377:     \end{description}
                    378: 
                    379:   \item[meta-baselink] description of external server for canonical meta
                    380:     information -- optional
                    381:     \begin{description}
                    382:     \item[db] \textbf{attribute} to identify different sets of meta data
                    383:       links to the same resource -- optional
                    384: 
                    385:     \item[label] textual label for the link -- optional
                    386: 
                    387:     \item[url] URL to present to the client -- optional
                    388:       
                    389:     \item[metadata-url] URL to an external server to be queried --
                    390:       required (the parameter \texttt{object=} with an object id has
                    391:       to be appended to this URL)
                    392:     \end{description}
1.5       casties   393:   \end{description}
1.4       casties   394: \end{description}
1.5       casties   395: 
1.4       casties   396: 
                    397: 
                    398: 
1.1       casties   399: \subsection{Bibliographic information}
                    400: \label{sec:bibliographic-data}
                    401: 
1.5       casties   402: Bibliographic information is presented in a \texttt{bib} container with
1.1       casties   403: a \texttt{type} parameter, giving the type of bibliographic resource.
1.4       casties   404: The \texttt{type} field can be repeated as a tag in the container.
                    405: 
1.5       casties   406: The format is based on the ECHO scheme for bibliographic data (cf.
                    407: content workflow), the MPIWG ``Projektbibliografie'' and the format of
                    408: the commonly used program ``EndNote''.
                    409: 
1.4       casties   410: 
                    411: \subsubsection{Book}
                    412: 
                    413: \begin{description}
                    414: 
                    415: \item [bib type="book"] a published book.
                    416: 
                    417:   \begin{description}
                    418:   \item [author] The author of the book.
                    419:   \item [year] The year of publication.
                    420:   \item [title] Title of the book.
                    421:   \item [series-editor] Name of the series editor, if the book appears
                    422:     in a series.
                    423:   \item [series-title] Title of the serie, if the book appears in a
                    424:     series.
                    425:   \item [series-volume] Volume number, if the book appears in a
                    426:     series.
                    427:   \item [number-of-pages] Number of pages of the entire book.
                    428:   \item [city] City where the book was published.
                    429:   \item [publisher] Name of the publishing company
                    430:   \item [edition] Edition of the book (e.g. third edition)
                    431:   \item [number-of-volumes] Number of volumes, if the the book is
                    432:     published in multiple volumes.
                    433:   \item [translator] Name of the translator.
                    434:   \item [isbn-issn]
1.18      casties   435:   \item[call-number] Call number in holding library
                    436:   \item[holding-library] Holding library
1.4       casties   437:   \end{description}
                    438: \end{description}
                    439: 
                    440: \subsubsection{In Book}
                    441: 
                    442: \begin{description}
                    443: \item [bib type="inbook"] an article as part of a book.
                    444: 
                    445:   \begin{description}
                    446:   \item [author] The author of the book.
                    447:   \item [year] The year of publication.
                    448:   \item [title] Title of the article.
                    449:   \item [editor] Name of the book's editor.
                    450:   \item [book-title] Title of the book.
                    451:   \item [series-volume] Volume number, if the book appears in a
                    452:     series.
                    453:   \item [pages] Number of pages of the article.
                    454:   \item [city] City where the book was published.
                    455:   \item [publisher] Name of the publishing company
                    456:   \item [edition] Edition of the book (e. g. third edition)
                    457:   \item [series-author] Name of the series editor, if the book appears
                    458:     in a series.
                    459:   \item [series-title] Title of the series, if the book appears in a
                    460:     series.
                    461:   \item [number-of-volumes] Number of volumes, if the the book is
                    462:     published in multiple volumes.
                    463:   \item [translator] Name of the translator
                    464:   \item [isbn-issn]
1.18      casties   465:   \item[call-number] Call number in holding library
                    466:   \item[holding-library] Holding library
1.4       casties   467:   \end{description}
                    468: \end{description}
                    469: 
                    470: \subsubsection{Proceedings}
                    471: 
                    472: \begin{description}
                    473: \item [bib type="proceedings"] a conference proceedings publication.
                    474: 
                    475:   \begin{description}
                    476:   \item [author] The author of the article.
                    477:   \item [year] The year of publication.
                    478:   \item [title] Title of the article.
                    479:   \item [editor] Name of the book's editor.
                    480:   \item [conference-name] Name of the conference the proceedings are
                    481:     related to.
                    482:   \item [volume] Volume number.
                    483:   \item [pages] Number of pages of the article.
                    484:   \item [date] Date of the conference the proceedings are related to.
                    485:   \item [conference]-location City where the conference was held.
                    486:   \item [publisher] Name of the publishing company
                    487:   \item [edition] Edition of the book (e. g. third edition)
                    488:   \item [series-editor] Name of the series editor, if the book appears
                    489:     in a series.
                    490:   \item [series-title] Title of the series, if the book appears in a
                    491:     series.
                    492:   \item [number-of-volumes] Number of volumes, if the the book is
                    493:     published as multiple volumes.
                    494:   \item [isbn-issn]
1.18      casties   495:   \item[call-number] Call number in holding library
                    496:   \item[holding-library] Holding library
1.4       casties   497:   \end{description}
                    498: \end{description}
                    499: 
                    500: \subsubsection{Edited Book}
                    501: 
                    502: \begin{description}
                    503: \item[bib type="edited-book"] a book that is the edition of another
                    504:   work.
                    505: 
                    506:   \begin{description}
                    507:   \item [editor] Name of the editor of the book.
                    508:   \item [year] The year of publication.
                    509:   \item [title] Title of the book.
                    510:   \item [series-editor] Name of the editor of the series the book is
                    511:     part of.
                    512:   \item [series-title] Title of the series, if the book is part of a
                    513:     series.
                    514:   \item [series-volume] Volume number, if the book appears in a series.
                    515:   \item [number-of-pages] Number of pages of the article.
                    516:   \item [city] City where the book was published.
                    517:   \item [publisher] Name of the publishing company
                    518:   \item [edition] Information about the edition (e.g. ``Repr. of the London ed. 1652'')
                    519:   \item [number-of-volumes] Number of volumes, if the the book is
                    520:     published as multiple volumes.
                    521:   \item [isbn-issn]
1.18      casties   522:   \item[call-number] Call number in holding library
                    523:   \item[holding-library] Holding library
1.4       casties   524:   \end{description}
                    525: \end{description}
                    526: 
1.17      casties   527: \subsubsection{Journal Volume}
                    528: 
                    529: \begin{description}
                    530: \item [bib type="journal-volume"] a volume of a scientific journal.
                    531:   \begin{description}
                    532:   \item [title] Name of the journal.
                    533:   \item [editor] The editor of the journal.
                    534:   \item [publisher] Name of the publishing company.
                    535:   \item [city] City where the journal is published.
                    536:   \item [year] The year of publication.
                    537:   \item [volume] Volume number.
                    538:   \item [numer-of-pages] Number of pages of the volume.
                    539:   \item [isbn-issn]
1.18      casties   540:   \item[call-number] Call number in holding library
                    541:   \item[holding-library] Holding library
1.17      casties   542:   \end{description}
                    543: \end{description}
                    544: 
1.4       casties   545: \subsubsection{Journal Article}
                    546: 
                    547: \begin{description}
                    548: \item [bib type="journal-article"] an article in a scientific journal.
                    549:   \begin{description}
                    550:   \item [author] The author of the article.
                    551:   \item [year] The year of publication.
                    552:   \item [title] Title of the article.
                    553:   \item [journal] Name of the journal.
                    554:   \item [volume] Volume number, if the journal appears in a series.
                    555:   \item [issue] Number of the issue the article is part of.
                    556:   \item [pages] Number of pages of the article.
                    557:   \item [alternate-journal] Alternate Journal
                    558:   \item [isbn-issn]
1.18      casties   559:   \item[call-number] Call number in holding library
                    560:   \item[holding-library] Holding library
1.4       casties   561:   \end{description}
                    562: \end{description}
                    563: 
                    564: \subsubsection{Magazine Article}
                    565: 
                    566: \begin{description}
                    567: \item [bib type="magazine-article"] an article in a popular magazine.
                    568:   \begin{description}
                    569:   \item [author] The author of the book.
                    570:   \item [year] The year of publication.
                    571:   \item [title] Title of the article.
                    572:   \item [magazine] Name of the magazine.
                    573:   \item [volume] Volume number, if the book appears in a series.
                    574:   \item [issue-number] Number of the issue the article is part of.
                    575:   \item [pages Number] of pages of the article.
                    576:   \item [date] Date when the article appeared.
1.18      casties   577:   \item[call-number] Call number in holding library
                    578:   \item[holding-library] Holding library
1.4       casties   579:   \end{description}
                    580: \end{description}
                    581: 
                    582: \subsubsection{Newspaper Article}
                    583: 
                    584: \begin{description}
                    585: \item [bib type="newspaper-article"] an article in a newspaper.
                    586:   \begin{description}
                    587:   \item [author] The author of the article.
                    588:   \item [year] The year of publication.
                    589:   \item [title] Title of the article.
                    590:   \item [Newspaper] Name of the newspaper the article appeared in.
                    591:   \item [pages] Number of pages of the article.
                    592:   \item [issue-date] Date of the issue the article is part of.
                    593:   \item [city] City of the newspaper.
1.18      casties   594:   \item[call-number] Call number in holding library
                    595:   \item[holding-library] Holding library
1.4       casties   596:   \end{description}
                    597: \end{description}
                    598: 
                    599: \subsubsection{Thesis}
                    600: 
                    601: \begin{description}
                    602: \item [bib type="thesis"] a master/doctorate/etc. thesis.
                    603:   \begin{description}
                    604:   \item [author] The author of the thesis.
                    605:   \item [year] The year of publication.
                    606:   \item [title] Title of the thesis.
                    607:   \item [academic-department] Name of the academic department where
                    608:     the thesis was handed in.
                    609:   \item [number-of-pages] Number of pages of the thesis.
                    610:   \item [city] City where the thesis was published.
                    611:   \item [University] Name of the university where the thesis was
                    612:     handed in.
                    613:   \item [isbn-issn]
1.18      casties   614:   \item[call-number] Call number in holding library
                    615:   \item[holding-library] Holding library
1.4       casties   616:   \end{description}
                    617: \end{description}
                    618: 
                    619: \subsubsection{Report}
                    620: 
                    621: \begin{description}
                    622: \item [bib type="report"] a scientific report.
                    623:   \begin{description}
                    624:   \item [author] The author of the report.
                    625:   \item [year] The year of publication.
                    626:   \item [title] Title of the report.
                    627:   \item [pages] Number of pages of the report.
                    628:   \item [date] Date when the report appeared.
                    629:   \item [city] City where the book was published.
                    630:   \item [institution] Institution where the report was produced.
                    631:   \item [type] Type of report.
                    632:   \item [report-number] Report number.
1.18      casties   633:   \item[call-number] Call number in holding library
                    634:   \item[holding-library] Holding library
1.4       casties   635:   \end{description}
                    636: \end{description}
                    637: 
1.5       casties   638: \subsubsection{Manuscript}
                    639: 
                    640: \begin{description}
                    641: \item [bib type="manuscript"] a handwritten/typewritten manuscript.
                    642: 
                    643:   \begin{description}
                    644:   \item [title] Title of the manuscript.
                    645:   \item [author] The author of the text.
                    646:   \item [location] Name of the library where the manuscript is
                    647:     currently located.
                    648:   \item [year] The year or century of publication.
                    649:   \item [pages] Number of pages of the manuscript.
                    650:   \item [signature] Signature of the manuscript.
                    651:   \item [editorial-remarks] Remarks related to the online
                    652:     publication of the manuscript. This could be notes about
                    653:     annotations etc.
                    654:   \item [description] This can be any kind of description.
                    655:   \item [keywords] Keywords related to the manuscript.
1.18      casties   656:   \item[call-number] Call number in holding library
                    657:   \item[holding-library] Holding library
1.5       casties   658:   \end{description}
                    659: \end{description}
                    660: 
1.23      dwinter   661: \subsubsection{Extended Manuscript}
                    662: 
                    663: \begin{description}
                    664: \item [bib type="extended-manuscript"] a handwritten/typewritten manuscript
                    665: with detailed information about the manuscripts appearance.
                    666: 
                    667:   \begin{description}
                    668:   \item [title] Title of the manuscript.
                    669:   \item [author] The author of the text.
1.24      casties   670:    \item[holding-library] Holding library.
                    671:    \item[call-number] Call number/Shelf mark in holding library.
1.23      dwinter   672:   \item[location] Place/City/Country where the manuscript is
                    673:     currently located.
                    674:   \item[date calendar="type"] The date of publication with attribute which
                    675:   calendar used. If no attribute used, CE is the default. Can also be
                    676:   descriptive.
1.24      casties   677:   \item[year calendar="type"] Approximate year or century .
1.23      dwinter   678:   \item[number-of-folios] Number of folios/pages of the manuscript.
                    679:   \item[signature] Signature(s) of the manuscript, under which a manuscript is
                    680:   known.
1.24      casties   681:   \item[abstract] Interpretative abstract of the text's content.
                    682:   \item[incipit] Incipit (beginning of text).
                    683:   \item[explicit] Explicit (end of text).
1.23      dwinter   684:   \item[contents] Formal description of the text structure (e.g. table of
1.24      casties   685:   contents).
                    686:   \item[writing-surface] material of the writing surface (e.g. ``non-european
                    687:   paper'', ``palm leaf'',\ldots)
                    688:   \item[foliation] Text giving list or range of folios. 
                    689:   \item[page-dimensions] height and width in cm.
                    690:   \item[written-area-dimensions] height and width in cm.
                    691:   \item[lines-per-page] number of lines and columns.
                    692:   \item[catchwords] Quire signatures and catchwords.
                    693:   \item[scripts] Description of the script and the ink used.
                    694:   \item[copyist] Copyist.
                    695:   \item[collation-corrections] Notes on collation and corrections.
                    696:   \item[binding] Description of binding.
                    697:   \item[notes-on-ownership] Notes on ownership.
                    698:   \item[notes] Additional notes.
1.23      dwinter   699:   \item[secondary-literature] Notes on secondary literature related to the
1.24      casties   700:     manuscript
1.23      dwinter   701:   \item [editorial-remarks] Remarks related to the online
                    702:     publication of the manuscript.
                    703:   \item [keywords] Keywords related to the manuscript.
                    704:   \end{description}
                    705: \end{description}
                    706: 
                    707: \subsubsection{Codex}
                    708: 
                    709: \begin{description}
1.24      casties   710: \item [bib type="codex"] Codex i.e. bound collection of one or more manuscripts.
1.23      dwinter   711: 
                    712:   \begin{description}
1.29      casties   713: %TODO: do we need collection information?
1.24      casties   714:   \item[holding-library] Holding library.
                    715:   \item[call-number] Call number/Shelf mark in holding library.
1.23      dwinter   716:   \item[location] Place/City/Country where the codex is
                    717:     currently located.
                    718:   \item[date calendar="type"] Date of the collation of the codex.
1.24      casties   719:   \item[year calendar="type"] Approximate year or century .
1.23      dwinter   720:   \item[number-of-folios] Number of folios/pages of the manuscript.
1.24      casties   721:   \item[foliation] Text giving list or range of folios.
1.23      dwinter   722:   \item[signature] Signature(s) of the manuscript, under which a manuscript is
                    723:   known.
                    724:   \item[contents] Formal description of the text structure (e.g. table of
1.24      casties   725:   contents).
                    726:   \item[dimensions] height + width in cm.
                    727:   \item[binding] Description of binding.
                    728:   \item[notes] Additional notes.
                    729:   \item[notes-on-ownership] Notes on ownership.
                    730:  \end{description}
1.23      dwinter   731: \end{description}
                    732: 
1.5       casties   733: 
1.19      casties   734: \subsubsection{Correspondence}
                    735: 
                    736: \begin{description}
                    737: \item [bib type="correspondence"] a piece of correspondence e.g. letter, telegram, in the following called ``letter''
                    738: 
                    739:   \begin{description}
                    740:   \item[type] The type of correspondence, e.g. ``letter'', ``postcard'', ``telegram'', ``letter draft''
                    741:   \item [author] The author/sender of the letter.
                    742:   \item [recipient] The recipient of the letter.
                    743:   \item [date] normalised date of the letter.
                    744:   \item [date-range-end] end of range of uncertain dating -- optional.
                    745:   \item [date-original] the date in its original form as noted on the letter -- optional.
                    746:   \item [place] place where the letter was written/sent.
                    747:   \item [title] Title of the letter -- optional.
                    748:   \item[incipit] The opening phrase of the letter -- optional.
1.29      casties   749:   \item[explicit] The closing phrase of the letter -- optional.
1.19      casties   750:   \item [pages] Number of pages of the manuscript.
                    751:   \item [signature] Canonical signature/call number of the manuscript.
                    752:   \item [description] This can be any kind of description.
                    753:   \item [keywords] Keywords related to the manuscript.
                    754:   \item[call-number] Call number in the current holding library
                    755:   \item[holding-library] current holding library
                    756:   \end{description}
                    757: \end{description}
                    758: 
                    759: 
1.4       casties   760: \subsubsection{Generic}
                    761: 
                    762: \begin{description}
                    763: \item [bib type="generic"] a generic bibliographic type. This type
                    764:   should only be used in rare cases.
                    765:   \begin{description}
                    766:   \item [author]
                    767:   \item [year]
                    768:   \item [title]
                    769:   \item [secondary-author]
                    770:   \item [secondary-title]
                    771:   \item [volume]
                    772:   \item [number]
                    773:   \item [pages]
                    774:   \item [date]
                    775:   \item [place-published]
                    776:   \item [publisher]
                    777:   \item [edition]
                    778:   \item [tertiary author]
                    779:   \item [tertiary-title]
                    780:   \item [number-of-volumes]
                    781:   \item [type-of-work]
                    782:   \item [subsidiary author]
                    783:   \item [alternate-title]
                    784:   \item [isbn-issn]
                    785:   \item [call-number]
                    786:   \item [label]
                    787:   \item [keywords]
                    788:   \item [abstract]
                    789:   \item [notes]
                    790:   \item [url]
1.5       casties   791:   \end{description}
1.4       casties   792: \end{description}
                    793: 
                    794: 
1.10      casties   795: \subsection{Document structure (table of contents)}
1.1       casties   796: \label{sec:toc}
                    797: 
1.4       casties   798: Information on the structure of a document like the division into
                    799: parts and chapters in the way of a table of contents is presented in a
                    800: \texttt{toc} container. 
                    801: 
1.30      casties   802: This scheme allows multiple logical pages on a single page image
1.4       casties   803: as it is often the case with scanned books or manuscripts. The scheme
                    804: also allows for ``loose'' numbering schemes with roman, arabic or
                    805: other page numbers consecutively or mixed and changes in the numbering
                    806: within the document.
                    807: 
                    808: The flexibility comes from the fact that no additional assumptions
                    809: about the mapping between logical pages and page images are made in
                    810: the format. All mapping information is specified by the user.
                    811: 
                    812: The logical page numbering or naming that can be presented to the user
                    813: is specified in the \texttt{name} tags while the physical numbering of
                    814: the page images is specified in the \texttt{index} or \texttt{url}
                    815: tags.
1.1       casties   816: 
1.4       casties   817: \begin{description}
1.5       casties   818: \item[toc] container for document structure
                    819: 
1.4       casties   820:   \begin{description}
1.5       casties   821:   \item[page] describes a single logical page
                    822: 
                    823:     \begin{description}
                    824:     \item[name] the ``name'' of the logical page. This can be any string
                    825:       like a page number (arabic, roman, etc.) or a special designation
                    826:       like ``Table 5''.
                    827:       
                    828:     \item[index] the \texttt{digilib} index number\footnote{The index
1.30      casties   829:         number for digilib is the index in the alphabetical ordering of the
1.5       casties   830:         scan file names.} of the scan image of the page.
1.30      casties   831: 
                    832:     \item[file] alternatively the file name (preferrably without extension) of the
                    833:       scan image of the page.
1.5       casties   834:       
1.30      casties   835:     \item[url] alternatively the full URL of the scan image of the
                    836:       page can be used.
1.5       casties   837:     \end{description}
1.4       casties   838:     
1.5       casties   839:   \item[chapter] describes a section or chapter of the text.
                    840:     \texttt{chapter} elements can be nested.
1.1       casties   841: 
1.4       casties   842:     \begin{description}
1.5       casties   843:     \item[name] the title of the chapter or section.
                    844:       
                    845:     \item[start] the beginning of a page range (usually the first page
                    846:       of the chapter). The \texttt{start} element has an optional
                    847:       \texttt{increment} attribute to indicate the number of logical
                    848:       pages on a scan image.\footnote{This information is only needed by
                    849:         additional tools that try to generate lists of all page and
                    850:         image numbers.}
                    851: 
                    852:       \begin{description}
                    853:       \item[name] the ``name'' of the first page (see \texttt{page}).
                    854:         
                    855:       \item[index] the index of the first page (see \texttt{page}).
1.30      casties   856: 
                    857:       \item[file] the file name of the first page (see \texttt{page}).
1.5       casties   858:         
                    859:       \item[url] the URL of the first page (see \texttt{page}).
                    860:       \end{description}
                    861:       
                    862:     \item[end] the end of a page range (usually the last page of the
                    863:       chapter).
                    864: 
                    865:       \begin{description}
                    866:       \item[name] the ``name'' of the last page (see \texttt{page}).
                    867:         
                    868:       \item[index] the index of the last page (see \texttt{page}).
1.30      casties   869: 
                    870:       \item[file] the file name of the first page (see \texttt{page}).
1.5       casties   871:         
                    872:       \item[url] the URL of the last page (see \texttt{page}).
                    873:       \end{description}
                    874:       
                    875:     \item[page] alternative (and additional) to
                    876:       \texttt{start}/\texttt{end} page ranges single \texttt{page}
                    877:       elements can be used inside \texttt{chapter}.
1.4       casties   878:     \end{description}
                    879:   \end{description}
                    880: \end{description}
                    881: 
                    882: %%\url{http://pythia.mpiwg-berlin.mpg.de/toolserver/TS_lise}
1.1       casties   883: 
                    884: 
1.12      casties   885: \subsection{Digital images}
1.1       casties   886: \label{sec:inform-scann-imag}
                    887: 
                    888: Image files representing scanned images can have an \texttt{img}
                    889: container tag with information about the scan resolution and the size
                    890: of the original image. This information is used by the
                    891: \texttt{digilib} image viewing tool.
                    892: 
                    893: Required is one of three possible sets of tags:
                    894: 
                    895: \begin{description}
1.5       casties   896: \item[img] digital image information.
1.1       casties   897: 
1.5       casties   898:   \begin{description}
1.12      casties   899:   \item[original-size-x] The width of the original
                    900:     image -- required. \\
                    901:     The unit of measure can be contained as parameter \texttt{unit},
                    902:     the default is meter ``m''. The width to be considered is the
                    903:     total width of the scanned area.
1.5       casties   904:     
1.12      casties   905:   \item[original-size-y] The height of the original image -- required.
1.5       casties   906:     
1.12      casties   907:   \item[original-pixel-x] The width of the hi-res scan in pixels -- deduced.
1.5       casties   908:     
1.12      casties   909:   \item[original-pixel-y] The height of the hi-res scan in pixels -- deduced.
1.5       casties   910:   \end{description}
1.1       casties   911: \end{description}
                    912: 
                    913: or
                    914: 
                    915: \begin{description}
1.5       casties   916: \item[img] digital image information.
                    917: 
                    918:   \begin{description}
                    919:   \item[original-dpi-x] The resolution of the hi-res scan in its width
1.12      casties   920:     in pixels per inch -- required.
1.1       casties   921: 
1.5       casties   922:   \item[original-dpi-y] The resolution of the hi-res scan in its height
1.12      casties   923:     in pixels per inch -- required.
                    924: 
                    925:   \item[original-pixel-x] The width of the hi-res scan in pixels -- deduced.
                    926:     
                    927:   \item[original-pixel-y] The height of the hi-res scan in pixels -- deduced.
1.5       casties   928:   \end{description}
1.1       casties   929: \end{description}
                    930: 
                    931: or
                    932: 
                    933: \begin{description}
1.5       casties   934: \item[img] digital image information.
                    935: 
                    936:   \begin{description}
                    937:   \item[original-dpi] The resolution of the hi-res scan in pixels per
1.12      casties   938:     inch if the resolutions in width and height are the same -- required.
                    939: 
                    940:   \item[original-pixel-x] The width of the hi-res scan in pixels -- deduced.
                    941:     
                    942:   \item[original-pixel-y] The height of the hi-res scan in pixels -- deduced.
1.5       casties   943:   \end{description}
1.1       casties   944: \end{description}
1.7       casties   945: 
                    946: 
1.10      casties   947: 
1.12      casties   948: \subsection{Digital image acquisition}
1.10      casties   949: \label{sec:inform-about-image}
                    950: 
                    951: A description of the technology used in the process of producing a
                    952: digital image.
                    953: 
                    954: \begin{description}
                    955: \item[image-acquisition] description of the image production process
                    956:   \begin{description}
1.12      casties   957:   \item[device] acquisition device (e.g. ``flatbed scanner'') 
1.10      casties   958: 
1.12      casties   959:   \item[image-type] type and color-depth of the image -- required (e.g. ``RGB 24
1.10      casties   960:     bit'')
                    961: 
                    962:   \item[production-comment] additional textual information about the
                    963:     production process
                    964:   \end{description}
                    965: \end{description}
                    966: 
                    967: 
1.12      casties   968: 
1.7       casties   969: \subsection{Full text with images}
                    970: \label{sec:full-text-with}
                    971: 
1.30      casties   972: The relation between a full text and optional images of
                    973: whole pages or parts of pages must be specified in a
                    974: \texttt{texttool} container.
                    975: 
1.12      casties   976: Full text in a XML format should be specified with a
                    977: \texttt{content-type}\footnote{see section~\ref{tag-content-type}
                    978: on page\pageref{tag-content-type}} ``fulltext''.
1.8       casties   979: 
                    980: 
                    981: \begin{description}
1.20      casties   982: \item[texttool] representation of full text with images
                    983:   
1.8       casties   984:   \begin{description}
1.22      casties   985:   \item[text] the file name of the full text file (path
1.8       casties   986:     inside document directory)
1.12      casties   987:     
1.20      casties   988:   \item[text-url-path] a characteristic part of the URL with which the
                    989:     full text can be retrieved (the form and content of this element
                    990:     is dependent on the specific text retrieval mechanism)
                    991:     
                    992:   \item[image] the directory name of the directory containig the
1.22      casties   993:     page image files (path inside document directory)
                    994: 
                    995:   \item[figure] the directory name of the directory containig the
                    996:     in-page figure image files (path inside document directory)
1.8       casties   997: 
1.30      casties   998:   \item[page-flow] the reading direction of pages in this document:
                    999:     either ``ltr'' (left-to-right, standard western page flow) or
                   1000:     ``rtl'' (right-to-left, still assuming increasing page numbers)
                   1001: 
1.31    ! casties  1002:  \item[odd-scan-position] the orientation of all odd-numbered scan
1.30      casties  1003:     pages regardless of \texttt{page-flow}: either ``left'' (all
                   1004:     odd-numbered scans are left hand sides) or ``right'' (all
                   1005:     odd-numbered scans are right hand sides, i.e. the first left hand
                   1006:     side is scan number 2).
                   1007: 
                   1008:   \item[title-scan-no] the index number of the scan of the title page or the
                   1009:     first text page
                   1010: 
1.20      casties  1011:   \item[xslt] the file name of an additional XSL transformation
1.8       casties  1012:     file
                   1013: 
1.20      casties  1014:   \item[pagebreak] the name of the element that indicates page breaks
                   1015:     (default ``pb'')
1.8       casties  1016:   \end{description}
                   1017: \end{description}
1.7       casties  1018: 
1.1       casties  1019: 
                   1020: 
1.12      casties  1021: \subsection{Copyright and access conditions}
                   1022: \label{sec:access-conditions}
                   1023: 
                   1024: If the access to a resource is bound to conditions for technical or legal
                   1025: reasons then the conditions can be put in a \texttt{access-conditions}
1.16      casties  1026: container. Other usage conditions like copyright can also be
1.12      casties  1027: documented in this container.
                   1028: 
                   1029: \begin{description}
                   1030: \item[access-conditions] legal and technical conditions for access to
1.28      casties  1031:   this resource. \\
                   1032:   The \texttt{attribution}, \texttt{copyright}, and \texttt{access}
                   1033:   tags can be repeated with different \texttt{resource} attributes if
                   1034:   different conditions apply to different parts of the whole resource.
1.12      casties  1035: 
                   1036:   \begin{description}
                   1037:   \item[attribution] The name or institution this resource should be
1.26      casties  1038:     attributed to when it's publicly presented. \\
1.28      casties  1039:     The kind of resource this condition applies to can be specified with a
                   1040:     \texttt{resource} attribute with the values ``original'' (the
                   1041:     physical object that was scanned), ``digital-image'' (the scanned
                   1042:     images), ``text'' (the textual transcript). \\
                   1043:     All tags inside can be repeated.
1.12      casties  1044: 
                   1045:     \begin{description}
                   1046:     \item[name] a name (free text)
                   1047: 
                   1048:     \item[url] a URL (with an optional \texttt{label} attribute to show
                   1049:       as text)
1.18      casties  1050: 
                   1051:     \item[description] more information (free text, e.g. holding
                   1052:       library call number)
1.12      casties  1053:     \end{description}
                   1054: 
1.26      casties  1055:   \item[copyright] the copyright holder and the copyright conditions. \\
1.28      casties  1056:     The kind of resource this condition applies to can be specified with a
                   1057:     \texttt{resource} attribute with the values ``original'' (the physical object 
1.26      casties  1058:     that was scanned), ``digital-image'' (the scanned images), ``text'' 
                   1059:     (the textual transcript).
                   1060: 
1.12      casties  1061:     \begin{description}
1.16      casties  1062:     \item[owner] the name of the copyright holder
1.12      casties  1063:       \begin{description}
                   1064:       \item[name] a name (free text)
                   1065: 
                   1066:       \item[url] a URL (with an optional \texttt{label} attribute to show
1.26      casties  1067:         as text) identifying the copyright holder
1.12      casties  1068:       \end{description}
                   1069: 
                   1070:     \item[date] the date when the copyright was issued
                   1071: 
1.16      casties  1072:     \item[duration] the duration of the copyright term (if known)
1.12      casties  1073: 
                   1074:     \item[description] free-text field for special or additional
                   1075:       conditions
1.27      casties  1076:     \item[license] the type of license if its a standardised license e.g. Creative Commons
                   1077:       \begin{description}
                   1078:       \item[url] a URL representing the license e.g. \url{http://creativecommons.org/licenses/by/3.0/}
                   1079:       \end{description}
                   1080: 
1.12      casties  1081:     \end{description}
1.14      casties  1082: 
                   1083: 
1.28      casties  1084:  \item[access] conditions of access to this resource. Different
                   1085:     access types are specified by a \texttt{type} attribute.
                   1086:     The kind of resource this condition applies to can be specified with a
                   1087:     \texttt{resource} attribute with the values ``digital-image'' (the
                   1088:     scanned images), or ``text'' (the textual transcript).
1.12      casties  1089: 
                   1090:     \begin{description}
1.16      casties  1091:     \item[type=group] access restricted to the members of this named
                   1092:       group. The method to identify a user belonging to a named group
                   1093:       is not specified in this document.
                   1094:       \begin{description}
                   1095:       \item[name] name of the group.
                   1096: 
                   1097:       \item[only-before] the access condition is only valid before the
                   1098:         given date (format: ``YYYY/MM/DD'').
                   1099: 
                   1100:       \item[only-after] the access condition is only valid after the
                   1101:         given date (format: ``YYYY/MM/DD'').
                   1102:       \end{description}
                   1103:     
                   1104:     \item[type=institution] access restricted to the members of this
                   1105:       institution. The method to identify a user to belong to the
                   1106:       institution is not specified in this document.
1.12      casties  1107:       \begin{description}
1.16      casties  1108:       \item[name] name of the group.
                   1109: 
                   1110:       \item[only-before] the access condition is only valid before the
                   1111:         given date (format: ``YYYY/MM/DD'').
                   1112: 
                   1113:       \item[only-after] the access condition is only valid after the
                   1114:         given date (format: ``YYYY/MM/DD'').
                   1115:       \end{description}
                   1116:     
                   1117: 
                   1118:     \item[type=subnet] access restricted to all computers with an
                   1119:       IP-address in this subnet.
                   1120:       \begin{description}
                   1121:       \item[range] subnet range defined in
                   1122:       truncated-quad (e.g. ``141.14''), network-netmask
                   1123:       (e.g. ``141.14.0.0/255.255.0.0''), or network-range
                   1124:       (e.g. ``141.14.0.0/16'') notation.
                   1125: 
                   1126:       \item[only-before] the access condition is only valid before the
                   1127:         given date (format: ``YYYY/MM/DD'').
                   1128: 
                   1129:       \item[only-after] the access condition is only valid after the
                   1130:         given date (format: ``YYYY/MM/DD'').
                   1131:       \end{description}
                   1132:     
1.12      casties  1133:         
1.16      casties  1134:     \item[type=scientific] access to this resource should be restricted to
                   1135:       scientific work
                   1136:       \begin{description}
                   1137:       \item[only-before] the access condition is only valid before the
                   1138:         given date (format: ``YYYY/MM/DD'').
                   1139: 
                   1140:       \item[only-after] the access condition is only valid after the
                   1141:         given date (format: ``YYYY/MM/DD'').
1.12      casties  1142:       \end{description}
1.16      casties  1143:     
1.12      casties  1144: 
1.16      casties  1145:     \item[type=free] access to this resource is not restricted
                   1146:       \begin{description}
                   1147:       \item[only-before] the access condition is only valid before the
                   1148:         given date (format: ``YYYY/MM/DD'').
1.12      casties  1149: 
1.16      casties  1150:       \item[only-after] the access condition is only valid after the
                   1151:         given date (format: ``YYYY/MM/DD'').
                   1152:       \end{description}
                   1153:     
1.12      casties  1154:       
1.16      casties  1155:     \item[type=special] if none of the above conditions seems appropriate,
1.12      casties  1156:       a free-form text can be specified here.
1.16      casties  1157:       \begin{description}
                   1158:       \item[description] description of special access conditions.
                   1159: 
                   1160:       \item[only-before] the access condition is only valid before the
                   1161:         given date (format: ``YYYY/MM/DD'').
                   1162: 
                   1163:       \item[only-after] the access condition is only valid after the
                   1164:         given date (format: ``YYYY/MM/DD'').
                   1165:       \end{description}
                   1166:     
1.12      casties  1167:     \end{description}
                   1168:   \end{description}
                   1169: \end{description}
                   1170: 
                   1171: \noindent
1.16      casties  1172: It should be noted that control over access to the resource has to be
                   1173: provided by additional technical measures. Access conditions in the
                   1174: metadata file only state that conditions \emph{should} be observed, it
                   1175: is not implied that they \emph{are} necessarily observed, as the
                   1176: enforcement of conditions depends on additional measures.
1.12      casties  1177: 
                   1178: 
                   1179: 
                   1180: \subsection{Acquisition of raw-data}
                   1181: \label{sec:acqu-inform}
                   1182: 
                   1183: Information about the acquisition source for raw data resources can be
                   1184: provided in an \texttt{acquisition} container.
                   1185: 
                   1186: \begin{description}
                   1187: \item[acquisition] the acquisition source of this resource -- required
                   1188:   for raw data.
                   1189:   \begin{description}
                   1190:   \item[provider] where this resource came from -- required
                   1191:     \begin{description}
                   1192:     \item[name] free-text name of the provider (institution or
                   1193:       individual)
                   1194: 
                   1195:     \item[address] address of the provider
                   1196: 
                   1197:     \item[contact] contact person at the provider (i.e. name and email)
                   1198: 
                   1199:     \item[url] URL related to the provider
1.13      casties  1200: 
                   1201:     \item[provider-id] id of the provider (internally used) -- deduced
1.12      casties  1202:     \end{description}
                   1203: 
                   1204:   \item[date] date of acquisition -- required
                   1205: 
                   1206:   \item[description] free-text description of the acquisition source or
                   1207:   additional information
                   1208:   \end{description}
                   1209: \end{description}
                   1210: 
                   1211: 
                   1212: 
                   1213: \subsection{Documentary Films}
                   1214: \label{sec:documentary-films}
                   1215: 
                   1216: Documentary films can be described using a \texttt{film-acquisition}
                   1217: container.
                   1218: 
                   1219: \begin{description}
                   1220: \item[film-acquisition] description of a (documentary) film --
                   1221:   required for documentary film
                   1222:   \begin{description}
                   1223:   \item[recording] specification of the recording process
                   1224:     \begin{description}
                   1225:     \item[author] the person or persons doing the recording
                   1226: 
                   1227:     \item[date] the date or time span when the film was recorded
                   1228: 
                   1229:     \item[location] the place where the film was recorded
                   1230: 
                   1231:     \item[device] recording device used (e.g. ``Sony CP-DV8 Camcorder'')
                   1232:       
                   1233:     \item[format] format of the recorded film -- required (e.g. ``DV
                   1234:       720x524 25fps interlaced'')
                   1235:     \end{description}
                   1236:  
                   1237:   \item[description] free-form description of the recording and the
                   1238:     content of the film
                   1239:   \end{description}
                   1240: \end{description}
                   1241: 
                   1242: (More information about the digitization step could be added in a
                   1243: \texttt{digitization} tag similar to the \texttt{recording} tag.)
                   1244: 
1.1       casties  1245: 
                   1246: 
                   1247: 
1.4       casties  1248: \section{Sample metadata files for ECHO resources}
1.1       casties  1249: 
1.5       casties  1250: The following is a sample metadata index file for a directory containig a
                   1251: scanned document.
                   1252: 
                   1253: \begin{small}
1.1       casties  1254: \begin{verbatim}
1.11      casties  1255: <resource type="ECHO" version="1.0">
1.5       casties  1256:   <description>Fleck, 1980</description>
                   1257:   <name>fleck.1980</name>
                   1258:   <creator>University of Bern</creator>
                   1259:   <archive-path>ubern/wiss-theorie</archive-path>
                   1260:   <content-type>scanned images</content-type>
                   1261:   <meta>
                   1262:     <dri>echo23a45e2329x</dri>
                   1263:     <lang>ger</lang>
                   1264:     <bib type="book">
                   1265:       <author>Fleck, Ludwik</author>
                   1266:       <year>1980</year>
                   1267:       <title>Entstehung und Entwicklung einer 
                   1268:              wissenschaftlichen Tatsache</title>
                   1269:       <series-editor></series-editor>
                   1270:       <series-title></series-title>
                   1271:       <series-volume></series-volume>
                   1272:       <number-of-pages></number-of-pages>
                   1273:       <city>Frankfurt am Main</city>
                   1274:       <publisher>Suhrkamp</publisher>
                   1275:       <edition></edition>
                   1276:       <number-of-volumes></number-of-volumes>
                   1277:       <translator></translator>
                   1278:       <isbn-issn></isbn-issn>
                   1279:       <keywords>Wissenschaftstheorie, Fleck, Tatsache</keywords>
                   1280:       <abstract></abstract>
                   1281:     </bib>
                   1282:   </meta>
                   1283:   <dir>
                   1284:      <description>Scanned images (300dpi)</description>
                   1285:      <name>img</name>
                   1286:   </dir>
1.4       casties  1287: </resource>
                   1288: \end{verbatim}
1.5       casties  1289: \end{small}
1.4       casties  1290: 
1.5       casties  1291: The following is a sample metadata file for a single image of an
                   1292: architectural drawing.
1.4       casties  1293: 
1.5       casties  1294: \begin{small}
1.4       casties  1295: \begin{verbatim}
1.11      casties  1296: <resource type="ECHO" version="1.0">
1.5       casties  1297:   <creator>Bibliotheca Hertziana</creator>
                   1298:   <content-type>scanned images</content-type>
                   1299:   <file>
                   1300:     <name>00000271-asl-160-r-full.tif</name>
                   1301:     <meta>
                   1302:       <img>
                   1303:         <original-dpi>315</original-dpi>
                   1304:       </img>
                   1305:       <dri>echo45a67bc4367d</dri>
                   1306:       <lang>ita</lang>
                   1307:       <doc type="Architectural Drawing">
                   1308:         <person>Ciolli, Giacomo</person>
                   1309:         <person>Urban VIII; Barberini, Maffeo</person>
                   1310:         <location>Accademia di San Luca</location>
                   1311:         <location>Roma</location>
                   1312:         <date>1706</date>
                   1313:         <object>Concorso Clementino</object>
                   1314:         <object>Fontana Pubblica</object>
                   1315:         <object>Brunnen</object>
                   1316:         <object>ASL 160</object>
                   1317:         <keywords></keywords>
                   1318:       </doc>
                   1319:       <context>
                   1320:          <url>http://colosseum.biblhertz.it:8080/Lineamenta/
                   1321:          1033478408.39/1035196181.35/1035196204.09/1035394121.83
                   1322:          </url>
                   1323:       </context>
                   1324:     </meta>
                   1325:   </file>
1.2       casties  1326: </resource>
1.1       casties  1327: \end{verbatim}
1.5       casties  1328: \end{small}
1.1       casties  1329: 
                   1330: \end{document}
                   1331: 
                   1332: %%% Local Variables: 
                   1333: %%% mode: latex
                   1334: %%% TeX-master: t
                   1335: %%% End: 

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