Merge branch '55-update-documentation' into 'master'

55 update documentation

Update the documentation:
* Harvester wizard
* Export list in ODT
* inspirehep key words
* Close #55.

See merge request !54

docs/user/harvester_collection_inspirehep.rst

@@ -2,7 +2,7 @@
 
 .. _harvester_collection_inspirehep:
 
-les collections dan l'entrepôts inspirehep.net
+les collections dans l'entrepôts inspirehep.net
 -----------------------------------------------
 
 L'entrepôt *inspirehep.net* est très différent de *cds.cern.ch*, car il
@@ -11,7 +11,7 @@ scientifiques, notamment ceux étudiés à l'IN2P3.
 Ces documents peuvent être publiés par une collaboration internationale, une
 équippe, un théoriciens, *etc*.
 
-Dans *inspirehet.net*, seul les catégories de publication suivantes sont
+Dans *inspirehet.net*, les catégories de publication suivantes sont
 moissonnables :
 
     * articles
@@ -88,3 +88,21 @@ ALEPH, ATLAS, ALICE, CMS, ...
         +----------------------------------------+----------------------+
         | ``find cn lhcb and tc p and tc c``     | actes de conférences |
         +----------------------------------------+----------------------+
+
+
+
+Définir une collection à l'aide de mot clé, ouvre d'autres possibilitées.
+Par example, pour scanner les notes de conférence de la collaboration ATLAS:
+
+    .. line-block::
+
+        ``find r atlas-conf-*``
+
+Les mots clés sont définis à l'adresse:
+http://inspirehep.net/info/hep/search-tips#tc
+
+
+    .. attention::
+        Il est déconseillé d'utiliser les mots clés
+        *data*, *year* ou *aff*. Ils sont pris en charge par
+        l'application.

docs/user/harvester_expert.rst

+.. include:: hyperlinks.txt
+
+.. _harvester_expert:
+
+Configuration d'un moissonneur -- le mode expert
+------------------------------------------------
+
+La configuration des moissonneurs est accessible à partir
+du panneau de navigation rapide, en suivant le chemin :
+
+    .. index::
+        pair: Configurer les moissonneurs; moissonneurs
+
+    .. line-block::
+
+        ``Configurer les moissonneurs > moissonneurs``
+
+    .. _fig-form-harvester:
+
+    .. figure:: images/form-harvester.png
+       :align: center
+       :width: 50%
+
+       Le formulaire de saisie pour configurer un moissonneur.
+       Celui-ci recherche les articles publiés par la collaboration D0 dans
+       l'entrepôt *inspirehep.net*.
+
+L'ajout d'un moissonneur via le *mode expert* ouvre le formulaire de saisie
+montré sur la :numref:`fig-form-harvester`.
+Il a cinq champs :
+
+    * **projet**
+        choisir une valeur parmi les projets définis.
+    * **automate**
+        choisir un automate parmis les valeurs proposées.
+        Il détermine la catégorie de notice qui sera recherchée dans l'entrepôt
+        Il y en a sept :
+
+            #. ``articles``
+            #. ``notes``
+            #. ``preprint``
+            #. ``proceeding``
+            #. ``reports``
+            #. ``talks``
+            #. ``thesis``
+
+    * **entrepôt**
+        choisir un entrepôt permis les valeurs proposées.
+    * **collections**
+        ce champ définit la(es) collection(s) de l'entrepôt qui vont être
+        scannée(s). La définition d'une collection dépend de l'entrepôt
+        et de la catégorie des notices.
+
+            .. important::
+                Les différentes collections sont
+                détaillées dans les annexes : :ref:`harvester_collection_cds` et
+                :ref:`harvester_collection_inspirehep`.
+
+    * **code**
+        c'est le code AERES qui sera affecté aux notices trouvées. Les valeurs
+        possibles dépendent du choix de l'automate logiciel.
+
+    .. note::
+        Il est possible de définir deux moissonneurs. Le premier recherche, par
+        exemple, les articles de la collaboration LHCb dans l'entrepôt
+        *cds.cern.ch* et le second dans l'entrepôt *inspirehep.net*.
+
+    .. attention::
+        It n'est pas posssible de définir deux moissoneurs quand le premier
+        recherche, par exemple, les articles de LHCb de catégorie ``ACL`` et
+        le second ceux de catégorie ``ACLN``.

docs/user/harvesters.rst

@@ -92,59 +92,32 @@ du panneau de navigation rapide, en suivant le chemin :
 
         ``Configurer les moissonneurs > moissonneurs``
 
-    .. _fig-form-harvester:
+Dans la table des moissonneurs, l'item du menu contextuel *Ajouter* a été
+scindé en deux, comme le montre la :numref:`fig-wizard-harvester`.
 
-    .. figure:: images/form-harvester.png
+    .. _fig-wizard-harvester:
+
+    .. figure:: images/wizard-harvester.png
        :align: center
        :width: 50%
 
-       Le formulaire de saisie pour configurer un moissonneur.
-       Celui-ci recherche les articles publiés par la collaboration D0 dans
-       l'entrepôt *inspirehep.net*.
-
-Le formulaire de saisie est montré sur la :numref:`fig-form-harvester`.
-Il a cinq champs :
-
-    * **projet**
-        choisir une valeur parmi les projets définis.
-    * **automate**
-        choisir un automate parmis les valeurs proposées.
-        Il détermine la catégorie de notice qui sera recherchée dans l'entrepôt
-        Il y en a sept :
-
-            #. ``articles``
-            #. ``notes``
-            #. ``preprint``
-            #. ``proceeding``
-            #. ``reports``
-            #. ``talks``
-            #. ``thesis``
-
-    * **entrepôt**
-        choisir un entrepôt permis les valeurs proposées.
-    * **collections**
-        ce champ définit la(es) collection(s) de l'entrepôt qui vont être
-        scannée(s). La définition d'une collection dépend de l'entrepôt
-        et de la catégorie des notices.
-
-            .. important::
-                Les différentes collections sont
-                détaillées dans les annexes : :ref:`harvester_collection_cds` et
-                :ref:`harvester_collection_inspirehep`.
-
-    * **code**
-        c'est le code AERES qui sera affecté aux notices trouvées. Les valeurs
-        possibles dépendent du choix de l'automate logiciel.
+       Le menu contextuel de la table moissoneurs permet de lancer
+       l'assitant de configuration (mode simplifié).
 
-    .. note::
-        Il est possible de définir deux moissonneurs. Le premier recherche, par
-        exemple, les articles de la collaboration LHCb dans l'entrepôt
-        *cds.cern.ch* et le second dans l'entrepôt *inspirehep.net*.
+Le *mode simplifié* lance un assistant qui permet de configurer
+les moissonneurs les plus courant. La première page de l'assitant est
+montrée sur la :numref:`fig-wizard-harvester-page1`.
 
-    .. attention::
-        It n'est pas posssible de définir deux moissoneurs quand le premier
-        recherche, par exemple, les articles de LHCb de catégorie ``ACL`` et
-        le second ceux de catégorie ``ACLN``.
+    .. _fig-wizard-harvester-page1:
+
+    .. figure:: images/wizard-harvester-page1.png
+       :align: center
+       :width: 50%
+
+       La première page de l'assistant de configuration des moissonneurs.
+
+Le *mode expert* donne accès à l'ensemble des paramètres de configuration
+des moissonneurs. Ils sont détaillés dans l'Annexe :ref:`harvester_expert`.
 
 Exécuter un moissonneur
 ^^^^^^^^^^^^^^^^^^^^^^^

docs/user/hyperlinks.txt

@@ -19,12 +19,16 @@
 
 .. _LaTeX: http://www.latex-project.org/
 
+.. _LibreOffice: http://fr.libreoffice.org/
+
 .. _MARC: http://www.loc.gov/marc/
 
+.. _OpenDocument: https://fr.wikipedia.org/wiki/OpenDocument
+
 .. _python: https://www.python.org/
 
 .. _reStructured: http://sphinx-doc.org/rest.html
 
 .. _sphinx: http://sphinx-doc.org/
 
-.. _XML: http://fr.wikipedia.org/wiki/Extensible_Markup_Language
+.. _XML: https://fr.wikipedia.org/wiki/Extensible_Markup_Language

docs/user/index.rst

@@ -33,6 +33,7 @@ Annexe
     application_identifier
     institute_identifier
     category_aeres
+    harvester_expert
     harvester_processing
     harvester_collection_cds
     harvester_collection_inspirehep

docs/user/lists.rst

@@ -98,16 +98,19 @@ cette exécution. Il comprend sept conditions :
     * **Liste**
         la liste prédéfinie que l'on veut fabriquer.
     * **Format**
-        la liste peut être exportée au format BibTex, CSV, HTML, LaTeX ou PDF.
-
-    .. note::
-        le choix de la *liste* et de l'*année* sont les
-        conditions les plus importantes.
+        la liste peut être exportée au format BibTex, LaTeX, ODT ou PDF.
 
 Pour lancer la fabrication de la liste cliquer sur le bouton ``Go``.
 Le résultat apparaît dans le panneau central quand le format HTML est sélectionné.
 
 
+    .. note::
+        Pour mettre en page une liste avec un logiciel de traitement de texte
+        comme LibreOffice_ ou Microsoft Word, il suffit
+        d'exporter la liste au format OpenDocument_ ODT et
+        d'ouvrir le fichier avec le logiciel de traitement de texte.
+        Noter que dans ce cas de figure, les équations ne sont pas interprétées.
+
 Créer une liste
 ^^^^^^^^^^^^^^^