version 1.4, 2004/01/06 21:34:05
|
version 1.16, 2004/03/17 09:31:01
|
Line 2
|
Line 2
|
\label{sec:rec.cgi} |
\label{sec:rec.cgi} |
|
|
\paragraph |
\paragraph |
On the ECHO server, new texts are registered by means of reg.cgi ( |
On the ECHO server, the registration of new texts is implemented by |
archimedes/web/cgi-bin/toc/admin/reg.cgi ). reg.cgi retrieves a |
means of a cgi script, reg.cgi |
metadata file from the entered uri (currently only local paths are |
(archimedes/web/cgi-bin/toc/admin/reg.cgi ). reg.cgi retrieves a |
supported ) and constructs from this file a toc.cgi object file (see |
metadata file in MPIWG archive metadata format from the entered uri |
below) , which it writes to toc.cgi's data section. [corpus???] |
(currently only local paths are supported ) and constructs from this |
|
file a toc.cgi object file (see below) , which it writes to toc.cgi's |
|
data section. [corpus???] It should be stressed that this is a |
|
registration procedure developed for a particular implementation of |
|
toc.cgi and not a part of the core application. |
|
|
\paragraph |
\paragraph |
reg.cgi takes two parameters, path and show. Path should give the |
reg.cgi takes two parameters, path and show. Path should give the |
Line 15 registered. If ``show'' is set to 1, reg
|
Line 19 registered. If ``show'' is set to 1, reg
|
inspection the toc.cgi object file that it has built out of the |
inspection the toc.cgi object file that it has built out of the |
submitted metadata file. |
submitted metadata file. |
|
|
|
\paragraph{input metadata file} |
|
|
|
The input metadata file must have the following form |
|
|
|
\paragraph |
|
|
|
<resource> |
|
... |
|
<meta> |
|
<meta> |
|
<bib type=''Book''> |
|
|
|
<title>Mainzer Untergerichtsordnung (von 1534)</title> |
|
<author>anon</author> |
|
<year>1580</year> |
|
<texttool><display>yes</display> |
|
<image>pageimgtif</image> |
|
<text>/mpiwg/online/experimental/echo_DRQEdit_test/anon_Mainz_1580/fulltextDW/mainzugo02_utf8.xml</text> |
|
<pagebreak>pb</pagebreak><presentation>01-presentation/info.xml</presentation></texttool></meta> |
|
|
|
</meta> |
|
|
|
\paragraph{archimedes object registration} |
|
|
\subsubsection{toc.cgi (display text)} |
\subsubsection{toc.cgi (display text)} |
\label{sec:toc.cgi} |
\label{sec:toc.cgi} |
Line 22 submitted metadata file.
|
Line 49 submitted metadata file.
|
\paragraph{plan of this section } |
\paragraph{plan of this section } |
|
|
\begin{enumeration} |
\begin{enumeration} |
|
\item An overview of toc.cgi architecture |
\item A walk-through of typical cgi queries for toc.cgi |
\item A walk-through of typical cgi queries for toc.cgi |
\item An index of cgi parameters and values with short descriptions of function |
\item An index of cgi parameters and values with short descriptions of function |
|
\item The TOC Perl modules |
\end{enumeration} |
\end{enumeration} |
|
|
|
\paragraph{Overview of toc.cgi architecture} |
|
|
|
\subparagraph{} |
|
toc.cgi is a perl script for displaying collections of xml texts and |
|
linking them to related resources such as page-images, morphological |
|
analysis, commentaries, dictionaries, etc. It implements generic methods |
|
for resource-linking provided by a series of perl modules which are in |
|
turn based mainly on generic open-source tools for xml manipulation and networking |
|
written in C. |
|
|
|
\subparagraph{toc.cgi collections--Network transparency} |
|
Each of the collections in toc.cgi is a ``virtual'' collection, that |
|
is, a collection of links or uri's to resources that reside somewhere on an accessible |
|
network, local or remote. |
|
|
|
\subparagraph{toc.cgi collections--remote resources} |
|
|
|
What is at the other end of the link is of no concern to toc.cgi, as |
|
long as the resource referenced by the link meets minimal toc.cgi |
|
requirements--how the resource is actually implemented and exposed is |
|
a matter for the resource provider. The link may, for instance, point |
|
directly to an xml text or it may point to a container which exposes a |
|
particular xml view of an underlying resource that is perhaps not in |
|
xml format at all. |
|
|
|
|
|
\subparagraph{resource registry} |
|
|
|
|
|
|
|
|
\paragraph{cgi parameters -- standard queries} |
\paragraph{cgi parameters -- standard queries} |
|
|
\htmladdnormallink{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi?step=corpus }{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi?step=corpus } |
\htmladdnormallink{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi?step=corpus }{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi?step=corpus } |
Line 77 get a work from default corpus with thum
|
Line 137 get a work from default corpus with thum
|
get a page of text from a work from default corpus |
get a page of text from a work from default corpus |
|
|
|
|
|
\paragraph{TOC Perl Modules} |
|
\subparagraph{general}The documentation for the Toc Perl Modules is |
|
located in the modules themselves in POD format. The POD is the |
|
definitive documentation for the modules. |
|
|
|
The modules are available to archimedes staff from cvs on the archimedes server at |
|
141.14.236.86:/perseus/cvsroot in the module |
|
/perseus/cvsroot/mpitexts/perl/perllib. To get them, log on to the |
|
archimedes server and use the commandline command: |
|
|
|
cvs -d /perseus/cvsroot co /perseus/cvsroot/mpitexts/perl/perllib |
|
|
|
or from a remote location |
|
|
|
bash; export CVS_RSH=ssh; cvs -d :ext:myusername@141.14.236.86:/perseus/cvsroot co /perseus/cvsroot/mpitexts/perl/perllib |
|
|
\subsubsection{Indexing} |
\subsubsection{Indexing} |
\label{sec:indexing} |
\label{sec:indexing} |
|
|
|
\paragraph{Status quo ECHO} |
|
Currently indexing is not implemented on the ECHO server. |
|
|
|
\paragraph{Plan ECHO} |
|
|
|
\begin{enumeration} |
|
\item construct remote (141.14.236.86) index for each file at |
|
per-change or daily intervals |
|
\item store indices locally in |
|
archimedes/data/db/PROJECT_NAME/CORPUS_NAME/WORK |
|
\item 2 progs on server 1. cgi: indexer 2. backend da_remote |
|
\item 2 progs on client 1. cgi: sendindex 2. backend getindex |
|
\item indexing transaction handled by two cgi scripts, one on the |
|
server the other on the client [this is the 1st implementation bcs |
|
its easiest and there are no port issues, but probably it'd be |
|
better to have a separate port]. |
|
\item client cgi: getindex -- sends 1. list of files to index |
|
2. uri to which xml notification of completion is to be sent. Upon |
|
notification, activates backend prog that fetches and installs the |
|
indices. |
|
\item server cgi: indexer receives filelist and notification |
|
addess. Activates backend that fetches files, indexes, places |
|
completed indexes in a networked location, then sends xml |
|
notification back to client. |
|
\item single script provides backend access to indices |
|
\item leave front-end issues like display, collection and navigation |
|
to web-design programmers. Do only a sample for now. |
|
\end{enumeration} |
|
|
\subsubsection{Morphology} |
\subsubsection{Morphology} |
\label{sec:morphology} |
\label{sec:morphology} |
Line 91 get a page of text from a work from defa
|
Line 193 get a page of text from a work from defa
|
\label{sec:dictionary-server} |
\label{sec:dictionary-server} |
|
|
|
|
|
\subsubsection{helper programs} |
|
|
|
\paragraph{addarch.pl ARCHIMEDES} |
|
|
|
Automatically registers new texts as toc.cgi objects when they appear in |
|
cvs. Automatically updates relevant morphological indices (slow!) each |
|
time a cvs update occurs. This program is called by a hook in the cvs |
|
``loginfo'' configuration file. |
|
|
|
|
|
\paragraph{makelemma.pl ARCHIMEDES} |
|
|
|
Updates lemmatization indices. |
|
Parameters: |
|
No parameter--update all lemmatization indices |
|
[latin | ital | greek | en | nl | de]-- update this language |
|
|
|
\paragraph{makefast.pl ARCHIMEDES} |
|
|
|
Updates the toc.cgi morphology indices |
|
Parameters |
|
No parameter--update all lemmatization indices |
|
[latin | ital | greek | en | nl | de]-- update this language |
|
|
|
\subsubsection{summary of differences btwn the archimedes toc.cgi |
|
implementation and the echo toc.cgi impelementation (toc.x.cgi)} |
|
|
|
\paragraph{missing in archimedes} |
|
\begin{enumeration} |
|
|
|
\item html templates (coded but phased out of cvs branch) |
|
\end{enumeration} |
|
|
|
\paragraph{missing in echo} |
|
\begin{enumeration} |
|
|
|
\item word-coloring? |
|
\item remote text method may work differently |
|
|
|
|
|
|
|
\end{enumeration} |
|
\paragraph{differences} |
|
\begin{enumeration} |
|
\item structure of info.xml |
|
\item resource-discovery algorithm for info.xml |
|
\end{enumeration} |
|
|
|
|
|
|
%%% Local Variables: |
%%% Local Variables: |
%%% mode: latex |
%%% mode: latex |
%%% TeX-master: "texttools" |
%%% TeX-master: "texttools" |