refeshed API Docs

zms-publishing · Jul 26, 2023 · 49b9985 · 49b9985
1 parent f1cc577
commit 49b9985
Show file tree

Hide file tree

Showing 185 changed files with 9,623 additions and 2,526 deletions.
diff --git a/Products/zms/apidocs/all-documents.html b/Products/zms/apidocs/all-documents.html
diff --git a/Products/zms/apidocs/classIndex.html b/Products/zms/apidocs/classIndex.html
diff --git a/Products/zms/apidocs/fullsearchindex.json b/Products/zms/apidocs/fullsearchindex.json
diff --git a/Products/zms/apidocs/index.html b/Products/zms/apidocs/index.html
@@ -287,6 +287,16 @@ <h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
 
 
 
+            <div class="itemName"><code><a href="zms.rest_api.html" class="internal-link" title="zms.rest_api">rest<wbr></wbr>_api</a></code>
+            </div>
+
+
+    </li><li class="">
+
+
+
+
+
             <div class="itemName"><code><a href="zms.standard.html" class="internal-link" title="zms.standard">standard</a></code>
             </div>
 
@@ -617,6 +627,16 @@ <h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
 
 
 
+            <div class="itemName"><code><a href="zms.ZMSZCatalogOpensearchConnector.html" class="internal-link" title="zms.ZMSZCatalogOpensearchConnector"><wbr></wbr>ZMSZCatalog<wbr></wbr>Opensearch<wbr></wbr>Connector</a></code>
+            </div>
+
+
+    </li><li class="">
+
+
+
+
+
             <div class="itemName"><code><a href="zms.ZMSZCatalogSolrConnector.html" class="internal-link" title="zms.ZMSZCatalogSolrConnector"><wbr></wbr>ZMSZCatalog<wbr></wbr>Solr<wbr></wbr>Connector</a></code>
             </div>
 
@@ -1134,6 +1154,11 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">zms</
     <td><span class="undocumented">No module docstring; 0/1 variable, 5/7 functions documented</span></td>
   </tr><tr class="module">
 
+    <td>Module</td>
+    <td><code><a href="zms.rest_api.html" class="internal-link" title="zms.rest_api">rest<wbr></wbr>_api</a></code></td>
+    <td><span class="undocumented">No module docstring; 0/5 function, 1/2 class documented</span></td>
+  </tr><tr class="module">
+
     <td>Module</td>
     <td><code><a href="zms.standard.html" class="internal-link" title="zms.standard">standard</a></code></td>
     <td>ZMS standard utility module</td>
@@ -1299,6 +1324,11 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">zms</
     <td><span class="undocumented">Undocumented</span></td>
   </tr><tr class="module">
 
+    <td>Module</td>
+    <td><code><a href="zms.ZMSZCatalogOpensearchConnector.html" class="internal-link" title="zms.ZMSZCatalogOpensearchConnector"><wbr></wbr>ZMSZCatalog<wbr></wbr>Opensearch<wbr></wbr>Connector</a></code></td>
+    <td><span class="undocumented">Undocumented</span></td>
+  </tr><tr class="module">
+
     <td>Module</td>
     <td><code><a href="zms.ZMSZCatalogSolrConnector.html" class="internal-link" title="zms.ZMSZCatalogSolrConnector"><wbr></wbr>ZMSZCatalog<wbr></wbr>Solr<wbr></wbr>Connector</a></code></td>
     <td><span class="undocumented">Undocumented</span></td>
@@ -1516,7 +1546,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">zms</
   <div class="functionHeader">
 
     <span class="py-defname">__doc__</span>: <code>str</code> =
-    <a class="sourceLink" href="https://github.com/zms-publishing/ZMS/tree/main/Products/zms/__init__.py#L56">
+    <a class="sourceLink" href="https://github.com/zms-publishing/ZMS/tree/main/Products/zms/__init__.py#L47">
 
       (source)
     </a>
@@ -1539,7 +1569,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">zms</
   <div class="functionHeader">
 
     <span class="py-defname">__version__</span>: <code>str</code> =
-    <a class="sourceLink" href="https://github.com/zms-publishing/ZMS/tree/main/Products/zms/__init__.py#L58">
+    <a class="sourceLink" href="https://github.com/zms-publishing/ZMS/tree/main/Products/zms/__init__.py#L49">
 
       (source)
     </a>
@@ -1562,7 +1592,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">zms</
   <div class="functionHeader">
 
     <span class="py-keyword">def</span> <span class="py-defname">initialize</span>(context):
-    <a class="sourceLink" href="https://github.com/zms-publishing/ZMS/tree/main/Products/zms/__init__.py#L85">
+    <a class="sourceLink" href="https://github.com/zms-publishing/ZMS/tree/main/Products/zms/__init__.py#L76">
 
       (source)
     </a>
@@ -1585,7 +1615,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">zms</
   <div class="functionHeader">
 
     <span class="py-keyword">def</span> <span class="py-defname">getData</span>(cell):
-    <a class="sourceLink" href="https://github.com/zms-publishing/ZMS/tree/main/Products/zms/__init__.py#L277">
+    <a class="sourceLink" href="https://github.com/zms-publishing/ZMS/tree/main/Products/zms/__init__.py#L268">
 
       (source)
     </a>
@@ -1607,7 +1637,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">zms</
   <div class="functionHeader">
 
     <span class="py-keyword">def</span> <span class="py-defname">getText</span>(nodelist):
-    <a class="sourceLink" href="https://github.com/zms-publishing/ZMS/tree/main/Products/zms/__init__.py#L285">
+    <a class="sourceLink" href="https://github.com/zms-publishing/ZMS/tree/main/Products/zms/__init__.py#L276">
 
       (source)
     </a>
@@ -1629,7 +1659,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">zms</
   <div class="functionHeader">
 
     <span class="py-keyword">def</span> <span class="py-defname">translate_path</span>(s):
-    <a class="sourceLink" href="https://github.com/zms-publishing/ZMS/tree/main/Products/zms/__init__.py#L292">
+    <a class="sourceLink" href="https://github.com/zms-publishing/ZMS/tree/main/Products/zms/__init__.py#L283">
 
       (source)
     </a>
@@ -1655,14 +1685,14 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">zms</
     <!-- t:slot name="pydoctor_version" /&gt; at <t:slot name="buildtime" / -->.
   </div>
 
-  <!-- Search related scripts needs to be loaded at the end of HTML 
+  <!-- Search related scripts needs to be loaded at the end of HTML
     parsing not to introduce overhead and display HTML data asap -->
   <script src="ajax.js" type="text/javascript"></script>
   <script src="searchlib.js" type="text/javascript"></script>
   <script src="search.js" type="text/javascript"></script>
 
 <script>
-//<!-- OPEN SOURCE LINKS IN FRAMESET 
+//<!-- OPEN SOURCE LINKS IN FRAMESET
   document.addEventListener('DOMContentLoaded', function(){
   var links = document.getElementsByClassName('sourceLink');
     var len = links.length;

diff --git a/Products/zms/apidocs/moduleIndex.html b/Products/zms/apidocs/moduleIndex.html
diff --git a/Products/zms/apidocs/nameIndex.html b/Products/zms/apidocs/nameIndex.html
diff --git a/Products/zms/apidocs/objects.inv b/Products/zms/apidocs/objects.inv
diff --git a/Products/zms/apidocs/searchindex.json b/Products/zms/apidocs/searchindex.json
diff --git a/Products/zms/apidocs/undoccedSummary.html b/Products/zms/apidocs/undoccedSummary.html
diff --git a/Products/zms/apidocs/zms.IZMSActionListContributor.IZMSActionListContributor.html b/Products/zms/apidocs/zms.IZMSActionListContributor.IZMSActionListContributor.html
@@ -314,14 +314,14 @@ <h1 class="interface"><code><code><a href="index.html" class="internal-link">zms
     <!-- t:slot name="pydoctor_version" /&gt; at <t:slot name="buildtime" / -->.
   </div>
 
-  <!-- Search related scripts needs to be loaded at the end of HTML 
+  <!-- Search related scripts needs to be loaded at the end of HTML
     parsing not to introduce overhead and display HTML data asap -->
   <script src="ajax.js" type="text/javascript"></script>
   <script src="searchlib.js" type="text/javascript"></script>
   <script src="search.js" type="text/javascript"></script>
 
 <script>
-//<!-- OPEN SOURCE LINKS IN FRAMESET 
+//<!-- OPEN SOURCE LINKS IN FRAMESET
   document.addEventListener('DOMContentLoaded', function(){
   var links = document.getElementsByClassName('sourceLink');
     var len = links.length;

diff --git a/Products/zms/apidocs/zms.IZMSActionListContributor.html b/Products/zms/apidocs/zms.IZMSActionListContributor.html
@@ -329,6 +329,16 @@ <h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
 
 
 
+            <div class="itemName"><code><a href="zms.rest_api.html" class="internal-link" title="zms.rest_api">rest<wbr></wbr>_api</a></code>
+            </div>
+
+
+    </li><li class="">
+
+
+
+
+
             <div class="itemName"><code><a href="zms.standard.html" class="internal-link" title="zms.standard">standard</a></code>
             </div>
 
@@ -659,6 +669,16 @@ <h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
 
 
 
+            <div class="itemName"><code><a href="zms.ZMSZCatalogOpensearchConnector.html" class="internal-link" title="zms.ZMSZCatalogOpensearchConnector"><wbr></wbr>ZMSZCatalog<wbr></wbr>Opensearch<wbr></wbr>Connector</a></code>
+            </div>
+
+
+    </li><li class="">
+
+
+
+
+
             <div class="itemName"><code><a href="zms.ZMSZCatalogSolrConnector.html" class="internal-link" title="zms.ZMSZCatalogSolrConnector"><wbr></wbr>ZMSZCatalog<wbr></wbr>Solr<wbr></wbr>Connector</a></code>
             </div>
 
@@ -1137,14 +1157,14 @@ <h1 class="module"><code><code><a href="index.html" class="internal-link">zms</a
     <!-- t:slot name="pydoctor_version" /&gt; at <t:slot name="buildtime" / -->.
   </div>
 
-  <!-- Search related scripts needs to be loaded at the end of HTML 
+  <!-- Search related scripts needs to be loaded at the end of HTML
     parsing not to introduce overhead and display HTML data asap -->
   <script src="ajax.js" type="text/javascript"></script>
   <script src="searchlib.js" type="text/javascript"></script>
   <script src="search.js" type="text/javascript"></script>
 
 <script>
-//<!-- OPEN SOURCE LINKS IN FRAMESET 
+//<!-- OPEN SOURCE LINKS IN FRAMESET
   document.addEventListener('DOMContentLoaded', function(){
   var links = document.getElementsByClassName('sourceLink');
     var len = links.length;

diff --git a/Products/zms/apidocs/zms.IZMSCatalogAdapter.IZMSCatalogAdapter.html b/Products/zms/apidocs/zms.IZMSCatalogAdapter.IZMSCatalogAdapter.html
@@ -297,7 +297,7 @@ <h1 class="interface"><code><code><a href="index.html" class="internal-link">zms
 
 
     <div><p>Search catalog.</p>
-<table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Returns</td></tr><tr><td class="fieldArgContainer"><tt class="rst-docutils literal">list</tt></td><td class="fieldArgDesc"><span class="undocumented">Undocumented</span></td></tr></table></div>
+<table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Parameters</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">qs:</span><tt class="rst-docutils literal">str</tt></td><td class="fieldArgDesc">the query-string</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">order:</span><tt class="rst-docutils literal">str</tt></td><td class="fieldArgDesc">the sort-order</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">clients:</span><tt class="rst-docutils literal">boolean=False</tt></td><td class="fieldArgDesc">flag to process clients recursicely</td></tr><tr class="fieldStart"><td class="fieldName" colspan="2">Returns</td></tr><tr><td class="fieldArgContainer"><tt class="rst-docutils literal">list</tt></td><td class="fieldArgDesc">the list of search-results</td></tr></table></div>
   </div>
 </div>
         </div>
@@ -314,14 +314,14 @@ <h1 class="interface"><code><code><a href="index.html" class="internal-link">zms
     <!-- t:slot name="pydoctor_version" /&gt; at <t:slot name="buildtime" / -->.
   </div>
 
-  <!-- Search related scripts needs to be loaded at the end of HTML 
+  <!-- Search related scripts needs to be loaded at the end of HTML
     parsing not to introduce overhead and display HTML data asap -->
   <script src="ajax.js" type="text/javascript"></script>
   <script src="searchlib.js" type="text/javascript"></script>
   <script src="search.js" type="text/javascript"></script>
 
 <script>
-//<!-- OPEN SOURCE LINKS IN FRAMESET 
+//<!-- OPEN SOURCE LINKS IN FRAMESET
   document.addEventListener('DOMContentLoaded', function(){
   var links = document.getElementsByClassName('sourceLink');
     var len = links.length;

diff --git a/Products/zms/apidocs/zms.IZMSCatalogAdapter.html b/Products/zms/apidocs/zms.IZMSCatalogAdapter.html
@@ -329,6 +329,16 @@ <h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
 
 
 
+            <div class="itemName"><code><a href="zms.rest_api.html" class="internal-link" title="zms.rest_api">rest<wbr></wbr>_api</a></code>
+            </div>
+
+
+    </li><li class="">
+
+
+
+
+
             <div class="itemName"><code><a href="zms.standard.html" class="internal-link" title="zms.standard">standard</a></code>
             </div>
 
@@ -659,6 +669,16 @@ <h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
 
 
 
+            <div class="itemName"><code><a href="zms.ZMSZCatalogOpensearchConnector.html" class="internal-link" title="zms.ZMSZCatalogOpensearchConnector"><wbr></wbr>ZMSZCatalog<wbr></wbr>Opensearch<wbr></wbr>Connector</a></code>
+            </div>
+
+
+    </li><li class="">
+
+
+
+
+
             <div class="itemName"><code><a href="zms.ZMSZCatalogSolrConnector.html" class="internal-link" title="zms.ZMSZCatalogSolrConnector"><wbr></wbr>ZMSZCatalog<wbr></wbr>Solr<wbr></wbr>Connector</a></code>
             </div>
 
@@ -1137,14 +1157,14 @@ <h1 class="module"><code><code><a href="index.html" class="internal-link">zms</a
     <!-- t:slot name="pydoctor_version" /&gt; at <t:slot name="buildtime" / -->.
   </div>
 
-  <!-- Search related scripts needs to be loaded at the end of HTML 
+  <!-- Search related scripts needs to be loaded at the end of HTML
     parsing not to introduce overhead and display HTML data asap -->
   <script src="ajax.js" type="text/javascript"></script>
   <script src="searchlib.js" type="text/javascript"></script>
   <script src="search.js" type="text/javascript"></script>
 
 <script>
-//<!-- OPEN SOURCE LINKS IN FRAMESET 
+//<!-- OPEN SOURCE LINKS IN FRAMESET
   document.addEventListener('DOMContentLoaded', function(){
   var links = document.getElementsByClassName('sourceLink');
     var len = links.length;

diff --git a/Products/zms/apidocs/zms.IZMSCatalogConnector.IZMSCatalogConnector.html b/Products/zms/apidocs/zms.IZMSCatalogConnector.IZMSCatalogConnector.html
@@ -390,14 +390,14 @@ <h1 class="interface"><code><code><a href="index.html" class="internal-link">zms
     <!-- t:slot name="pydoctor_version" /&gt; at <t:slot name="buildtime" / -->.
   </div>
 
-  <!-- Search related scripts needs to be loaded at the end of HTML 
+  <!-- Search related scripts needs to be loaded at the end of HTML
     parsing not to introduce overhead and display HTML data asap -->
   <script src="ajax.js" type="text/javascript"></script>
   <script src="searchlib.js" type="text/javascript"></script>
   <script src="search.js" type="text/javascript"></script>
 
 <script>
-//<!-- OPEN SOURCE LINKS IN FRAMESET 
+//<!-- OPEN SOURCE LINKS IN FRAMESET
   document.addEventListener('DOMContentLoaded', function(){
   var links = document.getElementsByClassName('sourceLink');
     var len = links.length;

diff --git a/Products/zms/apidocs/zms.IZMSCatalogConnector.html b/Products/zms/apidocs/zms.IZMSCatalogConnector.html
@@ -329,6 +329,16 @@ <h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
 
 
 
+            <div class="itemName"><code><a href="zms.rest_api.html" class="internal-link" title="zms.rest_api">rest<wbr></wbr>_api</a></code>
+            </div>
+
+
+    </li><li class="">
+
+
+
+
+
             <div class="itemName"><code><a href="zms.standard.html" class="internal-link" title="zms.standard">standard</a></code>
             </div>
 
@@ -659,6 +669,16 @@ <h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
 
 
 
+            <div class="itemName"><code><a href="zms.ZMSZCatalogOpensearchConnector.html" class="internal-link" title="zms.ZMSZCatalogOpensearchConnector"><wbr></wbr>ZMSZCatalog<wbr></wbr>Opensearch<wbr></wbr>Connector</a></code>
+            </div>
+
+
+    </li><li class="">
+
+
+
+
+
             <div class="itemName"><code><a href="zms.ZMSZCatalogSolrConnector.html" class="internal-link" title="zms.ZMSZCatalogSolrConnector"><wbr></wbr>ZMSZCatalog<wbr></wbr>Solr<wbr></wbr>Connector</a></code>
             </div>
 
@@ -1137,14 +1157,14 @@ <h1 class="module"><code><code><a href="index.html" class="internal-link">zms</a
     <!-- t:slot name="pydoctor_version" /&gt; at <t:slot name="buildtime" / -->.
   </div>
 
-  <!-- Search related scripts needs to be loaded at the end of HTML 
+  <!-- Search related scripts needs to be loaded at the end of HTML
     parsing not to introduce overhead and display HTML data asap -->
   <script src="ajax.js" type="text/javascript"></script>
   <script src="searchlib.js" type="text/javascript"></script>
   <script src="search.js" type="text/javascript"></script>
 
 <script>
-//<!-- OPEN SOURCE LINKS IN FRAMESET 
+//<!-- OPEN SOURCE LINKS IN FRAMESET
   document.addEventListener('DOMContentLoaded', function(){
   var links = document.getElementsByClassName('sourceLink');
     var len = links.length;

diff --git a/Products/zms/apidocs/zms.IZMSConfigurationProvider.IZMSConfigurationProvider.html b/Products/zms/apidocs/zms.IZMSConfigurationProvider.IZMSConfigurationProvider.html
@@ -390,14 +390,14 @@ <h1 class="interface"><code><code><a href="index.html" class="internal-link">zms
     <!-- t:slot name="pydoctor_version" /&gt; at <t:slot name="buildtime" / -->.
   </div>
 
-  <!-- Search related scripts needs to be loaded at the end of HTML 
+  <!-- Search related scripts needs to be loaded at the end of HTML
     parsing not to introduce overhead and display HTML data asap -->
   <script src="ajax.js" type="text/javascript"></script>
   <script src="searchlib.js" type="text/javascript"></script>
   <script src="search.js" type="text/javascript"></script>
 
 <script>
-//<!-- OPEN SOURCE LINKS IN FRAMESET 
+//<!-- OPEN SOURCE LINKS IN FRAMESET
   document.addEventListener('DOMContentLoaded', function(){
   var links = document.getElementsByClassName('sourceLink');
     var len = links.length;