--- texttool-architecture/soft-cgi.tex	2004/01/13 11:01:18	1.8
+++ texttool-architecture/soft-cgi.tex	2004/03/17 09:31:01	1.16
@@ -49,18 +49,43 @@ The input metadata file must have the fo
 \paragraph{plan of this section }
 
 \begin{enumeration}
+\item An overview of toc.cgi architecture
 \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 The TOC Perl modules
 \end{enumeration}
 
-\paragraph{}
+\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 tools for xml manipulation and networking
+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}
 
 \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 }
@@ -112,11 +137,53 @@ get a work from default corpus with thum
 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}
 \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}
 \label{sec:morphology}
@@ -150,6 +217,32 @@ 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: 
 %%% mode: latex
 %%% TeX-master: "texttools"