add info on data export/import HDA -> hdalab + management fo the static resources of renkan client. documentation
authorymh <ymh.work@gmail.com>
Thu, 12 Apr 2018 18:33:25 +0200
branchdocumentation
changeset 695 f151478c7628
parent 694 46da276fbb1b
child 696 06825f3aa213
add info on data export/import HDA -> hdalab + management fo the static resources of renkan client.
doc/source/commandes.rst
doc/source/renkan.rst
--- a/doc/source/commandes.rst	Thu Apr 12 01:59:24 2018 +0200
+++ b/doc/source/commandes.rst	Thu Apr 12 18:33:25 2018 +0200
@@ -224,3 +224,20 @@
 ----------------------
 
 .. automodule:: hdalab.management.commands.send_moderation_mail
+
+
+Import des données RDF HDA
+==========================
+
+La mise à jour des fiches HDA se fait par un process d'export/import des données.
+Une archive RDF est régulièrement exportée à partir d'HDA et publiée sur une URL publique (http://data.culture.fr/entrepot/HDA/export.tgz).
+Cette archive est alors régulièrement téléchargée et importée dans hdalab.
+
+Le script d'import réalisant l'importation peut être trouvé dans le fichier suivant : ``/dev/hdalab/import_hda_rdf.sh``.
+
+Ce script lance les commandes suivantes:
+
+  #. :class:`import_rdf <hdabo.management.commands.import_rdf>`
+  #. :class:`import_hdabo_db -c <hdalab.management.commands.import_hdabo_db>`
+  #. `rebuild_index <http://django-haystack.readthedocs.io/en/master/management_commands.html#rebuild-index>`_
+
--- a/doc/source/renkan.rst	Thu Apr 12 01:59:24 2018 +0200
+++ b/doc/source/renkan.rst	Thu Apr 12 18:33:25 2018 +0200
@@ -14,6 +14,7 @@
 En particulier la partie du client en charge des communications avec le serveur (chargement des projets, gestion de la persistance) est totalement modulaire et configurable.
 Cela permet d'adapter facilement le client à l'api de sauvegarde du serveur.
 
+Les sources et la documentation Renkan peuvent être trouvées dans le dépot de code suivant : https://www.iri.centrepompidou.fr/dev/hg/renkan.
 
 Modèle de donnée serveur (HDALab)
 =================================
@@ -125,6 +126,9 @@
         ]
     }
 
+On retrouve une documentation un peu plus détaillée à l'url suivante : https://www.iri.centrepompidou.fr/dev/hg/renkan/file/tip/client/README.md .
+
+
 Système de chutier
 ==================
 
@@ -197,3 +201,29 @@
 la sauvegarde des renkan est définie dans le fichier `hdalab/static/hdalab/js/renkan-manual-save.js`.
 La sauvegarde est déclenchée par une action de l'utilisateur.
 
+
+Le module `renkanmanager`
+=========================
+
+Module Django
+-------------
+
+Les fonctionnalité Renkan sont apportée par la librairie Django `renkanmanager`. Le code source de cette librairie se trouve dans le `dépot de code source du projet Renkan <https://www.iri.centrepompidou.fr/dev/hg/renkan>`_ dans le répertoire `/server/python/django/renkanmanager` (c.f. https://www.iri.centrepompidou.fr/dev/hg/renkan/file/tip/server/python/django/renkanmanager).
+
+
+Gestions des fichiers applicatifs Renkan
+----------------------------------------
+
+L'ensemble des fichiers nécessaires au fonctionnement du client Renkan (javascript, css, imags, libraries) sont fournis comme `ressources statiques <https://docs.djangoproject.com/en/1.8/howto/static-files/>`_ par le module Django `renkanmanager`.
+
+On peut en parcourir l'arborescence à l'url suivante : https://www.iri.centrepompidou.fr/dev/hg/renkan/file/tip/server/python/django/renkanmanager/static/renkanmanager .
+
+Tous ces fichiers sont donc mis à jour lors de l'installation d'une nouvelle version de `renkanmanager`.
+
+Une description plus précise des fichiers nécessaires à l'instanciation d'un client Renkan dans une page web peut être trouvée dans le fichier `Readme <https://www.iri.centrepompidou.fr/dev/hg/renkan/file/tip/client/README.md>`_ du client.
+Des exemples d'intégration se trouvent dans le répertoire `test` du client Renkan (https://www.iri.centrepompidou.fr/dev/hg/renkan/file/tip/client/test).
+
+
+
+
+