Return to soft-cgi.tex CVS log

Up to [Repository] / texttool-architecture

added more stuff

    1: \subsubsection{rec.cgi (register text)}
    2: \label{sec:rec.cgi}
    3: 
    4: \paragraph
    5: On the ECHO server, the registration of new texts is implemented by
    6: means of a cgi script, reg.cgi
    7: (archimedes/web/cgi-bin/toc/admin/reg.cgi ). reg.cgi retrieves a
    8: metadata file  in MPIWG archive metadata format from the entered uri
    9: (currently only local paths are supported ) and constructs from this
   10: file a toc.cgi object file (see below) , which it writes to toc.cgi's
   11: data section. [corpus???] It should be stressed that this is a
   12: registration procedure developed for a particular implementation of
   13: toc.cgi and not a part of the core application. 
   14: 
   15: \paragraph
   16: reg.cgi takes two parameters, path and show.  Path should give the
   17: local path to the metadata file for the text that is being
   18: registered. If ``show'' is set to 1, reg.cgi will return for
   19: inspection the toc.cgi object file that it has built out of the
   20: submitted metadata file. 
   21: 
   22: \paragraph{input metadata file}
   23: 
   24: The input metadata file must have the following form
   25: 
   26: \paragraph
   27: 
   28: <resource>
   29:     ...
   30:     <meta>
   31:       <meta>
   32:                 <bib type=''Book''>
   33: 
   34: <title>Mainzer Untergerichtsordnung (von 1534)</title>
   35: <author>anon</author>
   36: <year>1580</year>
   37:         <texttool><display>yes</display>
   38: 	<image>pageimgtif</image>
   39: 	<text>/mpiwg/online/experimental/echo_DRQEdit_test/anon_Mainz_1580/fulltextDW/mainzugo02_utf8.xml</text>
   40: 	<pagebreak>pb</pagebreak><presentation>01-presentation/info.xml</presentation></texttool></meta>
   41: 
   42:     </meta>
   43: 
   44: \paragraph{archimedes object registration}
   45: 
   46: \subsubsection{toc.cgi (display text)}
   47: \label{sec:toc.cgi}
   48: 
   49: \paragraph{plan of this section }
   50: 
   51: \begin{enumeration}
   52: \item An overview of toc.cgi architecture
   53: \item A walk-through of typical cgi queries for toc.cgi
   54: \item An index of cgi parameters and values with short descriptions of function
   55: \end{enumeration}
   56: 
   57: \paragraph{Overview of toc.cgi architecture}
   58: 
   59: \subparagraph{}
   60: toc.cgi is a perl script for displaying collections of xml texts and 
   61: linking them to related resources such as page-images, morphological
   62: analysis, commentaries, dictionaries, etc. It implements generic methods
   63: for resource-linking provided by a series of perl modules which are in
   64: turn based mainly on generic open-source tools for xml manipulation and networking
   65: written in C. 
   66: 
   67: \subparagraph{toc.cgi collections--Network transparency}
   68: Each of the collections in toc.cgi is a ``virtual'' collection, that
   69: is, a collection of links or uri's to resources that reside somewhere on an accessible
   70: network, local or remote.  
   71: 
   72: \subparagraph{toc.cgi collections--remote resources}
   73: 
   74: What is at the other end of the link is of no concern to toc.cgi, as
   75: long as the resource referenced by the link meets minimal toc.cgi
   76: requirements--how the resource is actually implemented and exposed is
   77: a matter for the resource provider. The link may, for instance, point
   78: directly to an xml text or it may point to a container which exposes a
   79: particular xml view of an underlying resource that is perhaps not in
   80: xml format at all. 
   81: 
   82: 
   83: \subparagraph{resource registry}
   84: 
   85: 
   86: 
   87: 
   88: \paragraph{cgi parameters -- standard queries}
   89: 
   90: \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 }
   91: \newline
   92: \newline
   93: get a listing of corpora
   94: 
   95: 
   96: \htmladdnormallink{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi?step=xmlcorpusmanifest }{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi?step=xmlcorpusmanifest }
   97: \newline
   98: \newline
   99: get an xml listing of corpora 
  100: 
  101: 
  102: \htmladdnormallink{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi }{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi }
  103: \newline
  104: \newline
  105: get a listing of works in default corpus
  106: 
  107: \htmladdnormallink{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi?corpus=1 }{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi?corpus=1 }
  108: \newline
  109: \newline
  110: get a listing of works in corpus 1 [default corpus = 0]
  111: 
  112: \htmladdnormallink{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi?step=xmlcorpuslist }{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi?step=xmlcorpuslist }
  113: \newline
  114: \newline
  115: get an xml listing of works in default corpus 
  116: 
  117: \htmladdnormallink{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi?step=xmlcorpuslist;corpus=1 }{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi?step=xmlcorpuslist;corpus=1 }
  118: \newline
  119: \newline
  120: get an xml listing of works in corpus 1
  121: 
  122: \htmladdnormallink{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi?dir=baifl_renav_006_la_1537;step=thumb }{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi?dir=baifl_renav_006_la_1537;step=thumb }
  123: \newline
  124: \newline
  125: get a work from default corpus with thumbnail navbar displayed left
  126: 
  127: 
  128: \htmladdnormallink{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi?dir=jorda_ponde_050_la_1533;step=thumb;ftype=thumbright }{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi?dir=jorda_ponde_050_la_1533;step=thumb;ftype=thumbright }
  129: \newline
  130: \newline
  131: get a work from default corpus with thumbnail navbar displayed right
  132: 
  133: \htmladdnormallink{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi?dir=jorda_ponde_050_la_1533;step=textonly;corpus=;page=22 }{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi?dir=jorda_ponde_050_la_1533;step=textonly;corpus=;page=22 }
  134: \newline
  135: \newline
  136: get a page of text from a work from default corpus 
  137: 
  138: 
  139: 
  140: 
  141: \subsubsection{Indexing}
  142: \label{sec:indexing}
  143: 
  144: 
  145: \subsubsection{Morphology}
  146: \label{sec:morphology}
  147: 
  148: 
  149: \subsubsection{Dictionary server}
  150: \label{sec:dictionary-server}
  151: 
  152: 
  153: \subsubsection{helper programs}
  154: 
  155: \paragraph{addarch.pl ARCHIMEDES} 
  156: 
  157: Automatically registers new texts as toc.cgi objects when they appear in
  158: cvs. Automatically updates relevant morphological indices (slow!) each
  159: time a cvs update occurs. This program is called by a hook in the cvs
  160: ``loginfo'' configuration file. 
  161: 
  162: 
  163: \paragraph{makelemma.pl ARCHIMEDES}
  164: 
  165: Updates lemmatization indices. 
  166: Parameters: 
  167: No parameter--update all lemmatization indices
  168: [latin | ital | greek | en | nl | de]--  update this language
  169: 
  170: \paragraph{makefast.pl ARCHIMEDES} 
  171: 
  172: Updates the toc.cgi morphology indices
  173: Parameters
  174: No parameter--update all lemmatization indices
  175: [latin | ital | greek | en | nl | de]--  update this language
  176: 
  177: %%% Local Variables: 
  178: %%% mode: latex
  179: %%% TeX-master: "texttools"
  180: %%% End: 
  181: