Update docs.

cceh · Mar 19, 2024 · 6b1936a · 6b1936a
1 parent 50e4312
commit 6b1936a
Show file tree

Hide file tree

Showing 43 changed files with 591 additions and 299 deletions.
diff --git a/doc_src/maintenance/wordpress.rst b/doc_src/maintenance/wordpress.rst
@@ -57,3 +57,44 @@ activate the new version of the plugin.
 .. seealso::
 
    https://github.com/cceh/capitularia/issues/62
+
+
+wordfence
+~~~~~~~~~
+
+The plugin Wordfence needs write access to the location
+:file:`/var/www/capitularia.uni-koeln.de/wp-content/wflogs`. The `wp` commandline update
+tool also needs access to that location during plugin update.  So both users `www-data`
+and `capitularia` have write access to that location.
+
+.. code:: shell
+
+   getfacl wflogs
+   # file: wflogs
+   # owner: capitularia
+   # group: capitularia
+   user::rwx
+   user:www-data:rwx
+   user:capitularia:rwx
+   group::r-x
+   mask::rwx
+   other::r-x
+   default:user::rwx
+   default:user:www-data:rwx
+   default:user:capitularia:rwx
+   default:group::r-x
+   default:mask::rwx
+   default:other::r-x
+
+
+Restore Database
+~~~~~~~~~~~~~~~~
+
+Restore the Wordpress database from the backup.
+
+.. code:: bash
+
+    mysql < /var/backups/mysqldump.backup
+
+Note: The database contains all Wordpress settings.  After restoring the production
+database on a developer machine, the Wordpress settings must be adjusted.
diff --git a/docs/_sources/maintenance/wordpress.rst.txt b/docs/_sources/maintenance/wordpress.rst.txt
@@ -57,3 +57,44 @@ activate the new version of the plugin.
 .. seealso::
 
    https://github.com/cceh/capitularia/issues/62
+
+
+wordfence
+~~~~~~~~~
+
+The plugin Wordfence needs write access to the location
+:file:`/var/www/capitularia.uni-koeln.de/wp-content/wflogs`. The `wp` commandline update
+tool also needs access to that location during plugin update.  So both users `www-data`
+and `capitularia` have write access to that location.
+
+.. code:: shell
+
+   getfacl wflogs
+   # file: wflogs
+   # owner: capitularia
+   # group: capitularia
+   user::rwx
+   user:www-data:rwx
+   user:capitularia:rwx
+   group::r-x
+   mask::rwx
+   other::r-x
+   default:user::rwx
+   default:user:www-data:rwx
+   default:user:capitularia:rwx
+   default:group::r-x
+   default:mask::rwx
+   default:other::r-x
+
+
+Restore Database
+~~~~~~~~~~~~~~~~
+
+Restore the Wordpress database from the backup.
+
+.. code:: bash
+
+    mysql < /var/backups/mysqldump.backup
+
+Note: The database contains all Wordpress settings.  After restoring the production
+database on a developer machine, the Wordpress settings must be adjusted.
diff --git a/docs/_sources/vm/user.rst.txt b/docs/_sources/vm/user.rst.txt
@@ -99,7 +99,7 @@ To add a new user to the VM (needs root):
 
 .. code:: bash
 
-   sudo ~capitularia/add_capitularia_user.sh <username>
+   sudo ~root/add_capitularia_user.sh <username>
 
 Each user should also have a semi-personal subdirectory in: :file:`cap/intern/InArbeit/`.
 They can create that themselves.
@@ -110,4 +110,4 @@ Security
 
 The users are authenticated by the RRZK Kerberos system through PAM and the pam_krb5
 module.  For particulars see the voice: "Zugang zu Gast-VM (debian) mit UniKim-Account"
-in the internal CCeH wiki.
+in the internal CCeH wiki.
diff --git a/docs/_static/pygments.css b/docs/_static/pygments.css
@@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
 .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
 .highlight .gd { color: #A00000 } /* Generic.Deleted */
 .highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
 .highlight .gr { color: #FF0000 } /* Generic.Error */
 .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
 .highlight .gi { color: #00A000 } /* Generic.Inserted */

diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle
diff --git a/docs/doctrees/maintenance/wordpress.doctree b/docs/doctrees/maintenance/wordpress.doctree
diff --git a/docs/doctrees/vm/apache/wordpress/theme/main.doctree b/docs/doctrees/vm/apache/wordpress/theme/main.doctree
diff --git a/docs/doctrees/vm/user.doctree b/docs/doctrees/vm/user.doctree
diff --git a/docs/genindex.html b/docs/genindex.html
@@ -318,12 +318,14 @@ <h2 id="C">C</h2>
 </li>
       <li><a href="vm/app_server.html#geo_server.capitularies_json">capitularies_json() (in module geo_server)</a>
 </li>
-      <li><a href="vm/apache/wordpress/theme/widgets.html#\cceh\capitularia\theme\Categories_Nav_Menu_Widget"><strong>Categories_Nav_Menu_Widget (class in \cceh\capitularia\theme)</strong></a>
+      <li><a href="vm/apache/wordpress/theme/main.html#\cceh\capitularia\theme\CapQuery"><strong>CapQuery (class in \cceh\capitularia\theme)</strong></a>
 </li>
-      <li><a href="vm/database.html#db.Chapters.chapter">chapter (Chapters attribute)</a>
+      <li><a href="vm/apache/wordpress/theme/widgets.html#\cceh\capitularia\theme\Categories_Nav_Menu_Widget"><strong>Categories_Nav_Menu_Widget (class in \cceh\capitularia\theme)</strong></a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="vm/database.html#db.Chapters.chapter">chapter (Chapters attribute)</a>
+</li>
       <li><a href="vm/database.html#db.Chapters">Chapters (class in db)</a>
 </li>
       <li><a href="vm/app_server.html#data_server.chapters">chapters() (in module data_server)</a>
@@ -827,6 +829,8 @@ <h2 id="M">M</h2>
         <li><a href="vm/app_server.html#module-server">server</a>
 </li>
         <li><a href="vm/apache/wordpress/theme/main.html#module-themes.Capitularia.404">themes.Capitularia.404</a>
+</li>
+        <li><a href="vm/apache/wordpress/theme/main.html#module-themes.Capitularia.class-cap-query">themes.Capitularia.class-cap-query</a>
 </li>
         <li><a href="vm/apache/wordpress/theme/main.html#module-themes.Capitularia.footer">themes.Capitularia.footer</a>
 </li>
@@ -1138,6 +1142,8 @@ <h2 id="O">O</h2>
       <li><a href="vm/apache/wordpress/theme/widgets.html#\cceh\capitularia\theme\Sticky_Nav_Menu_Widget::on_widget_nav_menu_args"><strong>on_widget_nav_menu_args() (Sticky_Nav_Menu_Widget method)</strong></a>
 </li>
       <li><a href="vm/apache/wordpress/plugins/meta-search.html#\cceh\capitularia\meta_search\on_widgets_init"><strong>on_widgets_init() (function in \cceh\capitularia\meta_search)</strong></a>
+</li>
+      <li><a href="vm/apache/wordpress/theme/main.html#\cceh\capitularia\theme\on_wp_get_nav_menu_items"><strong>on_wp_get_nav_menu_items() (function in \cceh\capitularia\theme)</strong></a>
 </li>
       <li><a href="vm/apache/wordpress/theme/main.html#\cceh\capitularia\theme\on_wp_title"><strong>on_wp_title() (function in \cceh\capitularia\theme)</strong></a>
 </li>
@@ -1172,6 +1178,8 @@ <h2 id="P">P</h2>
       <li><a href="vm/apache/wordpress/plugins/collation-tool.html#plugins-collation-tools.Palette">Palette (global variable or constant)</a>
 </li>
       <li><a href="vm/apache/wordpress/plugins/collation-tool.html#plugins-collation-tools.parse_locus_url">parse_locus_url() (built-in function)</a>
+</li>
+      <li><a href="vm/apache/wordpress/theme/main.html#\cceh\capitularia\theme\CapQuery::parse_search"><strong>parse_search() (CapQuery method)</strong></a>
 </li>
       <li><a href="vm/apache/wordpress/plugins/page-generator.html#\cceh\capitularia\page_generator\Manuscript::parse_tei"><strong>parse_tei() (Manuscript method)</strong></a>
 </li>
@@ -1550,6 +1558,13 @@ <h2 id="T">T</h2>
 
       <ul>
         <li><a href="vm/apache/wordpress/theme/main.html#module-themes.Capitularia.404">module</a>
+</li>
+      </ul></li>
+      <li>
+    themes.Capitularia.class-cap-query
+
+      <ul>
+        <li><a href="vm/apache/wordpress/theme/main.html#module-themes.Capitularia.class-cap-query">module</a>
 </li>
       </ul></li>
       <li>
@@ -1608,15 +1623,15 @@ <h2 id="T">T</h2>
         <li><a href="vm/apache/wordpress/theme/main.html#module-themes.Capitularia.page_blank">module</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     themes.Capitularia.page_no-sidebar
 
       <ul>
         <li><a href="vm/apache/wordpress/theme/main.html#module-themes.Capitularia.page_no-sidebar">module</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     themes.Capitularia.phpinfo
 

diff --git a/docs/maintenance.html b/docs/maintenance.html
@@ -55,7 +55,10 @@
 </li>
 <li class="toctree-l2"><a class="reference internal" href="overviews/collation_tool.html">Overview of the Collation Tool</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="overviews/collation_tool.html#pre-processing-of-the-tei-files">Pre-Processing of the TEI files</a></li>
-<li class="toctree-l3"><a class="reference internal" href="overviews/collation_tool.html#collation">Collation</a></li>
+<li class="toctree-l3"><a class="reference internal" href="overviews/collation_tool.html#id1">Collation Tool</a></li>
+<li class="toctree-l3"><a class="reference internal" href="overviews/collation_tool.html#collation-algorithm">Collation Algorithm</a></li>
+<li class="toctree-l3"><a class="reference internal" href="overviews/collation_tool.html#word-comparison-function">Word Comparison Function</a></li>
+<li class="toctree-l3"><a class="reference internal" href="overviews/collation_tool.html#references">References</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="overviews/meta_search.html">Meta Search</a><ul>

diff --git a/docs/maintenance/logfiles.html b/docs/maintenance/logfiles.html
@@ -55,7 +55,10 @@
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../overviews/collation_tool.html">Overview of the Collation Tool</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../overviews/collation_tool.html#pre-processing-of-the-tei-files">Pre-Processing of the TEI files</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../overviews/collation_tool.html#collation">Collation</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../overviews/collation_tool.html#id1">Collation Tool</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../overviews/collation_tool.html#collation-algorithm">Collation Algorithm</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../overviews/collation_tool.html#word-comparison-function">Word Comparison Function</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../overviews/collation_tool.html#references">References</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../overviews/meta_search.html">Meta Search</a><ul>

diff --git a/docs/maintenance/wordpress.html b/docs/maintenance/wordpress.html
@@ -55,7 +55,10 @@
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../overviews/collation_tool.html">Overview of the Collation Tool</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../overviews/collation_tool.html#pre-processing-of-the-tei-files">Pre-Processing of the TEI files</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../overviews/collation_tool.html#collation">Collation</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../overviews/collation_tool.html#id1">Collation Tool</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../overviews/collation_tool.html#collation-algorithm">Collation Algorithm</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../overviews/collation_tool.html#word-comparison-function">Word Comparison Function</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../overviews/collation_tool.html#references">References</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../overviews/meta_search.html">Meta Search</a><ul>
@@ -198,6 +201,40 @@ <h3>qtranslate-xt<a class="headerlink" href="#qtranslate-xt" title="Permalink to
 <p><a class="reference external" href="https://github.com/cceh/capitularia/issues/62">https://github.com/cceh/capitularia/issues/62</a></p>
 </div>
 </section>
+<section id="wordfence">
+<h3>wordfence<a class="headerlink" href="#wordfence" title="Permalink to this heading">¶</a></h3>
+<p>The plugin Wordfence needs write access to the location
+<code class="file docutils literal notranslate"><span class="pre">/var/www/capitularia.uni-koeln.de/wp-content/wflogs</span></code>. The <cite>wp</cite> commandline update
+tool also needs access to that location during plugin update.  So both users <cite>www-data</cite>
+and <cite>capitularia</cite> have write access to that location.</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>getfacl<span class="w"> </span>wflogs
+<span class="c1"># file: wflogs</span>
+<span class="c1"># owner: capitularia</span>
+<span class="c1"># group: capitularia</span>
+user::rwx
+user:www-data:rwx
+user:capitularia:rwx
+group::r-x
+mask::rwx
+other::r-x
+default:user::rwx
+default:user:www-data:rwx
+default:user:capitularia:rwx
+default:group::r-x
+default:mask::rwx
+default:other::r-x
+</pre></div>
+</div>
+</section>
+<section id="restore-database">
+<h3>Restore Database<a class="headerlink" href="#restore-database" title="Permalink to this heading">¶</a></h3>
+<p>Restore the Wordpress database from the backup.</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>mysql<span class="w"> </span>&lt;<span class="w"> </span>/var/backups/mysqldump.backup
+</pre></div>
+</div>
+<p>Note: The database contains all Wordpress settings.  After restoring the production
+database on a developer machine, the Wordpress settings must be adjusted.</p>
+</section>
 </section>
 </section>
 

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/overviews/collation_tool.html b/docs/overviews/collation_tool.html
@@ -189,7 +189,7 @@ <h2>Pre-Processing of the TEI files<a class="headerlink" href="#pre-processing-o
 link import to db--><path d="M296,420.25 C296,435.87 296,456.65 296,474.53 " fill="none" id="import-&gt;db" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="296,479.98,300,470.98,296,474.98,292,470.98,296,479.98" style="stroke: #A80036; stroke-width: 1.0;"/><!--MD5=[16b2f23e595c1c5de587a32b661386ae]
 link cron to make--><path d="M78.09,159.5 C88.14,159.5 98.19,159.5 108.24,159.5 " fill="none" id="cron-&gt;make" style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 7.0,7.0;"/><polygon fill="#A80036" points="113.49,159.5,104.49,155.5,108.49,159.5,104.49,163.5,113.49,159.5" style="stroke: #A80036; stroke-width: 1.0;"/><!--MD5=[42211ccb8b439fe830e993a3999a0d06]
 link make to saxon--><path d="M210.68,159.5 C244.29,159.5 277.91,159.5 311.52,159.5 " fill="none" id="make-&gt;saxon" style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 7.0,7.0;"/><polygon fill="#A80036" points="316.91,159.5,307.91,155.5,311.91,159.5,307.91,163.5,316.91,159.5" style="stroke: #A80036; stroke-width: 1.0;"/><!--MD5=[e731f16ea0a8d8bacc8eebde1022f2e9]
-link make to import--><path d="M155.08,184.17 C147.38,215.4 138.74,271.06 161,311 C177.68,340.93 210.01,361.49 238.85,374.71 " fill="none" id="make-&gt;import" style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 7.0,7.0;"/><polygon fill="#A80036" points="243.44,376.77,236.8828,369.4213,238.8828,374.7128,233.5913,376.7129,243.44,376.77" style="stroke: #A80036; stroke-width: 1.0;"/><!--MD5=[96185060e94f7af180ebce24f93570ed]
+link make to import--><path d="M155.08,184.17 C147.38,215.4 138.74,271.06 161,311 C177.68,340.93 210.01,361.49 238.85,374.71 " fill="none" id="make-&gt;import" style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 7.0,7.0;"/><polygon fill="#A80036" points="243.44,376.77,236.8828,369.4213,238.8828,374.7128,233.5913,376.7129,243.44,376.77" style="stroke: #A80036; stroke-width: 1.0;"/><!--MD5=[db97ef3274b92a179c6e56e9d98bbfea]
 @startuml
 
    skinparam backgroundColor transparent
@@ -225,7 +225,7 @@ <h2>Pre-Processing of the TEI files<a class="headerlink" href="#pre-processing-o
 (GPL source distribution)
 Java Runtime: OpenJDK Runtime Environment
 JVM: OpenJDK 64-Bit Server VM
-Java Version: 19.0.2+7-Debian-4
+Java Version: 21.0.3-ea+6-Debian-1
 Operating System: Linux
 Default Encoding: UTF-8
 Language: en
@@ -260,7 +260,7 @@ <h2>Collation Tool<a class="headerlink" href="#id1" title="Permalink to this hea
 entity client--><rect fill="#FEFECE" filter="url(#f1drof8wpt1zaq)" height="68.1358" style="stroke: #A80036; stroke-width: 1.5;" width="113" x="213.5" y="317"/><rect fill="#FEFECE" height="10" style="stroke: #A80036; stroke-width: 1.5;" width="15" x="306.5" y="322"/><rect fill="#FEFECE" height="2" style="stroke: #A80036; stroke-width: 1.5;" width="4" x="304.5" y="324"/><rect fill="#FEFECE" height="2" style="stroke: #A80036; stroke-width: 1.5;" width="4" x="304.5" y="328"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="61" x="234.5" y="351.9659">Frontend</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="73" x="228.5" y="371.0339">(Javascript)</text><!--MD5=[314c9b5bc4dd2dc6e633f2ffbcf881af]
 link db to api--><path d="M270,129.15 C270,145.73 270,166 270,183.36 " fill="none" id="db-&gt;api" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="270,188.64,274,179.64,270,183.64,266,179.64,270,188.64" style="stroke: #A80036; stroke-width: 1.0;"/><!--MD5=[8bbc512d03c057d4411096abd71c9ff2]
 link api to client--><path d="M270,257.11 C270,273.76 270,294.04 270,311.39 " fill="none" id="api-&gt;client" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="270,316.68,274,307.68,270,311.68,266,307.68,270,316.68" style="stroke: #A80036; stroke-width: 1.0;"/><!--MD5=[73ae650eaf7f2095f942ab708207e218]
-link lib to api--><path d="M185.28,223 C193.54,223 201.8,223 210.05,223 " fill="none" id="lib-api" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="215.2,223,206.2,219,210.2,223,206.2,227,215.2,223" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="180.07,223,189.07,227,185.07,223,189.07,219,180.07,223" style="stroke: #A80036; stroke-width: 1.0;"/><!--MD5=[37280b39dc947eebd58cbc8dce7920ed]
+link lib to api--><path d="M185.28,223 C193.54,223 201.8,223 210.05,223 " fill="none" id="lib-api" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="215.2,223,206.2,219,210.2,223,206.2,227,215.2,223" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="180.07,223,189.07,227,185.07,223,189.07,219,180.07,223" style="stroke: #A80036; stroke-width: 1.0;"/><!--MD5=[112dd930a367d334239c6d8709e560d4]
 @startuml
 
    skinparam backgroundColor transparent
@@ -288,7 +288,7 @@ <h2>Collation Tool<a class="headerlink" href="#id1" title="Permalink to this hea
 (GPL source distribution)
 Java Runtime: OpenJDK Runtime Environment
 JVM: OpenJDK 64-Bit Server VM
-Java Version: 19.0.2+7-Debian-4
+Java Version: 21.0.3-ea+6-Debian-1
 Operating System: Linux
 Default Encoding: UTF-8
 Language: en

diff --git a/docs/overviews/collections.html b/docs/overviews/collections.html
@@ -56,7 +56,10 @@
 </li>
 <li class="toctree-l2"><a class="reference internal" href="collation_tool.html">Overview of the Collation Tool</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="collation_tool.html#pre-processing-of-the-tei-files">Pre-Processing of the TEI files</a></li>
-<li class="toctree-l3"><a class="reference internal" href="collation_tool.html#collation">Collation</a></li>
+<li class="toctree-l3"><a class="reference internal" href="collation_tool.html#id1">Collation Tool</a></li>
+<li class="toctree-l3"><a class="reference internal" href="collation_tool.html#collation-algorithm">Collation Algorithm</a></li>
+<li class="toctree-l3"><a class="reference internal" href="collation_tool.html#word-comparison-function">Word Comparison Function</a></li>
+<li class="toctree-l3"><a class="reference internal" href="collation_tool.html#references">References</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="meta_search.html">Meta Search</a><ul>