Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
added URL parameter to all queries and fixed the example link
  • Loading branch information
peterstadler committed Jan 4, 2024
1 parent 437fee7 commit 4618afd
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions manual/index_tools.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ <h2>Tools for generating indexes</h2>
<p>All of the tools described below are located in the 'tools' folder of your eXist
database. In order to generate any output they need a query parameter named 'c'
added to the URL to specify which file collection to generate an index for (for
instance: http://my_server_name.org/storage/tools/title_index?c=CNW ).</p>
instance: <code>http://localhost:8080/modules/tools/title_index.xq?c=Demo</code>).</p>
<p>The lists generated are meant as a starting point for an index. Most likely you will
need to make manual corrections.</p>
<p>If you want to change the default formatting such as the use of italics, you may want
Expand All @@ -40,7 +40,7 @@ <h2>Tools for generating indexes</h2>
<p>&#160;</p>
<p><b>Title index</b></p>
<p>To generate a simple list of titles, alphabetically ordered, use the <a
href="../modules/tools/title_index.xq">title_index.xq</a> script located in the
href="../modules/tools/title_index.xq?c=Demo">title_index.xq</a> script located in the
'tools' folder of your eXist database.</p>
<p>The script generates a list in two sections: First a list of main titles with
subtitles and (in parentheses) alternative titles. Below that, it generates a list
Expand All @@ -49,7 +49,7 @@ <h2>Tools for generating indexes</h2>
<p><img alt="title index" src="../resources/images/manual/title_index.png" class="illustration" onload="this.width/=1.5;" /></p>
<p>&#160;</p>
<p><b>Index of names</b></p>
<p>The script <a href="../modules/tools/name_index.xq">name_index.xq</a> produces a list
<p>The script <a href="../modules/tools/name_index.xq?c=Demo">name_index.xq</a> produces a list
of all names encoded as &lt;persName&gt; elements within the &lt;sourceDesc&gt; and
&lt;workList&gt; elements. This restriction ensures that persons such as the encoder
or project manager (usually encoded in &lt;fileDesc&gt;) are not included.</p>
Expand All @@ -59,41 +59,41 @@ <h2>Tools for generating indexes</h2>
entire database several times. If you experience a server timeout when running
it, you may want to try a two-step approach instead. However, this solution
involves editing one of the scripts on the server. First, use the script <a
href="../modules/tools/name_index_step1.xq">name_index_step1.xq</a> to
href="../modules/tools/name_index_step1.xq?c=Demo">name_index_step1.xq</a> to
generate a list of all the persons found. This list is pasted into the source
code of the second script (the code indicates where), <a
href="../modules/tools/name_index_step2.xq">name_index_step2.xq</a>, which in
href="../modules/tools/name_index_step2.xq?c=Demo">name_index_step2.xq</a>, which in
turn searches for alle occurrences of each name on the list.</li>
</ul>
<p>&#160;</p>
<p><b>Index of text authors</b></p>
<p>The index of text authors, <a href="../modules/tools/text_author_index.xq"
<p>The index of text authors, <a href="../modules/tools/text_author_index.xq?c=Demo"
>text_author_index.xq</a>, is a just subset of the general index of names, only
including the &lt;persName&gt; elements having @role='author'. This index is
intended to list the authors of vocal text (lyrics) only; it does not include
authors of documentary material or literature such as letters, articles and books,
which MerMEId defines using the &lt;author&gt; element.</p>
<p>&#160;</p>
<p><b>Index of opus numbers</b></p> The script <a href="../modules/tools/opus_index.xq"
<p><b>Index of opus numbers</b></p> The script <a href="../modules/tools/opus_index.xq?c=Demo"
>opus_index.xq</a> lists the titles of works having an identifier named 'Opus' at
the 'Work' tab:<br />
<img alt="opus number" src="../resources/images/manual/opus_number.png" class="illustration" /><br />
<img alt="opus index" src="../resources/images/manual/opus_index.png" class="illustration" onload="this.width/=1.5;" />
<p>&#160;</p>
<p><b>Index of performance locations</b></p>
<p>A list of performance places (cities) is generated by the <a href="../modules/tools/performance_city_index.xq">performance_city_index.xq</a> script.<br />
<p>A list of performance places (cities) is generated by the <a href="../modules/tools/performance_city_index.xq?c=Demo">performance_city_index.xq</a> script.<br />
<img alt="opus index" src="../resources/images/manual/performance_place_index.png" class="illustration" onload="this.width/=1.5;" />
</p>
<p>&#160;</p>
<p><b>Index of item (source) locations</b></p>
<p>The script <a href="../modules/tools/location_index.xq">location_index.xq</a> generates
<p>The script <a href="../modules/tools/location_index.xq?c=Demo">location_index.xq</a> generates
a list of the locations of items (that is, manuscripts or specific copies of printed
sources).<br /> The script tries to resolve RISM sigla; locations not recognizable
as RISM sigla are reproduced as written.</p>
<p>&#160;</p>
<p><b>List of incipit graphics</b></p>
<p>For proofreading incipits added as graphics (images), a tool <a
href="../modules/tools/list_incipit_graphics.xq">list_incipit_graphics.xq</a> is
href="../modules/tools/list_incipit_graphics.xq?c=Demo">list_incipit_graphics.xq</a> is
available to output all graphics including the movement titles and file URLs. The
script does not (yet) include incipits to be rendered at runtime. <br/>
<img alt="incipit list" src="../resources/images/manual/list_incipit_graphics.png" class="illustration" onload="this.width/=1.5;" />
Expand Down

0 comments on commit 4618afd

Please sign in to comment.