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

1.1       casties     1: \documentclass[a4paper]{article}
                      2: 
                      3: \usepackage[latin1]{inputenc}
                      4: \usepackage[T1]{fontenc}
                      5: \usepackage{ae}
                      6: %\usepackage{times}
                      7: %\usepackage{courier}
                      8: 
                      9: % create in-text links 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.7       casties    19: \date{V1.0.1 of 12.8.2003}
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: 
                     35: File and directory paths in the metadata file use the conventional
                     36: Unix file separator slash ``/''.
                     37: 
1.4       casties    38: 
                     39: \section{Metadata files}
                     40: \label{sec:metadata-files}
                     41: 
                     42: The metadata information is stored in the XML format documented below
                     43: in special files in the resource directory. Two forms of metadata
                     44: files are possible:
                     45: \begin{itemize}
                     46: \item a file named \texttt{index.meta} in a directory.
                     47: 
                     48: \item a file named like the data file it describes with an
                     49:   additional extension \texttt{.meta}. For example metadata for the
                     50:   file \texttt{0001.tif} would be in a file \texttt{0001.tif.meta}.
                     51: \end{itemize}
                     52: 
                     53: The resource directory must contain an \texttt{index.meta} file with
                     54: information about the resource as a whole. Other directories can
                     55: contain \texttt{index.meta} files.
                     56: 
                     57: Additional information about single data files that are part of the
                     58: resource can either be put in \texttt{file} tags in the
                     59: \texttt{index.meta} file or in separate \emph{filename}\texttt{.meta}
                     60: files for each data file. Information from the directory level file is
                     61: inherited at the file level.
                     62: 
                     63: 
1.1       casties    64: \section{Resource format}
                     65: \label{sec:mpiwg-doc}
                     66: 
                     67: In this description elements marked ``optional'' need not be supplied
                     68: by the provider of the resource and may be absent in all versions of
                     69: the metadata file. Elements marked ``required'' must be supplied by
                     70: the provider of the resource. Elements marked ``deduced'' can be
                     71: supplied by the provider of the resource but can also be provided by
1.4       casties    72: automatic scripts later in the process, these elements must be present
1.1       casties    73: in the final file.
                     74: 
1.4       casties    75: The outer container element is \texttt{resource}. Sub-types (``ECHO'',
1.1       casties    76: ``MPIWG'') can be specified if necessary with a \texttt{type}
                     77: parameter. Its sub-elements are:
                     78: 
                     79: \begin{description}
                     80: \item[description] An informal textual description of the
                     81:   resource -- optional.
                     82: 
                     83: \item[name] The filename of the resource (name of the directory this
                     84:   file is contained in) -- required.
                     85: 
                     86: \item[creator] The name of the project or person that created the
                     87:   resource -- optional.
1.4       casties    88:   
                     89: \item[archive-creation-date] The time and date the archive collection
                     90:   was created -- deduced.
1.1       casties    91: 
1.4       casties    92: \item[archive-storage-date] The time and date the archive was written
                     93:   to permanent storage -- deduced (must not be set by the user).
1.1       casties    94: 
                     95: \item[archive-path] The full path to the resource directory inside the
1.5       casties    96:   whole archive collection, including the resource directory -- deduced.
1.1       casties    97:   
                     98: \item[derived-from] Container for the description of the original
                     99:   resource if this resource is a modified version of another resource
                    100:   -- optional.
                    101: 
                    102:   \begin{description}
                    103:   \item[archive-path] The full path to the original resource
                    104:     --required.
                    105: 
                    106:   \item[description] An informal textual description of the relation
                    107:   of this resource to the original resource -- optional.
                    108:   \end{description}
                    109:   
                    110: \item[linked-with] Container for the description of another
                    111:   resource when this resource is a linked copy of another resource
                    112:   -- optional.
                    113: 
                    114:   \begin{description}
                    115:   \item[archive-path] The full path to the linked resource
                    116:     --required.
                    117: 
                    118:   \item[description] An informal textual description of the relation
                    119:   of this resource to the linked resource -- optional.
                    120:   \end{description}
                    121:   
                    122: \item[content-type] The content type of this resource -- required.\\
                    123:   The content type enables the choice of tools to manipulate and
                    124:   display the resource. There should be a common list of content
                    125:   types. For digital documents (books, manuscripts) this would be
                    126:   "scanned document", for other image data "scanned
                    127:   images".\footnote{The criterion for documents is a ordered
                    128:     succession of image files (pages) and equal image size and
                    129:     resolution throughout the images of a resource.}
                    130:   
                    131: \item[meta] Additional metadata information about the resource --
                    132:   optional.\\ For a description of additional metadata see below.
                    133: 
                    134: \item[dir] Container for the description of a subdirectory -- required
                    135:   (when there are subdirectories).\\ \texttt{dir} tags should not be
                    136:   nested. Directories at lower levels are identified by their
                    137:   \texttt{path}.
                    138: 
                    139:   \begin{description}
                    140:   \item[description] An informal textual description of the
                    141:     subdirectory -- optional.
                    142: 
                    143:   \item[name] The name of the subdirectory -- required.
                    144:     
                    145:   \item[path] The directory path of this subdirectory relative to the
1.5       casties   146:     resource's root directory (excluding the directory itself) --
                    147:     required (may be empty or omitted if the directory is a direct
                    148:     child of the resource's root directory).
1.1       casties   149:     
                    150:   \item[meta] Additional metadata information about the directory --
                    151:     optional.\\ For a description of additional metadata see below.
                    152:   \end{description}
                    153:   
                    154: \item[file] Container for the description of a file -- deduced.\\
                    155:   \texttt{file} tags should not be nested in \texttt{dir} tags. Files
                    156:   at lower directory levels are identified by their \texttt{path}.
                    157: 
                    158:   \begin{description}
                    159:   \item[description] An informal textual description of the
                    160:     file -- optional.
                    161: 
                    162:   \item[name] The name of the file -- required.
                    163:     
                    164:   \item[path] The directory path of this file relative to the
1.5       casties   165:     resource's root directory (excluding the file itself) -- required
                    166:     (may be empty or omitted if the file is in the resource's root
                    167:     directory).
1.7       casties   168:     
                    169:   \item[date] The file's modification or creation date\footnote{The
                    170:       preferred time and date format is ``YYYY/MM/DD HH:MM:SS''},
                    171:     whichever is more recent -- optional.
1.1       casties   172: 
                    173:   \item[modification-date] The file's modification date -- optional.
                    174: 
                    175:   \item[creation-date] The file's creation date -- optional.
1.7       casties   176:     
1.1       casties   177:   \item[size] The file size -- deduced.
                    178:     
                    179:   \item[mime-type] The file's mime-type -- optional.
                    180: 
                    181:   \item[md5cs] MD5 checksum of the file content -- optional.
                    182:     
                    183:   \item[meta] Additional metadata information about the file --
                    184:     optional. For a description of additional metadata see below.
                    185:   \end{description}
                    186:   
                    187: \end{description}
                    188: 
                    189: 
                    190: 
                    191: \section{Additional metadata}
                    192: \label{sec:additional-metadata}
                    193: 
                    194: All elements with \texttt{meta} tags can contain an arbitrary number
                    195: of additional metadata elements.
                    196: 
1.4       casties   197: \subsection{Language}
                    198: \label{sec:lang}
                    199: 
                    200: The language of a resource (e.g. a text) can be specified with a
                    201: \texttt{lang} tag. Languages have to be described using the
                    202: international codes for the representation of names of languages
                    203: either in two-letter form (ISO 639-1) or in three-letter form (ISO
                    204: 639-2).  The entire catalogue of languages is documented on the page
                    205: 
                    206: \url{http://www.loc.gov/standards/iso639-2/englangn.html}
                    207: 
1.1       casties   208: 
                    209: \subsection{DRI}
                    210: \label{sec:dri}
                    211: 
                    212: The \emph{digital resource identifier} for the resource is specified
1.4       casties   213: in a \texttt{dri} element. Digital resource identifiers are documented
1.1       casties   214: on the page
                    215: 
                    216: \url{http://pythia.mpiwg-berlin.mpg.de/projects/standards/dri}.
                    217: 
                    218: 
1.4       casties   219: 
                    220: \subsection{Collection context}
                    221: \label{sec:collection-context}
                    222: 
                    223: The context of a resource as part of a collection or part of a project can be
1.5       casties   224: specified in the \texttt{context} element. All elements in the
                    225: container can appear multiple times.
1.4       casties   226: 
                    227: \begin{description}
1.5       casties   228: \item[context] information on collection or project context.
1.4       casties   229: 
1.5       casties   230:   \begin{description}
                    231:   \item[link] URL to additional context information.
                    232:     
                    233:   \item[name] Textual description of project or collection.
                    234:   \end{description}
1.4       casties   235: \end{description}
1.5       casties   236: 
1.4       casties   237: 
                    238: 
                    239: 
1.1       casties   240: \subsection{Bibliographic information}
                    241: \label{sec:bibliographic-data}
                    242: 
1.5       casties   243: Bibliographic information is presented in a \texttt{bib} container with
1.1       casties   244: a \texttt{type} parameter, giving the type of bibliographic resource.
1.4       casties   245: The \texttt{type} field can be repeated as a tag in the container.
                    246: 
1.5       casties   247: The format is based on the ECHO scheme for bibliographic data (cf.
                    248: content workflow), the MPIWG ``Projektbibliografie'' and the format of
                    249: the commonly used program ``EndNote''.
                    250: 
1.4       casties   251: 
                    252: \subsubsection{Book}
                    253: 
                    254: \begin{description}
                    255: 
                    256: \item [bib type="book"] a published book.
                    257: 
                    258:   \begin{description}
                    259:   \item [author] The author of the book.
                    260:   \item [year] The year of publication.
                    261:   \item [title] Title of the book.
                    262:   \item [series-editor] Name of the series editor, if the book appears
                    263:     in a series.
                    264:   \item [series-title] Title of the serie, if the book appears in a
                    265:     series.
                    266:   \item [series-volume] Volume number, if the book appears in a
                    267:     series.
                    268:   \item [number-of-pages] Number of pages of the entire book.
                    269:   \item [city] City where the book was published.
                    270:   \item [publisher] Name of the publishing company
                    271:   \item [edition] Edition of the book (e.g. third edition)
                    272:   \item [number-of-volumes] Number of volumes, if the the book is
                    273:     published in multiple volumes.
                    274:   \item [translator] Name of the translator.
                    275:   \item [isbn-issn]
                    276:   \end{description}
                    277: \end{description}
                    278: 
                    279: \subsubsection{In Book}
                    280: 
                    281: \begin{description}
                    282: \item [bib type="inbook"] an article as part of a book.
                    283: 
                    284:   \begin{description}
                    285:   \item [author] The author of the book.
                    286:   \item [year] The year of publication.
                    287:   \item [title] Title of the article.
                    288:   \item [editor] Name of the book's editor.
                    289:   \item [book-title] Title of the book.
                    290:   \item [series-volume] Volume number, if the book appears in a
                    291:     series.
                    292:   \item [pages] Number of pages of the article.
                    293:   \item [city] City where the book was published.
                    294:   \item [publisher] Name of the publishing company
                    295:   \item [edition] Edition of the book (e. g. third edition)
                    296:   \item [series-author] Name of the series editor, if the book appears
                    297:     in a series.
                    298:   \item [series-title] Title of the series, if the book appears in a
                    299:     series.
                    300:   \item [number-of-volumes] Number of volumes, if the the book is
                    301:     published in multiple volumes.
                    302:   \item [translator] Name of the translator
                    303:   \item [isbn-issn]
                    304:   \end{description}
                    305: \end{description}
                    306: 
                    307: \subsubsection{Proceedings}
                    308: 
                    309: \begin{description}
                    310: \item [bib type="proceedings"] a conference proceedings publication.
                    311: 
                    312:   \begin{description}
                    313:   \item [author] The author of the article.
                    314:   \item [year] The year of publication.
                    315:   \item [title] Title of the article.
                    316:   \item [editor] Name of the book's editor.
                    317:   \item [conference-name] Name of the conference the proceedings are
                    318:     related to.
                    319:   \item [volume] Volume number.
                    320:   \item [pages] Number of pages of the article.
                    321:   \item [date] Date of the conference the proceedings are related to.
                    322:   \item [conference]-location City where the conference was held.
                    323:   \item [publisher] Name of the publishing company
                    324:   \item [edition] Edition of the book (e. g. third edition)
                    325:   \item [series-editor] Name of the series editor, if the book appears
                    326:     in a series.
                    327:   \item [series-title] Title of the series, if the book appears in a
                    328:     series.
                    329:   \item [number-of-volumes] Number of volumes, if the the book is
                    330:     published as multiple volumes.
                    331:   \item [isbn-issn]
                    332:   \end{description}
                    333: \end{description}
                    334: 
                    335: \subsubsection{Edited Book}
                    336: 
                    337: \begin{description}
                    338: \item[bib type="edited-book"] a book that is the edition of another
                    339:   work.
                    340: 
                    341:   \begin{description}
                    342:   \item [editor] Name of the editor of the book.
                    343:   \item [year] The year of publication.
                    344:   \item [title] Title of the book.
                    345:   \item [series-editor] Name of the editor of the series the book is
                    346:     part of.
                    347:   \item [series-title] Title of the series, if the book is part of a
                    348:     series.
                    349:   \item [series-volume] Volume number, if the book appears in a series.
                    350:   \item [number-of-pages] Number of pages of the article.
                    351:   \item [city] City where the book was published.
                    352:   \item [publisher] Name of the publishing company
                    353:   \item [edition] Information about the edition (e.g. ``Repr. of the London ed. 1652'')
                    354:   \item [number-of-volumes] Number of volumes, if the the book is
                    355:     published as multiple volumes.
                    356:   \item [isbn-issn]
                    357:   \end{description}
                    358: \end{description}
                    359: 
                    360: \subsubsection{Journal Article}
                    361: 
                    362: \begin{description}
                    363: \item [bib type="journal-article"] an article in a scientific journal.
                    364:   \begin{description}
                    365:   \item [author] The author of the article.
                    366:   \item [year] The year of publication.
                    367:   \item [title] Title of the article.
                    368:   \item [journal] Name of the journal.
                    369:   \item [volume] Volume number, if the journal appears in a series.
                    370:   \item [issue] Number of the issue the article is part of.
                    371:   \item [pages] Number of pages of the article.
                    372:   \item [alternate-journal] Alternate Journal
                    373:   \item [isbn-issn]
                    374:   \end{description}
                    375: \end{description}
                    376: 
                    377: \subsubsection{Magazine Article}
                    378: 
                    379: \begin{description}
                    380: \item [bib type="magazine-article"] an article in a popular magazine.
                    381:   \begin{description}
                    382:   \item [author] The author of the book.
                    383:   \item [year] The year of publication.
                    384:   \item [title] Title of the article.
                    385:   \item [magazine] Name of the magazine.
                    386:   \item [volume] Volume number, if the book appears in a series.
                    387:   \item [issue-number] Number of the issue the article is part of.
                    388:   \item [pages Number] of pages of the article.
                    389:   \item [date] Date when the article appeared.
                    390:   \end{description}
                    391: \end{description}
                    392: 
                    393: \subsubsection{Newspaper Article}
                    394: 
                    395: \begin{description}
                    396: \item [bib type="newspaper-article"] an article in a newspaper.
                    397:   \begin{description}
                    398:   \item [author] The author of the article.
                    399:   \item [year] The year of publication.
                    400:   \item [title] Title of the article.
                    401:   \item [Newspaper] Name of the newspaper the article appeared in.
                    402:   \item [pages] Number of pages of the article.
                    403:   \item [issue-date] Date of the issue the article is part of.
                    404:   \item [city] City of the newspaper.
                    405:   \end{description}
                    406: \end{description}
                    407: 
                    408: \subsubsection{Thesis}
                    409: 
                    410: \begin{description}
                    411: \item [bib type="thesis"] a master/doctorate/etc. thesis.
                    412:   \begin{description}
                    413:   \item [author] The author of the thesis.
                    414:   \item [year] The year of publication.
                    415:   \item [title] Title of the thesis.
                    416:   \item [academic-department] Name of the academic department where
                    417:     the thesis was handed in.
                    418:   \item [number-of-pages] Number of pages of the thesis.
                    419:   \item [city] City where the thesis was published.
                    420:   \item [University] Name of the university where the thesis was
                    421:     handed in.
                    422:   \item [isbn-issn]
                    423:   \end{description}
                    424: \end{description}
                    425: 
                    426: \subsubsection{Report}
                    427: 
                    428: \begin{description}
                    429: \item [bib type="report"] a scientific report.
                    430:   \begin{description}
                    431:   \item [author] The author of the report.
                    432:   \item [year] The year of publication.
                    433:   \item [title] Title of the report.
                    434:   \item [pages] Number of pages of the report.
                    435:   \item [date] Date when the report appeared.
                    436:   \item [city] City where the book was published.
                    437:   \item [institution] Institution where the report was produced.
                    438:   \item [type] Type of report.
                    439:   \item [report-number] Report number.
                    440:   \end{description}
                    441: \end{description}
                    442: 
1.5       casties   443: \subsubsection{Manuscript}
                    444: 
                    445: \begin{description}
                    446: \item [bib type="manuscript"] a handwritten/typewritten manuscript.
                    447: 
                    448:   \begin{description}
                    449:   \item [title] Title of the manuscript.
                    450:   \item [author] The author of the text.
                    451:   \item [location] Name of the library where the manuscript is
                    452:     currently located.
                    453:   \item [year] The year or century of publication.
                    454:   \item [pages] Number of pages of the manuscript.
                    455:   \item [signature] Signature of the manuscript.
                    456:   \item [editorial-remarks] Remarks related to the online
                    457:     publication of the manuscript. This could be notes about
                    458:     annotations etc.
                    459:   \item [description] This can be any kind of description.
                    460:   \item [keywords] Keywords related to the manuscript.
                    461:   \end{description}
                    462: \end{description}
                    463: 
                    464: 
1.4       casties   465: \subsubsection{Generic}
                    466: 
                    467: \begin{description}
                    468: \item [bib type="generic"] a generic bibliographic type. This type
                    469:   should only be used in rare cases.
                    470:   \begin{description}
                    471:   \item [author]
                    472:   \item [year]
                    473:   \item [title]
                    474:   \item [secondary-author]
                    475:   \item [secondary-title]
                    476:   \item [volume]
                    477:   \item [number]
                    478:   \item [pages]
                    479:   \item [date]
                    480:   \item [place-published]
                    481:   \item [publisher]
                    482:   \item [edition]
                    483:   \item [tertiary author]
                    484:   \item [tertiary-title]
                    485:   \item [number-of-volumes]
                    486:   \item [type-of-work]
                    487:   \item [subsidiary author]
                    488:   \item [alternate-title]
                    489:   \item [isbn-issn]
                    490:   \item [call-number]
                    491:   \item [label]
                    492:   \item [keywords]
                    493:   \item [abstract]
                    494:   \item [notes]
                    495:   \item [url]
1.5       casties   496:   \end{description}
1.4       casties   497: \end{description}
                    498: 
                    499: 
                    500: \subsection{Architectural drawings}
                    501: \label{sec:doc}
                    502: 
                    503: Specific information for architectural drawings is presented in a
1.5       casties   504: \texttt{doc} container with an additional \texttt{type} attribute
                    505: giving the type of drawing. All elements inside the container can
                    506: appear multiple times.
1.4       casties   507: 
                    508: \begin{description}
1.5       casties   509: 
                    510: \item[doc type="Architectural Drawing"] architectural drawing.
                    511: 
                    512:   \begin{description}
                    513:   \item [person] last name and first name of a person, separated by a
                    514:     comma. A further common name for the person can be put infront,
                    515:     separated by a semicolon.
                    516:   \item [location] Name of a place in its common notation. This can be
                    517:     a city or a institution.
                    518:   \item [date] This can be a year (or several years, separated by
                    519:     commas) or a period (1706-1714). Years are noted with four digits.
                    520:   \item [object] Short description of an object or signatures.
                    521:   \item [keywords] Keywords related to the object.
                    522: \end{description}
1.4       casties   523: \end{description}
1.1       casties   524: 
                    525: 
                    526: \subsection{Information on the document structure (table of contents)}
                    527: \label{sec:toc}
                    528: 
1.4       casties   529: Information on the structure of a document like the division into
                    530: parts and chapters in the way of a table of contents is presented in a
                    531: \texttt{toc} container. 
                    532: 
                    533: The scheme allows multiple logical pages on a single page image
                    534: as it is often the case with scanned books or manuscripts. The scheme
                    535: also allows for ``loose'' numbering schemes with roman, arabic or
                    536: other page numbers consecutively or mixed and changes in the numbering
                    537: within the document.
                    538: 
                    539: The flexibility comes from the fact that no additional assumptions
                    540: about the mapping between logical pages and page images are made in
                    541: the format. All mapping information is specified by the user.
                    542: 
                    543: The logical page numbering or naming that can be presented to the user
                    544: is specified in the \texttt{name} tags while the physical numbering of
                    545: the page images is specified in the \texttt{index} or \texttt{url}
                    546: tags.
1.1       casties   547: 
1.4       casties   548: \begin{description}
1.5       casties   549: \item[toc] container for document structure
                    550: 
1.4       casties   551:   \begin{description}
1.5       casties   552:   \item[page] describes a single logical page
                    553: 
                    554:     \begin{description}
                    555:     \item[name] the ``name'' of the logical page. This can be any string
                    556:       like a page number (arabic, roman, etc.) or a special designation
                    557:       like ``Table 5''.
                    558:       
                    559:     \item[index] the \texttt{digilib} index number\footnote{The index
                    560:         number for digilib is the index in the alphabetical order of the
                    561:         scan file names.} of the scan image of the page.
                    562:       
                    563:     \item[url] alternatively to the \texttt{digilib} index number the
                    564:       full URL of the scan image of the page can be used.
                    565:     \end{description}
1.4       casties   566:     
1.5       casties   567:   \item[chapter] describes a section or chapter of the text.
                    568:     \texttt{chapter} elements can be nested.
1.1       casties   569: 
1.4       casties   570:     \begin{description}
1.5       casties   571:     \item[name] the title of the chapter or section.
                    572:       
                    573:     \item[start] the beginning of a page range (usually the first page
                    574:       of the chapter). The \texttt{start} element has an optional
                    575:       \texttt{increment} attribute to indicate the number of logical
                    576:       pages on a scan image.\footnote{This information is only needed by
                    577:         additional tools that try to generate lists of all page and
                    578:         image numbers.}
                    579: 
                    580:       \begin{description}
                    581:       \item[name] the ``name'' of the first page (see \texttt{page}).
                    582:         
                    583:       \item[index] the index of the first page (see \texttt{page}).
                    584:         
                    585:       \item[url] the URL of the first page (see \texttt{page}).
                    586:       \end{description}
                    587:       
                    588:     \item[end] the end of a page range (usually the last page of the
                    589:       chapter).
                    590: 
                    591:       \begin{description}
                    592:       \item[name] the ``name'' of the last page (see \texttt{page}).
                    593:         
                    594:       \item[index] the index of the last page (see \texttt{page}).
                    595:         
                    596:       \item[url] the URL of the last page (see \texttt{page}).
                    597:       \end{description}
                    598:       
                    599:     \item[page] alternative (and additional) to
                    600:       \texttt{start}/\texttt{end} page ranges single \texttt{page}
                    601:       elements can be used inside \texttt{chapter}.
1.4       casties   602:     \end{description}
                    603:   \end{description}
                    604: \end{description}
                    605: 
                    606: %%\url{http://pythia.mpiwg-berlin.mpg.de/toolserver/TS_lise}
1.1       casties   607: 
                    608: 
                    609: \subsection{Information on scanned images}
                    610: \label{sec:inform-scann-imag}
                    611: 
                    612: Image files representing scanned images can have an \texttt{img}
                    613: container tag with information about the scan resolution and the size
                    614: of the original image. This information is used by the
                    615: \texttt{digilib} image viewing tool.
                    616: 
                    617: Required is one of three possible sets of tags:
                    618: 
                    619: \begin{description}
1.5       casties   620: \item[img] digital image information.
1.1       casties   621: 
1.5       casties   622:   \begin{description}
                    623:   \item[original-size-x] The width of the original image. The unit of
                    624:     measure can be contained as parameter \texttt{unit}, the default
                    625:     is meter ``m''. The width to be considered is the total width of
                    626:     the scanned area.
                    627:     
                    628:   \item[original-size-y] The height of the original image.
                    629:     
                    630:   \item[original-pixel-x] The width of the hi-res scan in pixels.
                    631:     
                    632:   \item[original-pixel-y] The height of the hi-res scan in pixels.
                    633:   \end{description}
1.1       casties   634: \end{description}
                    635: 
                    636: or
                    637: 
                    638: \begin{description}
1.5       casties   639: \item[img] digital image information.
                    640: 
                    641:   \begin{description}
                    642:   \item[original-dpi-x] The resolution of the hi-res scan in its width
                    643:     in pixels per inch.
1.1       casties   644: 
1.5       casties   645:   \item[original-dpi-y] The resolution of the hi-res scan in its height
                    646:     in pixels per inch.
                    647:   \end{description}
1.1       casties   648: \end{description}
                    649: 
                    650: or
                    651: 
                    652: \begin{description}
1.5       casties   653: \item[img] digital image information.
                    654: 
                    655:   \begin{description}
                    656:   \item[original-dpi] The resolution of the hi-res scan in pixels per
                    657:     inch if the resolutions in width and height are the same.
                    658:   \end{description}
1.1       casties   659: \end{description}
1.7       casties   660: 
                    661: 
                    662: \subsection{Full text with images}
                    663: \label{sec:full-text-with}
                    664: 
1.8     ! casties   665: Full text in a XML format will be specified with a
        !           666: \texttt{content-type} ``fulltext''.
        !           667: 
        !           668: The relation between the full text and optional images of
        !           669: whole pages or parts of pages must be specified in a
        !           670: \texttt{text-tool} container.
        !           671: 
        !           672: \begin{description}
        !           673: \item[text-tool] representation of full text with images
        !           674: 
        !           675:   \begin{description}
        !           676:   \item[text-file] the file name of the full text file (with path
        !           677:     inside document directory)
        !           678: 
        !           679:   \item[page-images] the directory name of the directory containig the
        !           680:     page image files (with path
        !           681:     inside document directory)
        !           682: 
        !           683:   \item[xslt-file] the file name of an additional XSL transformation
        !           684:     file
        !           685: 
        !           686:   \item[text-config] container for configuration options
        !           687: 
        !           688:   \item[container-tag] the name of the text root element (default ``text'')
        !           689: 
        !           690:   \item[ref-element-tag] the name of the element that is used as unit of
        !           691:     reference when results are presented
        !           692:     
        !           693:   \item[pagebreak-tag] the name of the element that indicates page
        !           694:     breaks (default ``pb'')
        !           695:   \end{description}
        !           696: \end{description}
1.7       casties   697: 
1.1       casties   698: 
                    699: 
                    700: \subsection{Access restrictions}
                    701: \label{sec:access-restrictions}
                    702: 
                    703: If the access to a resource is restricted for technical or legal
                    704: reasons then the restrictions can be put in a
                    705: \texttt{access-restrictions} container. The format of the information
                    706: inside the container has to be further specified.
                    707: 
                    708: 
1.4       casties   709: \section{Sample metadata files for ECHO resources}
1.1       casties   710: 
1.5       casties   711: The following is a sample metadata index file for a directory containig a
                    712: scanned document.
                    713: 
                    714: \begin{small}
1.1       casties   715: \begin{verbatim}
                    716: <resource type="ECHO">
1.5       casties   717:   <description>Fleck, 1980</description>
                    718:   <name>fleck.1980</name>
                    719:   <creator>University of Bern</creator>
                    720:   <archive-path>ubern/wiss-theorie</archive-path>
                    721:   <content-type>scanned images</content-type>
                    722:   <meta>
                    723:     <dri>echo23a45e2329x</dri>
                    724:     <lang>ger</lang>
                    725:     <bib type="book">
                    726:       <author>Fleck, Ludwik</author>
                    727:       <year>1980</year>
                    728:       <title>Entstehung und Entwicklung einer 
                    729:              wissenschaftlichen Tatsache</title>
                    730:       <series-editor></series-editor>
                    731:       <series-title></series-title>
                    732:       <series-volume></series-volume>
                    733:       <number-of-pages></number-of-pages>
                    734:       <city>Frankfurt am Main</city>
                    735:       <publisher>Suhrkamp</publisher>
                    736:       <edition></edition>
                    737:       <number-of-volumes></number-of-volumes>
                    738:       <translator></translator>
                    739:       <isbn-issn></isbn-issn>
                    740:       <keywords>Wissenschaftstheorie, Fleck, Tatsache</keywords>
                    741:       <abstract></abstract>
                    742:     </bib>
                    743:   </meta>
                    744:   <dir>
                    745:      <description>Scanned images (300dpi)</description>
                    746:      <name>img</name>
                    747:   </dir>
1.4       casties   748: </resource>
                    749: \end{verbatim}
1.5       casties   750: \end{small}
1.4       casties   751: 
1.5       casties   752: The following is a sample metadata file for a single image of an
                    753: architectural drawing.
1.4       casties   754: 
1.5       casties   755: \begin{small}
1.4       casties   756: \begin{verbatim}
                    757: <resource type="ECHO">
1.5       casties   758:   <creator>Bibliotheca Hertziana</creator>
                    759:   <content-type>scanned images</content-type>
                    760:   <file>
                    761:     <name>00000271-asl-160-r-full.tif</name>
                    762:     <meta>
                    763:       <img>
                    764:         <original-dpi>315</original-dpi>
                    765:       </img>
                    766:       <dri>echo45a67bc4367d</dri>
                    767:       <lang>ita</lang>
                    768:       <doc type="Architectural Drawing">
                    769:         <person>Ciolli, Giacomo</person>
                    770:         <person>Urban VIII; Barberini, Maffeo</person>
                    771:         <location>Accademia di San Luca</location>
                    772:         <location>Roma</location>
                    773:         <date>1706</date>
                    774:         <object>Concorso Clementino</object>
                    775:         <object>Fontana Pubblica</object>
                    776:         <object>Brunnen</object>
                    777:         <object>ASL 160</object>
                    778:         <keywords></keywords>
                    779:       </doc>
                    780:       <context>
                    781:          <url>http://colosseum.biblhertz.it:8080/Lineamenta/
                    782:          1033478408.39/1035196181.35/1035196204.09/1035394121.83
                    783:          </url>
                    784:       </context>
                    785:     </meta>
                    786:   </file>
1.2       casties   787: </resource>
1.1       casties   788: \end{verbatim}
1.5       casties   789: \end{small}
1.1       casties   790: 
                    791: \end{document}
                    792: 
                    793: %%% Local Variables: 
                    794: %%% mode: latex
                    795: %%% TeX-master: t
                    796: %%% End: 

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