Return to soft-cgi.tex CVS log

Up to [Repository] / texttool-architecture

added more helper stuf

    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 A walk-through of typical cgi queries for toc.cgi
   53: \item An index of cgi parameters and values with short descriptions of function
   54: \end{enumeration}
   55: 
   56: \paragraph{}
   57: toc.cgi is a perl script for displaying collections of xml texts and 
   58: linking them to related resources such as page-images, morphological
   59: analysis, commentaries, dictionaries, etc. It implements generic methods
   60: for resource-linking provided by a series of perl modules which are in
   61: turn based mainly on generic tools for xml manipulation and networking
   62: written in C. 
   63: 
   64: \paragraph{cgi parameters -- standard queries}
   65: 
   66: \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 }
   67: \newline
   68: \newline
   69: get a listing of corpora
   70: 
   71: 
   72: \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 }
   73: \newline
   74: \newline
   75: get an xml listing of corpora 
   76: 
   77: 
   78: \htmladdnormallink{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi }{ http://archimedes.mpiwg-berlin.mpg.de/cgi-bin/toc/toc.cgi }
   79: \newline
   80: \newline
   81: get a listing of works in default corpus
   82: 
   83: \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 }
   84: \newline
   85: \newline
   86: get a listing of works in corpus 1 [default corpus = 0]
   87: 
   88: \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 }
   89: \newline
   90: \newline
   91: get an xml listing of works in default corpus 
   92: 
   93: \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 }
   94: \newline
   95: \newline
   96: get an xml listing of works in corpus 1
   97: 
   98: \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 }
   99: \newline
  100: \newline
  101: get a work from default corpus with thumbnail navbar displayed left
  102: 
  103: 
  104: \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 }
  105: \newline
  106: \newline
  107: get a work from default corpus with thumbnail navbar displayed right
  108: 
  109: \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 }
  110: \newline
  111: \newline
  112: get a page of text from a work from default corpus 
  113: 
  114: 
  115: 
  116: 
  117: \subsubsection{Indexing}
  118: \label{sec:indexing}
  119: 
  120: 
  121: \subsubsection{Morphology}
  122: \label{sec:morphology}
  123: 
  124: 
  125: \subsubsection{Dictionary server}
  126: \label{sec:dictionary-server}
  127: 
  128: 
  129: \subsubsection{helper programs}
  130: 
  131: \paragraph{addarch.pl ARCHIMEDES} 
  132: 
  133: Automatically registers new texts as toc.cgi objects when they appear in
  134: cvs. Automatically updates relevant morphological indices (slow!) each
  135: time a cvs update occurs. This program is called by a hook in the cvs
  136: ``loginfo'' configuration file. 
  137: 
  138: 
  139: \paragraph{makelemma.pl ARCHIMEDES}
  140: 
  141: Updates lemmatization indices. 
  142: Parameters: 
  143: No parameter--update all lemmatization indices
  144: [latin | ital | greek | en | nl | de]--  update this language
  145: 
  146: \paragraph{makefast.pl ARCHIMEDES} 
  147: 
  148: Updates the toc.cgi morphology indices
  149: Parameters
  150: No parameter--update all lemmatization indices
  151: [latin | ital | greek | en | nl | de]--  update this language
  152: 
  153: %%% Local Variables: 
  154: %%% mode: latex
  155: %%% TeX-master: "texttools"
  156: %%% End: 
  157: