Manual page for IIIF

acdh-oeaw · Nov 2, 2023 · febcc9a · febcc9a
1 parent 429087e
commit febcc9a
Show file tree

Hide file tree

Showing 93 changed files with 634 additions and 236 deletions.
diff --git a/openatlas/static/manual/.buildinfo b/openatlas/static/manual/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 5f4b85b5717a3c8d5c6b369217c009e9
+config: ad6915044749889aefebf49860a758ac
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/openatlas/static/manual/.doctrees/admin/arche.doctree b/openatlas/static/manual/.doctrees/admin/arche.doctree
diff --git a/openatlas/static/manual/.doctrees/admin/iiif.doctree b/openatlas/static/manual/.doctrees/admin/iiif.doctree
diff --git a/openatlas/static/manual/.doctrees/admin/index.doctree b/openatlas/static/manual/.doctrees/admin/index.doctree
diff --git a/openatlas/static/manual/.doctrees/entity/file.doctree b/openatlas/static/manual/.doctrees/entity/file.doctree
diff --git a/openatlas/static/manual/.doctrees/environment.pickle b/openatlas/static/manual/.doctrees/environment.pickle
diff --git a/openatlas/static/manual/.doctrees/technical/api.doctree b/openatlas/static/manual/.doctrees/technical/api.doctree
diff --git a/openatlas/static/manual/.doctrees/technical/api_parameters_03.doctree b/openatlas/static/manual/.doctrees/technical/api_parameters_03.doctree
diff --git a/openatlas/static/manual/.doctrees/technical/api_version_03.doctree b/openatlas/static/manual/.doctrees/technical/api_version_03.doctree
diff --git a/openatlas/static/manual/_static/documentation_options.js b/openatlas/static/manual/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '7.16.0',
+    VERSION: '7.17.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/openatlas/static/manual/admin/api.html b/openatlas/static/manual/admin/api.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>API &mdash; OpenAtlas 7.16.0 documentation</title>
+  <title>API &mdash; OpenAtlas 7.17.0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                7.16.0
+                7.17.0
               </div>
 
 
@@ -102,6 +102,7 @@
 <li class="toctree-l2"><a class="reference internal" href="mail.html">Mail</a></li>
 <li class="toctree-l2"><a class="reference internal" href="modules.html">Modules</a></li>
 <li class="toctree-l2"><a class="reference internal" href="map.html">Map</a></li>
+<li class="toctree-l2"><a class="reference internal" href="iiif.html">IIIF</a></li>
 <li class="toctree-l2"><a class="reference internal" href="content.html">Content</a></li>
 <li class="toctree-l2"><a class="reference internal" href="data_integrity_checks.html">Data integrity checks</a></li>
 <li class="toctree-l2"><a class="reference internal" href="import.html">Import</a></li>

diff --git a/openatlas/static/manual/admin/arche.html b/openatlas/static/manual/admin/arche.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>ARCHE &mdash; OpenAtlas 7.16.0 documentation</title>
+  <title>ARCHE &mdash; OpenAtlas 7.17.0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                7.16.0
+                7.17.0
               </div>
 
 
@@ -102,6 +102,7 @@
 <li class="toctree-l2"><a class="reference internal" href="mail.html">Mail</a></li>
 <li class="toctree-l2"><a class="reference internal" href="modules.html">Modules</a></li>
 <li class="toctree-l2"><a class="reference internal" href="map.html">Map</a></li>
+<li class="toctree-l2"><a class="reference internal" href="iiif.html">IIIF</a></li>
 <li class="toctree-l2"><a class="reference internal" href="content.html">Content</a></li>
 <li class="toctree-l2"><a class="reference internal" href="data_integrity_checks.html">Data integrity checks</a></li>
 <li class="toctree-l2"><a class="reference internal" href="import.html">Import</a></li>
@@ -196,16 +197,16 @@
 <h1>ARCHE<a class="headerlink" href="#arche" title="Permalink to this headline">¶</a></h1>
 <div class="toctree-wrapper compound">
 </div>
-<p><strong>Be aware</strong> this feature is experimental and only usable for a specific dataset.</p>
-<p><a class="reference external" href="https://arche.acdh.oeaw.ac.at/">ARCHE</a> (A Resource Centre for the HumanitiEs) is a service aimed at offering stable and persistent hosting as well as dissemination of digital research data and resources.</p>
-<p>In order to import data from ARCHE to OpenAtlas changes to instance/production.py are needed (ask your OpenAtlas administrator for further details):</p>
+<p><strong>Be aware</strong> this feature is only usable for a specific dataset.</p>
+<p><a class="reference external" href="https://arche.acdh.oeaw.ac.at/">ARCHE</a> (A Resource Centre for the HumanitiEs) is a service aimed at offering stable
+and persistent hosting as well as dissemination of digital research data and resources.</p>
+<p>In order to import data from ARCHE to OpenAtlas changes to instance/production.py are needed (ask your OpenAtlas
+administrator for further details):</p>
 <div class="literal-block-wrapper docutils container" id="id2">
 <div class="code-block-caption"><span class="caption-text">instance/production.py</span><a class="headerlink" href="#id2" title="Permalink to this code">¶</a></div>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ARCHE</span> <span class="o">=</span> <span class="p">{</span>
- <span class="s1">&#39;id&#39;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>    <span class="c1"># Top collection ID (acdh:TopCollection)</span>
- <span class="s1">&#39;collection_ids&#39;</span><span class="p">:</span> <span class="p">[</span><span class="mi">0</span><span class="p">],</span>  <span class="c1"># Sub collections ID containing metadata.json files (acdh:Collection)</span>
- <span class="s1">&#39;base_url&#39;</span><span class="p">:</span> <span class="s1">&#39;https://arche-curation.acdh-dev.oeaw.ac.at/&#39;</span><span class="p">,</span>  <span class="c1"># Base URL to get data from</span>
- <span class="s1">&#39;thumbnail_url&#39;</span><span class="p">:</span> <span class="s1">&#39;https://arche-thumbnails.acdh.oeaw.ac.at/&#39;</span>    <span class="c1"># URL of ARCHE thumbnail service</span>
+ <span class="s1">&#39;id&#39;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>    <span class="c1"># Top collection of the project (acdh:TopCollection)</span>
+ <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="s1">&#39;https://arche-curation.acdh-dev.oeaw.ac.at/&#39;</span><span class="p">,</span>  <span class="c1"># Base URL to get data from</span>
  <span class="p">}}</span>
 </pre></div>
 </div>
@@ -214,7 +215,8 @@ <h1>ARCHE<a class="headerlink" href="#arche" title="Permalink to this headline">
 Click on the <strong>ARCHE</strong> button to get to the overview section.</p>
 <div class="section" id="overview">
 <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
-<p>Data provided in the production.py is displayed. If user belongs to the <strong>manager</strong> user group, a button called <strong>Fetch</strong> is displayed. Click <strong>Fetch</strong> to fetch data from ARCHE.</p>
+<p>Data provided in the production.py is displayed. If user belongs to the <strong>manager</strong> user group, a button called
+<strong>Fetch</strong> is displayed. Click <strong>Fetch</strong> to fetch data from ARCHE.</p>
 </div>
 <div class="section" id="fetch">
 <h2>Fetch<a class="headerlink" href="#fetch" title="Permalink to this headline">¶</a></h2>
@@ -224,19 +226,8 @@ <h2>Fetch<a class="headerlink" href="#fetch" title="Permalink to this headline">
 </div>
 <div class="section" id="data-from-arche">
 <h2>Data from ARCHE<a class="headerlink" href="#data-from-arche" title="Permalink to this headline">¶</a></h2>
-<p>All data is gathered from [IMAGE_NAME]_metadata.json:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s1">&#39;image_id&#39;</span><span class="p">:</span> <span class="n">image_id</span> <span class="p">(</span><span class="n">ARCHE</span><span class="p">)</span>
-<span class="s1">&#39;image_link&#39;</span><span class="p">:</span> <span class="n">image_url</span> <span class="p">(</span><span class="n">ARCHE</span><span class="p">)</span>
-<span class="s1">&#39;image_link_thumbnail&#39;</span><span class="p">:</span> <span class="n">thumbnail_url</span> <span class="p">(</span><span class="n">ARCHE</span><span class="p">)</span>
-<span class="s1">&#39;creator&#39;</span><span class="p">:</span> <span class="n">EXIF</span><span class="p">:</span><span class="n">Artist</span>
-<span class="s1">&#39;latitude&#39;</span><span class="p">:</span> <span class="n">EXIF</span><span class="p">:</span><span class="n">GPSLatitude</span>
-<span class="s1">&#39;longitude&#39;</span><span class="p">:</span> <span class="n">EXIF</span><span class="p">:</span><span class="n">GPSLongitude</span>
-<span class="s1">&#39;description&#39;</span><span class="p">:</span> <span class="n">XMP</span><span class="p">:</span><span class="n">Description</span>
-<span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="n">IPTC</span><span class="p">:</span><span class="n">ObjectName</span>
-<span class="s1">&#39;license&#39;</span><span class="p">:</span> <span class="n">EXIF</span><span class="p">:</span><span class="n">Copyright</span>
-<span class="s1">&#39;date&#39;</span><span class="p">:</span> <span class="n">EXIF</span><span class="p">:</span><span class="n">CreateDate</span>
-</pre></div>
-</div>
+<p>All metadata is gathered from the EXIF endpoint of the first image in the “2_JPGs” collection. Additionally the
+corresponded .png from “4_Orthophotos” is taken as reference file.</p>
 </div>
 <div class="section" id="automatically-created-entities">
 <h2>Automatically created entities<a class="headerlink" href="#automatically-created-entities" title="Permalink to this headline">¶</a></h2>

diff --git a/openatlas/static/manual/admin/content.html b/openatlas/static/manual/admin/content.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>Content &mdash; OpenAtlas 7.16.0 documentation</title>
+  <title>Content &mdash; OpenAtlas 7.17.0 documentation</title>
 
 
 
@@ -37,7 +37,7 @@
 
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Data integrity checks" href="data_integrity_checks.html" />
-    <link rel="prev" title="Map" href="map.html" /> 
+    <link rel="prev" title="IIIF" href="iiif.html" /> 
 </head>
 
 <body class="wy-body-for-nav">
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                7.16.0
+                7.17.0
               </div>
 
 
@@ -102,6 +102,7 @@
 <li class="toctree-l2"><a class="reference internal" href="mail.html">Mail</a></li>
 <li class="toctree-l2"><a class="reference internal" href="modules.html">Modules</a></li>
 <li class="toctree-l2"><a class="reference internal" href="map.html">Map</a></li>
+<li class="toctree-l2"><a class="reference internal" href="iiif.html">IIIF</a></li>
 <li class="toctree-l2 current"><a class="current reference internal" href="#">Content</a></li>
 <li class="toctree-l2"><a class="reference internal" href="data_integrity_checks.html">Data integrity checks</a></li>
 <li class="toctree-l2"><a class="reference internal" href="import.html">Import</a></li>
@@ -220,7 +221,7 @@ <h1>Content<a class="headerlink" href="#content" title="Permalink to this headli
           <footer>
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
         <a href="data_integrity_checks.html" class="btn btn-neutral float-right" title="Data integrity checks" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
-        <a href="map.html" class="btn btn-neutral float-left" title="Map" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="iiif.html" class="btn btn-neutral float-left" title="IIIF" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
     </div>
 
   <hr/>

diff --git a/openatlas/static/manual/admin/data_integrity_checks.html b/openatlas/static/manual/admin/data_integrity_checks.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>Data integrity checks &mdash; OpenAtlas 7.16.0 documentation</title>
+  <title>Data integrity checks &mdash; OpenAtlas 7.17.0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                7.16.0
+                7.17.0
               </div>
 
 
@@ -102,6 +102,7 @@
 <li class="toctree-l2"><a class="reference internal" href="mail.html">Mail</a></li>
 <li class="toctree-l2"><a class="reference internal" href="modules.html">Modules</a></li>
 <li class="toctree-l2"><a class="reference internal" href="map.html">Map</a></li>
+<li class="toctree-l2"><a class="reference internal" href="iiif.html">IIIF</a></li>
 <li class="toctree-l2"><a class="reference internal" href="content.html">Content</a></li>
 <li class="toctree-l2 current"><a class="current reference internal" href="#">Data integrity checks</a></li>
 <li class="toctree-l2"><a class="reference internal" href="import.html">Import</a></li>

diff --git a/openatlas/static/manual/admin/execute_sql.html b/openatlas/static/manual/admin/execute_sql.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>Execute SQL &mdash; OpenAtlas 7.16.0 documentation</title>
+  <title>Execute SQL &mdash; OpenAtlas 7.17.0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                7.16.0
+                7.17.0
               </div>
 
 
@@ -102,6 +102,7 @@
 <li class="toctree-l2"><a class="reference internal" href="mail.html">Mail</a></li>
 <li class="toctree-l2"><a class="reference internal" href="modules.html">Modules</a></li>
 <li class="toctree-l2"><a class="reference internal" href="map.html">Map</a></li>
+<li class="toctree-l2"><a class="reference internal" href="iiif.html">IIIF</a></li>
 <li class="toctree-l2"><a class="reference internal" href="content.html">Content</a></li>
 <li class="toctree-l2"><a class="reference internal" href="data_integrity_checks.html">Data integrity checks</a></li>
 <li class="toctree-l2"><a class="reference internal" href="import.html">Import</a></li>

diff --git a/openatlas/static/manual/admin/export.html b/openatlas/static/manual/admin/export.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>Export &mdash; OpenAtlas 7.16.0 documentation</title>
+  <title>Export &mdash; OpenAtlas 7.17.0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                7.16.0
+                7.17.0
               </div>
 
 
@@ -102,6 +102,7 @@
 <li class="toctree-l2"><a class="reference internal" href="mail.html">Mail</a></li>
 <li class="toctree-l2"><a class="reference internal" href="modules.html">Modules</a></li>
 <li class="toctree-l2"><a class="reference internal" href="map.html">Map</a></li>
+<li class="toctree-l2"><a class="reference internal" href="iiif.html">IIIF</a></li>
 <li class="toctree-l2"><a class="reference internal" href="content.html">Content</a></li>
 <li class="toctree-l2"><a class="reference internal" href="data_integrity_checks.html">Data integrity checks</a></li>
 <li class="toctree-l2"><a class="reference internal" href="import.html">Import</a></li>

diff --git a/openatlas/static/manual/admin/general.html b/openatlas/static/manual/admin/general.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>General &mdash; OpenAtlas 7.16.0 documentation</title>
+  <title>General &mdash; OpenAtlas 7.17.0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                7.16.0
+                7.17.0
               </div>
 
 
@@ -102,6 +102,7 @@
 <li class="toctree-l2"><a class="reference internal" href="mail.html">Mail</a></li>
 <li class="toctree-l2"><a class="reference internal" href="modules.html">Modules</a></li>
 <li class="toctree-l2"><a class="reference internal" href="map.html">Map</a></li>
+<li class="toctree-l2"><a class="reference internal" href="iiif.html">IIIF</a></li>
 <li class="toctree-l2"><a class="reference internal" href="content.html">Content</a></li>
 <li class="toctree-l2"><a class="reference internal" href="data_integrity_checks.html">Data integrity checks</a></li>
 <li class="toctree-l2"><a class="reference internal" href="import.html">Import</a></li>