--- storage/meta/meta-format.tex 2010/12/20 13:06:55 1.26 +++ storage/meta/meta-format.tex 2011/08/01 10:36:19 1.30 @@ -3,10 +3,10 @@ \usepackage[latin1]{inputenc} \usepackage[T1]{fontenc} \usepackage{ae} -%\usepackage{times} -%\usepackage{courier} +\usepackage{times} +\usepackage{courier} -% create in-text links black (with PDF) +% create in-text links in black (with PDF) \usepackage[colorlinks=true,linkcolor=black]{hyperref} % Format URLs nicely (without PDF) %\usepackage{url} @@ -16,7 +16,7 @@ \author{Robert Casties, Dirk Wintergrün, Hans-Christoph Liess} -\date{V1.3.8 of 30.8.2010} +\date{V1.4.0 of 1.8.2011} \begin{document} @@ -710,6 +710,7 @@ with detailed information about the manu \item [bib type="codex"] Codex i.e. bound collection of one or more manuscripts. \begin{description} +%TODO: do we need collection information? \item[holding-library] Holding library. \item[call-number] Call number/Shelf mark in holding library. \item[location] Place/City/Country where the codex is @@ -745,7 +746,7 @@ with detailed information about the manu \item [place] place where the letter was written/sent. \item [title] Title of the letter -- optional. \item[incipit] The opening phrase of the letter -- optional. - \item[excipit] The closing phrase of the letter -- optional. + \item[explicit] The closing phrase of the letter -- optional. \item [pages] Number of pages of the manuscript. \item [signature] Canonical signature/call number of the manuscript. \item [description] This can be any kind of description. @@ -791,32 +792,6 @@ with detailed information about the manu \end{description} -\subsection{Architectural drawings} -\label{sec:doc} - -Specific information for architectural drawings is presented in a -\texttt{doc} container with an additional \texttt{type} attribute -giving the type of drawing. All elements inside the container can -appear multiple times. - -\begin{description} - -\item[doc type="Architectural Drawing"] architectural drawing. - - \begin{description} - \item [person] last name and first name of a person, separated by a - comma. A further common name for the person can be put infront, - separated by a semicolon. - \item [location] Name of a place in its common notation. This can be - a city or a institution. - \item [date] This can be a year (or several years, separated by - commas) or a period (1706-1714). Years are noted with four digits. - \item [object] Short description of an object or signatures. - \item [keywords] Keywords related to the object. -\end{description} -\end{description} - - \subsection{Document structure (table of contents)} \label{sec:toc} @@ -824,7 +799,7 @@ Information on the structure of a docume parts and chapters in the way of a table of contents is presented in a \texttt{toc} container. -The scheme allows multiple logical pages on a single page image +This scheme allows multiple logical pages on a single page image as it is often the case with scanned books or manuscripts. The scheme also allows for ``loose'' numbering schemes with roman, arabic or other page numbers consecutively or mixed and changes in the numbering @@ -851,11 +826,14 @@ tags. like ``Table 5''. \item[index] the \texttt{digilib} index number\footnote{The index - number for digilib is the index in the alphabetical order of the + number for digilib is the index in the alphabetical ordering of the scan file names.} of the scan image of the page. + + \item[file] alternatively the file name (preferrably without extension) of the + scan image of the page. - \item[url] alternatively to the \texttt{digilib} index number the - full URL of the scan image of the page can be used. + \item[url] alternatively the full URL of the scan image of the + page can be used. \end{description} \item[chapter] describes a section or chapter of the text. @@ -875,6 +853,8 @@ tags. \item[name] the ``name'' of the first page (see \texttt{page}). \item[index] the index of the first page (see \texttt{page}). + + \item[file] the file name of the first page (see \texttt{page}). \item[url] the URL of the first page (see \texttt{page}). \end{description} @@ -886,6 +866,8 @@ tags. \item[name] the ``name'' of the last page (see \texttt{page}). \item[index] the index of the last page (see \texttt{page}). + + \item[file] the file name of the first page (see \texttt{page}). \item[url] the URL of the last page (see \texttt{page}). \end{description} @@ -987,13 +969,14 @@ digital image. \subsection{Full text with images} \label{sec:full-text-with} +The relation between a full text and optional images of +whole pages or parts of pages must be specified in a +\texttt{texttool} container. + Full text in a XML format should be specified with a \texttt{content-type}\footnote{see section~\ref{tag-content-type} on page\pageref{tag-content-type}} ``fulltext''. -The relation between the full text and optional images of -whole pages or parts of pages must be specified in a -\texttt{texttool} container. \begin{description} \item[texttool] representation of full text with images @@ -1012,6 +995,19 @@ whole pages or parts of pages must be sp \item[figure] the directory name of the directory containig the in-page figure image files (path inside document directory) + \item[page-flow] the reading direction of pages in this document: + either ``ltr'' (left-to-right, standard western page flow) or + ``rtl'' (right-to-left, still assuming increasing page numbers) + + \item[odd-scan-orientation] the orientation of all odd-numbered scan + pages regardless of \texttt{page-flow}: either ``left'' (all + odd-numbered scans are left hand sides) or ``right'' (all + odd-numbered scans are right hand sides, i.e. the first left hand + side is scan number 2). + + \item[title-scan-no] the index number of the scan of the title page or the + first text page + \item[xslt] the file name of an additional XSL transformation file @@ -1030,22 +1026,21 @@ reasons then the conditions can be put i container. Other usage conditions like copyright can also be documented in this container. -% attribute for type 'original', 'digital-image', 'text' -% tags can be repeated -% CC license short-cut - - \begin{description} \item[access-conditions] legal and technical conditions for access to - this resource + this resource. \\ + The \texttt{attribution}, \texttt{copyright}, and \texttt{access} + tags can be repeated with different \texttt{resource} attributes if + different conditions apply to different parts of the whole resource. \begin{description} \item[attribution] The name or institution this resource should be attributed to when it's publicly presented. \\ - The type of resource this condition applies to can be specified with a - \texttt{type} attribute with the values ``original'' (the physical object - that was scanned), ``digital-image'' (the scanned images), ``text'' - (the textual transcript). + The kind of resource this condition applies to can be specified with a + \texttt{resource} attribute with the values ``original'' (the + physical object that was scanned), ``digital-image'' (the scanned + images), ``text'' (the textual transcript). \\ + All tags inside can be repeated. \begin{description} \item[name] a name (free text) @@ -1058,8 +1053,8 @@ documented in this container. \end{description} \item[copyright] the copyright holder and the copyright conditions. \\ - The type of resource this condition applies to can be specified with a - \texttt{type} attribute with the values ``original'' (the physical object + The kind of resource this condition applies to can be specified with a + \texttt{resource} attribute with the values ``original'' (the physical object that was scanned), ``digital-image'' (the scanned images), ``text'' (the textual transcript). @@ -1078,18 +1073,20 @@ documented in this container. \item[description] free-text field for special or additional conditions - \item[license] the type of license for standardised licenses. + \item[license] the type of license if its a standardised license e.g. Creative Commons + \begin{description} + \item[url] a URL representing the license e.g. \url{http://creativecommons.org/licenses/by/3.0/} + \end{description} + \end{description} - \item[publish-metadata] metadata about this resource can be made - freely available when this tag is present (otherwise metadata has - the same access conditions as the rest of the resource). Access to - the resource itself is regulated separately by the \texttt{access} - element. + \item[access] conditions of access to this resource. Different + access types are specified by a \texttt{type} attribute. + The kind of resource this condition applies to can be specified with a + \texttt{resource} attribute with the values ``digital-image'' (the + scanned images), or ``text'' (the textual transcript). - \item[access] conditions of access to this resource. Different - access types are specified by a \texttt{type} attribute: \begin{description} \item[type=group] access restricted to the members of this named group. The method to identify a user belonging to a named group