Commit eecd5220 authored by LE GAC Renaud's avatar LE GAC Renaud
Browse files

Polish...

parent 70489e21
......@@ -5,26 +5,28 @@
Les catégories de publications
------------------------------
Les catégories de publications sont définit par deux variables nommées
Les catégories de publications sont définies par deux variables nommées
*catégorie* et *code*.
La première est plus générale que la seconde. La première est associée
au catégorie usuelle tandis que la seconde correspond aux codes AERES.
aux catégories usuelles tandis que la seconde correspond aux codes AERES.
La définition de ces variables et leurs relations sont accessible à partir
du panneau de navigation rapide, en suivant le chemin :
.. code-block:: python
::
les données des publications > catégories.
Elles peuvent être modifiés à tous moment en fonction des besoins des
Elles peuvent être modifiés à tous moments en fonction des besoins des
utilisateurs.
Par défaut, les catégories usuelles et celles de l'AERES sont chargées dans la
base de données et rappelées dans la :numref:`table-categorie`.
base de données et rappelées dans la :numref:`Table %s <table-categorie>`.
.. _table-categorie:
.. csv-table::
:file: csv/categories.csv
:widths: 5 15 50
.. table:: Les catégoires AERES.
.. csv-table::
:file: csv/categories.csv
:widths: 5 15 50
......@@ -6,7 +6,7 @@
Vérifier et valider
===================
L'assistant *vérifer et valider* analyse la cohérence des données
L'assistant *vérifier et valider* analyse la cohérence des données
bibliographiques et recherche aussi les doublons.
Pour les publications qui satisfont ses critères, il peut changer leurs status
de l'état ``indéfini`` à ``OK``.
......@@ -15,7 +15,7 @@ de l'état ``indéfini`` à ``OK``.
Quand les status d'une publication est ``OK``,
elle ne peut plus être modifiée ou détruite.
De plus, elles ne sont plus analysés par cet assistant.
De plus, elles ne sont plus analysées par cet assistant.
Les règles de cohérence
^^^^^^^^^^^^^^^^^^^^^^^
......@@ -43,13 +43,13 @@ Pour les présentations orales et les actes de conférence, il vérifie que :
Pour les rapports, il vérifie que :
* le numéro de rapport est définit
* le numéro de rapport est défini
Lancer l'assistant
^^^^^^^^^^^^^^^^^^
Pour lancer cet assistant, lancer l'action :
.. code-block:: c
::
Assitants > vérifier et valider
......@@ -75,7 +75,7 @@ Un exemple de compte-rendu est montré sur la :numref:`fig-out-check-validate`.
:align: center
:width: 90%
Le compte rendu de l'assistant *vérifer et valider*.
Le compte rendu de l'assistant *vérifier et valider*.
Il est très similaire à celui d'un moissonneur.
......
......@@ -71,6 +71,9 @@ extensions = [
]
numfig = True
numfig_format = {'figure': 'Figure %s',
'table': 'Table %s',
'code-block': 'Listing %s'}
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
......
......@@ -5,11 +5,11 @@ Publication,Titre,le titre de la publications
,Collaboration,le nom de(s) la collaboration(s) qui signe(nt) la publication
,Revue,le titre de la revue ou du journal
,Volume,le numéro du volume
,Page,les numéro des pages
,Page,les numéros des pages
,Année,l’année de la publication
,Soumis,la date de soumission
,Preprint,le numéro du preprint dans arXiv
,URL du fichier PDF,hyperlien pointant sur le fichier PDF
Méta,Auteurs,les membres du laboratoire qui ont signé cette publication
,projet,le projet du laboratoire a qui appartient cette publication
,projet,le projet du laboratoire à qui appartient cette publication
,Catégorie,la catégorie AERES (ACL ou ACLN)
......@@ -3,10 +3,10 @@ Publication,Titre,le titre de la publications
,Premier auteur,le nom du premier auteur
,Auteurs,la liste complète des auteurs
,Collaboration,le nom de(s) la collaboration(s) qui signe(nt) la publication
,Année,l'anné de la publication
,Année,l'année de la publication
,Soumis,la date de soumission
,URL du fichier PDF,hyperlien pointant sur le fichier PDF
Rapport,Numéro,le(s) numéro(s) du rapport
Méta,Auteurs,les membres du laboratoire qui ont signé cette publication
,Projet,le projet du laboratoire a qui appartient cette publication
,Categorie,la catégories AERES (AP)
,Projet,le projet du laboratoire à qui appartient cette publication
,Categorie,la catégorie AERES (AP)
......@@ -2,12 +2,12 @@ Onglet,Champ,Définition
Publication,Titre,le titre de la publications
,Premier auteur,le nom du premier auteur
,Auteurs,la liste complète des auteurs
,Année,l'anné de la publication
,Année,l'année de la publication
,Soumis,la date de soumission
,URL du fichier PDF,hyperlien pointant sur le fichier PDF
Mémoire,Directeurs,le(s) nom(s) du(es) directeur(s)
,Universités,le(s) nom(s) du(es) Université(s) ou est préparé le diplôme
,Universités,le(s) nom(s) du(es) Université(s) où est préparé le diplôme
,Soutenance,la date de soutenance
Méta,Auteurs,les membres du laboratoire qui ont signé cette publication
,Projet,le projet du laboratoire a qui appartient cette publication
,Categorie,"la catégories AERES (PHD, HDR, ...)"
,Projet,le projet du laboratoire à qui appartient cette publication
,Categorie,"la catégorie AERES (PHD, HDR, ...)"
......@@ -5,7 +5,7 @@ Publication,Titre,le titre de la publications
,Collaboration,le nom de(s) la collaboration(s) qui signe(nt) la publication
,Revue,le titre de la revue ou du journal
,Volume,le numéro du volume
,Page,les numéro des pages
,Page,les numéros des pages
,Année,l’année de la publication
,Soumis,la date de soumission
,Preprint,le numéro du preprint dans arXiv
......@@ -17,5 +17,5 @@ Conférence,Titre,le titre de la conférence
,Pays,le pays ou s'est tenu la conférence
,Orateur,le nom de l'orateur
Méta,Auteurs,les membres du laboratoire qui ont signé cette publication
,Projet,le projet du laboratoire a qui appartient cette publication
,Projet,le projet du laboratoire à qui appartient cette publication
,Catégorie,la catégorie AERES (ACTI ou ACTN)
......@@ -13,5 +13,5 @@ Conférence,Titre,le titre de la conférence
,Pays,le pays ou s'est tenu la conférence
,Orateur,le nom de l'orateur
Méta,Auteurs,les membres du laboratoire qui ont signé cette publication
,Projet,le projet du laboratoire a qui appartient cette publication
,Projet,le projet du laboratoire à qui appartient cette publication
,Catégorie,la catégorie AERES (COM)
......@@ -28,7 +28,7 @@ Il est organisé en six onglets qui regroupent les champs par spécificité :
* **Ouvrage**
les numéros ISBN, ISSN, ...
* **Méta**
les données lié au laboratoire : le projet qui a
les données liées au laboratoire : le projet qui a
publié, les membres du laboratoire qui ont signé,
la catégorie de la publication, le status de la publication dans
la base de données, ...
......@@ -36,123 +36,176 @@ Il est organisé en six onglets qui regroupent les champs par spécificité :
Les champs obligatoires
^^^^^^^^^^^^^^^^^^^^^^^
Les champs obligatoires sont marqués par une astérisque orange et
Les champs obligatoires sont marqués par un astérisque orange et
distribués sur les onglets *Publication* et *Méta*.
Il doivent absolument être définit.
Leurs significations sont décrite dans la :numref:`table-mandatory-fields`.
Ils doivent absolument être définis.
Leurs significations sont décrites dans la :numref:`table-mandatory-fields`.
.. _table-mandatory-fields:
.. csv-table::
:file: csv/mandatory_fields.csv
:widths: 10 15 50
.. table:: Les champs obligatoires pour toutes les publications.
.. csv-table::
:file: csv/mandatory_fields.csv
:widths: 10 15 50
Les champs à remplir
^^^^^^^^^^^^^^^^^^^^
Les cartographie des champs à remplir dépendent de la catégorie.
Elles sont les suivante :
Les cartographies des champs à remplir dépendent de la catégorie.
Elles sont décrites dans la :numref:`Table %s <table-article>` pour les
articles, la :numref:`Table %s <table-proceeding>` pour les actes de conférence,
la :numref:`Table %s <table-talk>` pour les présentations orales,
la :numref:`Table %s <table-phd>` pour les mémoires et
la :numref:`Table %s <table-note>` pour les rapports.
* **article**
.. rubric:: **article**
.. csv-table::
:file: csv/fields_article.csv
:widths: 10 20 50
.. _table-article:
* **actes de conférence**
.. table:: Les champs à remplir pour les articles.
.. csv-table::
:file: csv/fields_proceeding.csv
:widths: 10 20 50
.. csv-table::
:file: csv/fields_article.csv
:widths: 10 20 50
* **présentation orale**
.. rubric:: **Actes de conférence**
.. csv-table::
:file: csv/fields_talk.csv
:widths: 10 20 50
.. _table-proceeding:
* **mémoire de doctorat, HDR, ...**
.. table:: Les champs à remplir pour les actes de conférence.
.. csv-table::
:file: csv/fields_phd.csv
:widths: 10 20 50
.. csv-table::
:file: csv/fields_proceeding.csv
:widths: 10 20 50
.. note::
Dans ce cas de figure, le contenu des champs premier auteur,
auteurs de la publication et du laboratoire sont identique
.. rubric:: **Présentation orale**
.. note::
En générale, la date de soumission et la date de soutenance
sont identique.
.. _table-talk:
* **Note, rapport, ..**
.. table:: Les champs à remplir pour les présentations orales.
.. csv-table::
:file: csv/fields_note.csv
:widths: 10 20 50
.. csv-table::
:file: csv/fields_talk.csv
:widths: 10 20 50
.. rubric:: **Mémoire de doctorat et Habilitation à diriger les recherche**
.. _table-phd:
.. table:: Les champs à remplir pour les mémoires.
.. csv-table::
:file: csv/fields_phd.csv
:widths: 10 20 50
.. note::
Dans ce cas de figure, le contenu des champs premier auteur,
auteurs de la publication et du laboratoire sont identique
.. note::
En général, la date de soumission et la date de soutenance
sont identique.
.. rubric:: **Note et rapport**
.. _table-note:
.. table:: Les champs à remplir pour les rapports.
.. csv-table::
:file: csv/fields_note.csv
:widths: 10 20 50
Les conventions d'écriture
^^^^^^^^^^^^^^^^^^^^^^^^^^
Afin d'uniformiser le contenu de la base données, il est essentiel de respecter
les règles d'écriture des différents champs. Elles sont les suivantes:
les règles d'écriture des différents champs. Elles sont les suivantes :
.. rubric:: **date de soumission**
Dérivé de la norme ISO-8601. Les valeurs admises sont :
::
2011-12-31
2011-12
.. rubric:: **dates d'une conférence**
En anglais selon les règle typographique anglaise.
Les valeurs admises sont :
::
9-10 Oct 2012
29 Oct - 3 Nov 2012
3 Dec 2012
.. attention::
à la position des espaces et des majuscules.
Les mois sont abréviés sur 3 lettres et commencent par
une majuscule.
.. rubric:: **nom d'un auteur**
l'initial du prénom est suivie d'un point puis du nom de famille :
::
J. Doe
P.-Y. Smith
.. attention::
à la position des espaces, des majuscules et du trait d'union.
.. rubric:: **nom d'une collaboration**
Le nom d'une collaboration se termine par ``Collaboration``
ou ``Working Group`` :
* **date de soumission**
dérivé de la norme ISO-8601.
Les valeurs admises sont ``2011-12-31`` ou ``2011-12``
::
* **dates d'une conférence**
en anglais selon les règle typographique anglaise.
Les valeurs admises sont : ::
LHCb Collaboration
Atlas Collaboration, CMS Collaboration
ANTARES and TAROT Collaborations
ALEPH Collaboration, DELPHI Collaboration, LEP Electroweak Working Group
9-10 Oct 2012
29 Oct - 3 Nov 2012
3 Dec 2012
.. attention::
.. note::
Attention à la position des espaces.
Les mois sont abbréviés sur 3 lettres et commencent par
une majuscule.
à la position des majuscules.
* **nom d'un auteur**
l'initial du prénom est suivie d'un point puis du nom de famille : ::
.. rubric:: **nom d'une revue**
J. Doe
P.-Y. Smith
L'abréviation du titre de la revue sans point :
.. note::
Attention à la position des espaces et du trait d'union.
::
* **nom d'une collaboration**
le nom d'une collaboration se termine par ``Collaboration``
ou ``Working Group`` : ::
Int J Mod Phy A
Phys Lett B
LHCb Collaboration
Atlas Collaboration, CMS Collaboration
ANTARES and TAROT Collaborations
ALEPH Collaboration, DELPHI Collaboration, LEP Electroweak Working Group
.. rubric:: **les liste de noms**
* **nom d'une revue**
abréviation du titre de la revue sans point : ::
Dans une liste, les noms (collaboration, auteur, directeur de thèse,
ou université) sont séparés par une virgule suivit d'un espace :
Int J Mod Phy A
Phys Lett B
::
* **les liste de noms**
dans une liste, les noms (collaboration, auteur, directeur de thèse,
ou université) sont séparés par une virgule suivit d'un espace : ::
K. Doa, J. Doe, P-.Y Smith
ALEPH Collaboration, DELPHI Collaboration, L3 Collaboration
K. Doa, J. Doe, P-.Y Smith
ALEPH Collaboration, DELPHI Collaboration, L3 Collaboration
.. rubric:: **symbole mathématique**
* **symbole mathématique**
les symboles et les équations obéissent à la syntaxe LaTeX_.
Ils commencent et se terminent par ``$`` : ::
Les symboles et les équations obéissent à la syntaxe LaTeX_.
Ils commencent et se terminent par ``$`` :
$\alpha$
$x^2$
$K_S^0$
::
$\alpha$
$x^2$
$K_S^0$
......@@ -9,12 +9,14 @@ Accéder à l'application
L'accès à cette application se fait à travers un *navigateur web*, de préférence
firefox_. Des *hyperliens* ont été défini pour les laboratoires de l'IN2P3 :
.. csv-table::
:file: csv/applications.csv
:widths: 20 50
.. table:: Les hyperliens pour accéder à l'application.
Dans la suite, ces hyperliens qui pointent sur la page d'accueil, seront
appelés ``https://marprod.in2p3.fr/track_publications_xxx``.
.. csv-table::
:file: csv/applications.csv
:widths: 20 50
Dans la suite, ces hyperliens qui pointent sur la page d'accueil, sont notés
``https://marprod.in2p3.fr/track_publications_xxx``.
Il suffit de remplacer le joker ``xxx`` par le sigle de votre laboratoire.
.. _register:
......@@ -96,7 +98,7 @@ La page principale de l'application est montrée sur la :numref:`fig-home`.
Vue de l'application avec toutes ces actions, quand des publications
ont été saisies.
Elle est divisé en deux partie. A gauche, le panneau pour la navigation rapide.
Elle est divisée en deux parties. A gauche, le panneau pour la navigation rapide.
Il permet d'accéder à l'ensemble des actions. A droite, la table qui contiens
les publications.
......@@ -131,7 +133,7 @@ de cliquer sur le bouton ``créer``. La plublication est alors ajoutée dans la
base de données. PLus de détails sont donnés dans le chapite :ref:`enter_publication`.
.. note::
Les champs marqués par une étoile sont obligatoire. Si ils ne sont pas
Les champs marqués par une étoile sont obligatoire. S'ils ne sont pas
tous saisis, l'action n'est pas possible, elle reste dans l'état *griser*.
.. note::
......@@ -163,7 +165,7 @@ pays, les publications et les revues.
Pour voir le contenu de chaque table cliquez sur le nom de l'action. La table
apparait dans le panneau de droite
dans un nouvelle onglet. Son menu contextuel permet de faire évoluer le contenu
dans un nouvel onglet. Son menu contextuel permet de faire évoluer le contenu
de la table.
.. _fig-block-publication:
......@@ -184,7 +186,7 @@ de la table.
Besoin d'aide
^^^^^^^^^^^^^
Un forum utilisateurs a été mis en place à l'adresse suivante
Un forum utilisateur a été mis en place à l'adresse suivante
https://forge.in2p3.fr/projects/track_publications. Il permet
aussi de faire remonter d'éventuel bogues ainsi que des suggestions
d'amélioration.
......@@ -3,7 +3,7 @@
Les moissonneurs
----------------
Pour les domaines scientifique de l'IN2P3, les publications sont principalement
Pour les domaines scientifiques de l'IN2P3, les publications sont principalement
archivées dans les entrepôts `cds.cern.ch`_ et `inspirehep.net`_.
Comme ces archives sont organisées en collections, il est relativement aisé de
trouver toutes les publications d'une certaine catégorie pour une
......@@ -22,7 +22,7 @@ et comment les exécuter.
Les étapes d'un moissonnage
^^^^^^^^^^^^^^^^^^^^^^^^^^^
L'automate logiciel, ou *moissonneur*, pose toujours la même question. Il demande
à l'entrepôt de lui donné toutes les publications d'une certain catégorie,
à l'entrepôt de lui donner toutes les publications d'une certaine catégorie,
pour un projet (collaboration), pour une année.
Dans la pratique cette requête est transmise à l'entrepôt en utilisant le
......@@ -50,13 +50,13 @@ Trois actions sont alors possible:
L'identifiant du laboratoire
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Afin de trouver dans les entrepôts, les publication signées par les membres
Afin de trouver dans les entrepôts, les publications signées par les membres
du laboratoire, il faut définir *l'identifiant* du laboratoire :
* A partir du panneau de navigation rapide, accéder à la table qui continent
les paramètres de configuration de l'application :
.. code-block:: c
::
Configure l'application > propriétés
......@@ -78,10 +78,10 @@ Définir un moissonneur
^^^^^^^^^^^^^^^^^^^^^^
Un moissonneur est affecté à chaque couple (``équipe``, ``projet``) pour chaque
catégorie de publication définit par la paire de variables (``catégorie``, ``code``)
Ici, la variable catégorie est très similaire à celle définit dans le chapitre
Ici, la variable catégorie est très similaire à celle définie dans le chapitre
:ref:`categories`, mais corresponds en faite à l’automate logiciel qui va
analyser les données. C'est pourquoi leurs noms sont en anglais.
Les automates logiciels sont au nombres de sept :
Les automates logiciels sont au nombre de sept :
* ``articles``
* ``notes``
......@@ -94,7 +94,7 @@ Les automates logiciels sont au nombres de sept :
La configuration des moissonneurs est accessible à partir
du panneau de navigation rapide, en suivant le chemin :
.. code-block:: c
::
Configurer les moissonneurs > moissonneurs
......@@ -118,46 +118,50 @@ Il a sept champs :
* **entrepôt**
choisir un entrepôt
* **collections**
ce champs définit la(es) collection(s) de l'entrepôt qui vont être
ce champ définit la(es) collection(s) de l'entrepôt qui vont être
scannée(s). Dans le cas de `cds.cern.ch`_, c'est effectivement le nom
d'une collection comme::
d'une collection comme : ::
LHCb Papers
Dans le cas de `inspirehep.net`_
c'est un peu plus compliqué car les collections par expérience ne sont
pas définies explicitement. La valeur est donc égale au
critère de recherche. Par exemple::
critère de recherche. Par exemple : ::
find cn d0 and tc p and not tc
sélectionne les articles publiés par la collaboration D0.
* **ratio**
paramètre historique qui devrait disparaître dans la version 0.9.
Laisser le à la valeur ``1``
* **code**
c'est le code AERES. Il dépend du choix de l'automate logiciel.
* **scan**
le moissonneur sera exécuté lors d'un moissonage automatique
le moissonneur sera exécuté lors d'un moissonnage automatique
quand cette valeur est coché
Les configuration existantes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Les configurations existantes et éprouvées sont les suivantes :
Les configurations existantes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Les configurations existantes et éprouvées sont données dans
la :numref:`Table %s <table-harvesters>`.
.. _table-harvesters:
.. csv-table::
:file: csv/harvesters.csv
:widths: 10 10 10 30 10
.. table:: Les configurations existantes des moissonneurs.
.. csv-table::
:file: csv/harvesters.csv
:widths: 10 10 10 30 10
Exécuter un moissonneur
^^^^^^^^^^^^^^^^^^^^^^^
Pour exécuter un moissonneur, démarrer l'action :
.. code-block:: c
::
Moissonner > exécuter un moissonneurs
Moissonner > exécuter un moissonneur
Le panneau de droite est maintenant divisé en deux partie comme le montre la
Le panneau de droite est maintenant divisé en deux parties comme le montre la
:numref:`fig-home-harvester`.
.. _fig-home-harvester:
......@@ -169,7 +173,7 @@ Le panneau de droite est maintenant divisé en deux partie comme le montre la
Exécuter un moissonneur.
La *Selector*, à droite, permet de définir les paramètres spécifiques à
cette exécution. Il comprends cinq champs :
cette exécution. Il comprend cinq champs :
* **Année**
une année quand le premier champ est défini, une période couvrant
......@@ -185,7 +189,7 @@ cette exécution. Il comprends cinq champs :
Pour lancer le moissonnage cliquer sur le bouton ``Go``
Après un certain temps, parfois plusieurs minutes, le conte rendu du moissonnage
Après un certain temps, parfois plusieurs minutes, le compte rendu du moissonnage
apparait sur le panneau central.
.. note::
......@@ -202,15 +206,15 @@ Un exemple est montré sur la :numref:`fig-report-harvester`.
:align: center
:width: 90%
Conte rendu d'exécution un moissonneur. Dans cet exemple, l'utilisateur
Compte rendu d'exécution un moissonneur. Dans cet exemple, l'utilisateur
cherchait les articles de la collaboration LHCb publiés en 2015.
Le rapport est composé de deux tables. La première est un résumé de ce qui s'est
passé par collection. Sont notamment listé le nombre d'enregistrements trouvés
dans l'entrepôt, le nombre d'enregistrement existants et ajoutés dans la base de
données, le nombre d'enregistrement rejeté.
dans l'entrepôt, le nombre d'enregistrements existants et ajoutés dans la base de
données, le nombre d'enregistrements rejeté.
La seconde table regroupe les enregistrement trouvés dans l'entrepôt par action.
La seconde table regroupe les enregistrements trouvés dans l'entrepôt par action.
Les détails, montrés sur la :numref:`fig-detail-harvester`, sont visible en cliquant
sur le titre de l'action.
Les titres des publications apparaissent. Ce sont des hyperliens qui pointent
......@@ -227,7 +231,7 @@ sur la fiche dans l'entrepôt.
Parfois, un enregistrement rejeté par un moissonneur peu être corrigé par
l'utilisateur puis insérer dans la base. Pour lancer cette opération, lancer le
menu contextuelle sur le titre choisit. Le menu ``éditer et insérer`` apparait,
menu contextuel sur le titre choisit. Le menu ``éditer et insérer`` apparait,
comme le montre la :numref:`fig-edit-insert-harvester`. Il donne accès au
formulaire de saisi d'un publication, remplit avec toutes les informations qui
sont disponibles dans l'entrepôt.
......@@ -249,7 +253,7 @@ possèdent un identificateur unique, par exemple :
* http://cds.cern.ch/record/1951625
* http://inspirehep.net/record/1319638
Ces hyperliens sont composé de l'adresse de l'entrepôt et d'un identifiant numérique.
Ces hyperliens sont composés de l'adresse de l'entrepôt et d'un identifiant numérique.
Ils pointent sur les fiches dans les entrepôts. Ils sont stockés
dans la base de donnée dans le champ ``origine``, pour chaque publication
trouvée par un moissonneur. Sa valeur est visible
......@@ -260,7 +264,7 @@ dans le formulaire de saisi d'un publication via l'onglet *Méta*.