Return to soft-cgi.tex CVS log

Up to [Repository] / texttool-architecture

Annotation of texttool-architecture/soft-cgi.tex, revision 1.11

1.1       casties     1: \subsubsection{rec.cgi (register text)}
                      2: \label{sec:rec.cgi}
                      3: 
1.4       bcfuchs     4: \paragraph
1.7       bcfuchs     5: On the ECHO server, the registration of new texts is implemented by
1.5       bcfuchs     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. 
1.4       bcfuchs    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. 
1.5       bcfuchs    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>
1.4       bcfuchs    43: 
1.7       bcfuchs    44: \paragraph{archimedes object registration}
1.1       casties    45: 
                     46: \subsubsection{toc.cgi (display text)}
                     47: \label{sec:toc.cgi}
                     48: 
1.2       bcfuchs    49: \paragraph{plan of this section }
                     50: 
                     51: \begin{enumeration}
1.9       bcfuchs    52: \item An overview of toc.cgi architecture
1.2       bcfuchs    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: 
1.9       bcfuchs    57: \paragraph{Overview of toc.cgi architecture}
                     58: 
                     59: \subparagraph{}
1.6       bcfuchs    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
1.9       bcfuchs    64: turn based mainly on generic open-source tools for xml manipulation and networking
1.6       bcfuchs    65: written in C. 
1.9       bcfuchs    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: 
1.6       bcfuchs    87: 
1.2       bcfuchs    88: \paragraph{cgi parameters -- standard queries}
                     89: 
1.3       bcfuchs    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
1.2       bcfuchs    93: get a listing of corpora
                     94: 
                     95: 
1.3       bcfuchs    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
1.2       bcfuchs    99: get an xml listing of corpora 
                    100: 
                    101: 
1.3       bcfuchs   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
1.2       bcfuchs   105: get a listing of works in default corpus
                    106: 
1.3       bcfuchs   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
1.2       bcfuchs   110: get a listing of works in corpus 1 [default corpus = 0]
                    111: 
1.3       bcfuchs   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
1.2       bcfuchs   115: get an xml listing of works in default corpus 
                    116: 
1.3       bcfuchs   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
1.2       bcfuchs   120: get an xml listing of works in corpus 1
                    121: 
1.3       bcfuchs   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
1.2       bcfuchs   125: get a work from default corpus with thumbnail navbar displayed left
                    126: 
                    127: 
1.3       bcfuchs   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
1.2       bcfuchs   131: get a work from default corpus with thumbnail navbar displayed right
                    132: 
1.3       bcfuchs   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
1.2       bcfuchs   136: get a page of text from a work from default corpus 
                    137: 
                    138: 
                    139: 
1.1       casties   140: 
                    141: \subsubsection{Indexing}
                    142: \label{sec:indexing}
                    143: 
1.10      bcfuchs   144: \paragraph{Status quo ECHO}
                    145: Currently indexing is not implemented on the ECHO server.
                    146: 
                    147: \paragraph{Plan ECHO}
                    148: 
                    149: \begin{enumeration}
                    150: \item construct remote (141.14.236.86) index for each file at
                    151:   per-change or daily intervals
1.11    ! bcfuchs   152: \item store indices locally in
        !           153: archimedes/data/db/PROJECT_NAME/CORPUS_NAME/WORK
        !           154: \item single script provides backend access to indices 
1.10      bcfuchs   155: \end{enumeration}
1.1       casties   156: 
                    157: \subsubsection{Morphology}
                    158: \label{sec:morphology}
                    159: 
                    160: 
                    161: \subsubsection{Dictionary server}
                    162: \label{sec:dictionary-server}
                    163: 
1.7       bcfuchs   164: 
                    165: \subsubsection{helper programs}
                    166: 
                    167: \paragraph{addarch.pl ARCHIMEDES} 
                    168: 
                    169: Automatically registers new texts as toc.cgi objects when they appear in
1.8       bcfuchs   170: cvs. Automatically updates relevant morphological indices (slow!) each
                    171: time a cvs update occurs. This program is called by a hook in the cvs
                    172: ``loginfo'' configuration file. 
1.7       bcfuchs   173: 
                    174: 
1.8       bcfuchs   175: \paragraph{makelemma.pl ARCHIMEDES}
1.7       bcfuchs   176: 
                    177: Updates lemmatization indices. 
                    178: Parameters: 
                    179: No parameter--update all lemmatization indices
                    180: [latin | ital | greek | en | nl | de]--  update this language
                    181: 
1.8       bcfuchs   182: \paragraph{makefast.pl ARCHIMEDES} 
1.7       bcfuchs   183: 
                    184: Updates the toc.cgi morphology indices
                    185: Parameters
                    186: No parameter--update all lemmatization indices
                    187: [latin | ital | greek | en | nl | de]--  update this language
1.1       casties   188: 
                    189: %%% Local Variables: 
                    190: %%% mode: latex
                    191: %%% TeX-master: "texttools"
                    192: %%% End: