doc

still in improvments
Patent2net · Jan 5, 2021 · dfe795a · dfe795a
1 parent 15bb324
commit dfe795a
Show file tree

Hide file tree

Showing 34 changed files with 319 additions and 136 deletions.
diff --git a/README.rst b/README.rst
@@ -56,7 +56,7 @@ Some extra additional features comes also within the makefile... Help us to impr
 Project information: Who we are
 -------------------------------
 The source code of the Patent2Net toolkit is available under an open source license,
-see also  ` Patent2Net on GitHub <https://github.com/Patent2net/P2N-v3/tree/master>`_
+see also  `Patent2Net on GitHub <https://github.com/Patent2net/P2N-v3/tree/master>`_
 
 The project is elaborated and maintained by an `international team <http://patent2netv2.vlab4u.info/dokuwiki/doku.php?id=about_p2n:community>`_
 of university professors and researchers on a free basis.

diff --git a/doc/CHANGES.rst b/doc/CHANGES.rst
@@ -1,7 +1,3 @@
-###########
-Development
-###########	
-
 .. _Changes:
 
 *****************************

diff --git a/doc/_build/doctrees/CHANGES.doctree b/doc/_build/doctrees/CHANGES.doctree
diff --git a/doc/_build/doctrees/environment.pickle b/doc/_build/doctrees/environment.pickle
diff --git a/doc/_build/doctrees/index.doctree b/doc/_build/doctrees/index.doctree
diff --git a/doc/_build/doctrees/todo.doctree b/doc/_build/doctrees/todo.doctree
diff --git a/doc/_build/doctrees/usage/adhoc.doctree b/doc/_build/doctrees/usage/adhoc.doctree
diff --git a/doc/_build/html/CHANGES.html b/doc/_build/html/CHANGES.html
diff --git a/doc/_build/html/_sources/CHANGES.rst.txt b/doc/_build/html/_sources/CHANGES.rst.txt
@@ -1,7 +1,3 @@
-###########
-Development
-###########	
-
 .. _Changes:
 
 *****************************

diff --git a/doc/_build/html/_sources/index.rst.txt b/doc/_build/html/_sources/index.rst.txt
@@ -13,26 +13,31 @@
 
 .. include:: ../README.rst
 
-
-
 .. toctree::
     :maxdepth: 1
 
     setup
 
-
-
 .. toctree::
     :maxdepth: 2
 
     usage/index
-
-
+
 .. toctree::
     :maxdepth: 2
 
     historic/index
 
+
+.. toctree::
+    :maxdepth: 1
+
+    dev/index
+
+###########
+Development
+###########	
+
 .. toctree::
     :maxdepth: 1
 
@@ -49,6 +54,7 @@ Indices and tables
 
 * :ref:`genindex`
 * :ref:`modindex`
+
 ..
 	* :ref:`search`
 	I put it in comment... I don't know what this ref is intended for
diff --git a/doc/_build/html/_sources/todo.rst.txt b/doc/_build/html/_sources/todo.rst.txt
@@ -1,10 +1,10 @@
 *******************
 Todo list and ideas
 *******************
-
+=============
 Version 4.0.0
 =============
-------
+
 Agenda
 ------
 .. note:: 
@@ -50,18 +50,21 @@ Although Patent2Net is fully operational, works fine and is enough to begin usin
 
 New contributions and ideas are always welcome.
 
+=============
 Version 3.0.0
 =============
 
 New capabilities
 ----------------
+
 Added some new capabilities to Patent2Net, i.e.:
 
 * Within the Patent Universe, build a drawings gallery with hyperlink to the Espacenet patent 
 * Within the Familly Patent Universe, provide all the same analysis as with the Patent Universe 
 
 Todo
 ----
+
 * Include the treatment of the Cooperative Patent Classification (CPC) with the proportion of P.U. concerned (http://www.cooperativepatentclassification.org/Archive.html)
 * Build a small database to display results of a specific (Familly) Patent Universe. Database could be [PouchDB] (https://pouchdb.com/) or equivalent
 

diff --git a/doc/_build/html/configure.html b/doc/_build/html/configure.html
@@ -37,7 +37,7 @@
 
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Development" href="CHANGES.html" />
+    <link rel="next" title="&lt;no title&gt;" href="dev/index.html" />
     <link rel="prev" title="When you know what you do..." href="historic/install.html" /> 
 </head>
 
@@ -94,7 +94,7 @@
 <li class="toctree-l1"><a class="reference internal" href="usage/index.html">Usage</a></li>
 </ul>
 <ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="historic/index.html">Global architecture and data model</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="historic/index.html">Historical features</a><ul class="current">
 <li class="toctree-l2 current"><a class="reference internal" href="historic/index.html#developper-s-mode">Developper's mode</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="historic/index.html#installation">installation</a></li>
 <li class="toctree-l3 current"><a class="reference internal" href="historic/index.html#configure">configure</a><ul class="current">
@@ -108,7 +108,13 @@
 </li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dev/system.html">System configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dev/dataModel.html">P2N Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dev/exports.html">File extension and data formats for specific software</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dev/exports.html#chained-software">Chained software</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Patent2Net CHANGES (in short)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="historic/contributing.html">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="documentation.html">Contribute to documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="release.html">Release</a></li>
@@ -159,7 +165,7 @@
 
       <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
 
-          <li><a href="historic/index.html">Global architecture and data model</a> &raquo;</li>
+          <li><a href="historic/index.html">Historical features</a> &raquo;</li>
 
       <li>Configuration</li>
 
@@ -227,7 +233,7 @@ <h3>OPS registration<a class="headerlink" href="#ops-registration" title="Permal
 
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
-        <a href="CHANGES.html" class="btn btn-neutral float-right" title="Development" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="dev/index.html" class="btn btn-neutral float-right" title="&lt;no title&gt;" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
         <a href="historic/install.html" class="btn btn-neutral float-left" title="When you know what you do..." accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

diff --git a/doc/_build/html/documentation.html b/doc/_build/html/documentation.html
@@ -94,10 +94,16 @@
 <li class="toctree-l1"><a class="reference internal" href="usage/index.html">Usage</a></li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="historic/index.html">Global architecture and data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="historic/index.html">Historical features</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="dev/system.html">System configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dev/dataModel.html">P2N Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dev/exports.html">File extension and data formats for specific software</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dev/exports.html#chained-software">Chained software</a></li>
 </ul>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Patent2Net CHANGES (in short)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="historic/contributing.html">Contributing</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Contribute to documentation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#introduction">Introduction</a></li>

diff --git a/doc/_build/html/genindex.html b/doc/_build/html/genindex.html
@@ -92,11 +92,14 @@
 <li class="toctree-l1"><a class="reference internal" href="usage/index.html">Usage</a></li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="historic/index.html">Global architecture and data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="historic/index.html">Historical features</a></li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Development</a></li>
-<li class="toctree-l1"><a class="reference internal" href="historic/contributing.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dev/index.html">Global architecture and data model</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Patent2Net CHANGES (in short)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="historic/contributing.html">Contribute to the project</a></li>
 <li class="toctree-l1"><a class="reference internal" href="documentation.html">Contribute to documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="release.html">Release</a></li>
 <li class="toctree-l1"><a class="reference internal" href="todo.html">Todo list and ideas</a></li>

diff --git a/doc/_build/html/index.html b/doc/_build/html/index.html
@@ -97,11 +97,14 @@
 <li class="toctree-l1"><a class="reference internal" href="usage/index.html">Usage</a></li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="historic/index.html">Global architecture and data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="historic/index.html">Historical features</a></li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Development</a></li>
-<li class="toctree-l1"><a class="reference internal" href="historic/contributing.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dev/index.html">Global architecture and data model</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Patent2Net CHANGES (in short)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="historic/contributing.html">Contribute to the project</a></li>
 <li class="toctree-l1"><a class="reference internal" href="documentation.html">Contribute to documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="release.html">Release</a></li>
 <li class="toctree-l1"><a class="reference internal" href="todo.html">Todo list and ideas</a></li>
@@ -267,24 +270,32 @@ <h3>Demo<a class="headerlink" href="#demo" title="Permalink to this headline">¶
 </div>
 <div class="toctree-wrapper compound">
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="historic/index.html">Global architecture and data model</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="historic/index.html">Historical features</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="historic/index.html#developper-s-mode">Developper's mode</a></li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="toctree-wrapper compound">
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Development</a></li>
-<li class="toctree-l1"><a class="reference internal" href="historic/contributing.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dev/index.html">Global architecture and data model</a></li>
+</ul>
+</div>
+</div>
+</div>
+</div>
+<div class="section" id="development">
+<h1>Development<a class="headerlink" href="#development" title="Permalink to this headline">¶</a></h1>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Patent2Net CHANGES (in short)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="historic/contributing.html">Contribute to the project</a></li>
 <li class="toctree-l1"><a class="reference internal" href="documentation.html">Contribute to documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="release.html">Release</a></li>
 <li class="toctree-l1"><a class="reference internal" href="todo.html">Todo list and ideas</a></li>
 </ul>
 </div>
 </div>
-</div>
-</div>
 <div class="section" id="indices-and-tables">
 <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
 <ul class="simple">

diff --git a/doc/_build/html/objects.inv b/doc/_build/html/objects.inv
diff --git a/doc/_build/html/release.html b/doc/_build/html/release.html
@@ -94,10 +94,16 @@
 <li class="toctree-l1"><a class="reference internal" href="usage/index.html">Usage</a></li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="historic/index.html">Global architecture and data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="historic/index.html">Historical features</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="dev/system.html">System configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dev/dataModel.html">P2N Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dev/exports.html">File extension and data formats for specific software</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dev/exports.html#chained-software">Chained software</a></li>
 </ul>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Patent2Net CHANGES (in short)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="historic/contributing.html">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="documentation.html">Contribute to documentation</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Release</a><ul>

diff --git a/doc/_build/html/search.html b/doc/_build/html/search.html
@@ -94,11 +94,14 @@
 <li class="toctree-l1"><a class="reference internal" href="usage/index.html">Usage</a></li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="historic/index.html">Global architecture and data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="historic/index.html">Historical features</a></li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Development</a></li>
-<li class="toctree-l1"><a class="reference internal" href="historic/contributing.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dev/index.html">Global architecture and data model</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Patent2Net CHANGES (in short)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="historic/contributing.html">Contribute to the project</a></li>
 <li class="toctree-l1"><a class="reference internal" href="documentation.html">Contribute to documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="release.html">Release</a></li>
 <li class="toctree-l1"><a class="reference internal" href="todo.html">Todo list and ideas</a></li>

diff --git a/doc/_build/html/searchindex.js b/doc/_build/html/searchindex.js
diff --git a/doc/_build/html/setup.html b/doc/_build/html/setup.html
@@ -105,10 +105,16 @@
 <li class="toctree-l1"><a class="reference internal" href="usage/index.html">Usage</a></li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="historic/index.html">Global architecture and data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="historic/index.html">Historical features</a></li>
 </ul>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dev/system.html">System configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dev/dataModel.html">P2N Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dev/exports.html">File extension and data formats for specific software</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dev/exports.html#chained-software">Chained software</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Patent2Net CHANGES (in short)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="historic/contributing.html">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="documentation.html">Contribute to documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="release.html">Release</a></li>
@@ -194,7 +200,7 @@ <h3>Installation<a class="headerlink" href="#installation" title="Permalink to t
 <li><p>download the docker-install branch (<a class="reference external" href="https://github.com/Patent2net/P2N-v3/tree/docker_install">https://github.com/Patent2net/P2N-v3/tree/docker_install</a>)</p></li>
 <li><p>Use the Install_P2N.bat and enjoy P2N via docker image</p></li>
 <li><p>See Install.bat in the elatickibana directory for the full architecture (BETA) with elastic search and Kibana</p></li>
-<li><p>Refer to <span class="xref std std-ref">docker-install</span> procedure for details</p></li>
+<li><p>Refer to <a class="reference internal" href="dev/system.html#docker-install"><span class="std std-ref">Dealing with docker version</span></a> procedure for details</p></li>
 </ol>
 </div>
 <div class="section" id="configuration">