lists.rst

.. include:: hyperlinks.txt


Les listes
-----------

Un des buts de cette application et de produire des listes dans
lesquelles les publications sont ordonnées selon différents critères comme
l'année, les catégories, les équipes, les projets, *etc*. Un exemple de
liste est montré sur la :numref:`fig-out-lists`.

    .. _fig-out-lists:

    .. figure:: images/out-lists.png
       :align: center
       :width: 90%

       La liste des articles pour l'équipe *Astronomie neutrino et gamma*
       en 2015.


Par défaut, les neuf listes de la :numref:`table-lists` ont été implémentées.

    .. tabularcolumns:: p{6cm}p{8cm}

    .. _table-lists:

    .. table:: Les listes implémentées par défaut.

        +--------------------------------------+-------------------------------------------+
        | *catégorie AERES / année*            | les publications sont ordonnées par       |
        |                                      | catégorie AERES puis pour chaque catégorie|
        |                                      | par année.                                |
        +--------------------------------------+-------------------------------------------+
        | *catégorie AERES / projet / année*   | les publications sont ordonnées par       |
        |                                      | catégorie AERES puis pour chaque catégorie|
        |                                      | par projet puis pour chaque projet par    |
        |                                      | année.                                    |
        +--------------------------------------+-------------------------------------------+
        | *catégorie usuelle / année*          |                                           |
        +--------------------------------------+-------------------------------------------+
        | *catégorie usuelle / équipe / année* |                                           |
        +--------------------------------------+-------------------------------------------+
        | *catégorie usuelle / projet / année* |                                           |
        +--------------------------------------+-------------------------------------------+
        | *CRAC*                               | format adapté pour remplir un CRAC        |
        +--------------------------------------+-------------------------------------------+
        | *EAOM*                               | liste utilisée pour les dialogues de      |
        |                                      | gestion. Elle est très similaire à la     |
        |                                      | liste *catégorie AERES / projet / année*  |
        +--------------------------------------+-------------------------------------------+
        | *HDR / équipe / année*               | la liste des Habilitations à Diriger les  |
        |                                      | Recherche par équipe puis par année       |
        +--------------------------------------+-------------------------------------------+
        | *PhD / équipe / année*               | la liste des Doctorats par équipe puis    |
        |                                      | par année                                 |
        +--------------------------------------+-------------------------------------------+


Exécuter une liste prédéfinie
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Pour fabriquer une liste, démarrer l'action :

    .. index::
        pair: Rapports; listes

    .. line-block::

        ``Rapports > listes``

Le panneau de droite est maintenant divisé en deux parties comme le montre la
:numref:`fig-home-lists`.

    .. _fig-home-lists:

    .. figure:: images/home-lists.png
       :align: center
       :width: 90%

       Fabriquer une liste.

La *Selector*, à droite, permet de définir les paramètres spécifiques à
cette exécution. Il comprend sept conditions :

    * **Année**
        la liste est réduite aux enregistrements publiés dans l'année,
        quand le premier champ est défini, ou pendant une période couvrant
        plusieurs années, quand les deux champs sont définis.
    * **Equipe**
        la liste est réduite aux enregistrements appartenant à l'équipe.
    * **Projet**
        la liste est réduite aux enregistrements appartenant au projet.
    * **Catégorie**
        la liste est réduite aux enregistrements appartenant à une catégorie.
    * **Auteur**
        la liste est réduite aux enregistrements pour lesquels le champ
        auteur contient la valeur spécifiée.
    * **Liste**
        la liste prédéfinie que l'on veut fabriquer.
    * **Format**
        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
^^^^^^^^^^^^^^^

Une liste est composée de trois éléments qui sont imbriqués les uns dans les
autres :

    #. **moteur de rendu**
        est un patron qui définit comment utiliser les champs de la base de
        données pour représenter une référence bibliographique
    #. **section**
        associe une catégorie de publications avec un moteur de rendu
    #. **la liste elle-même**
         qui est un ensemble ordonné de sections

Les actions :

    .. index::
        pair: Configurer les listes; moteurs de rendu

    .. index::
        pair: Configurer les listes; sections

    .. index::
        pair: Configurer les listes; listes

    .. line-block::

        ``Configurer les listes > moteurs de rendu``
        ``Configurer les listes > sections``
        ``Configurer les listes > listes``

créent ou modifient ces éléments.

Moteur de rendu
^^^^^^^^^^^^^^^

    .. _fig-form-renderers:

    .. figure:: images/form-renderers.png
       :align: center
       :width: 50%

       Le formulaire pour créer un nouveau moteur de rendu.

Le formulaire de saisie d'un moteur de rendu est montré sur la
:numref:`fig-form-renderers`. Il est composé de quatre champs :

    * **moteur de rendu**
        le nom du moteur
    * **Patron**
        par exemple pour des articles publiés :

            .. line-block::

                {``publications.title``}, {``publications.first_author``} et al.,
                {``collaborations.collaboration``}, {``publishers.abbreviation``}
                {``publications.volume``} ({``publications.year``}) {``publications.pages``}

        Dans cette construction, les champs de la base de données sont entre
        pair de crocher ``{...}`` et séparés les uns des autres par des caractères
        alphanumérique.
        Les champs de la base de données sont définis par le nom de la table
        et par le nom du champ. Les valeurs possibles sont explicitées dans
        l'annexe :ref:`dbfields`.

    * **Post-processing**
        Quand la référence bibliographique est construite il est possible de la
        polir. Quatre fonctions sont disponibles :

            .. tabularcolumns:: Lp{7cm}

            +--------------------------+-----------------------------------------------+
            | ``clean``                | nettoie les espaces et les virgules           |
            +--------------------------+-----------------------------------------------+
            | ``highlight_my_authors`` | les auteurs du laboratoire sont sous-lignés   |
            +--------------------------+-----------------------------------------------+
            | ``highlight_my_speaker`` |l'orateur, membre du laboratoire, est en gras, |
            |                          |les signataires du laboratoire soulignés       |
            +--------------------------+-----------------------------------------------+
            | ``remove_undef``         | enlève le terme *indéfini*                    |
            +--------------------------+-----------------------------------------------+

    * **Defintion**


Section
^^^^^^^
Une section contient les publications d'une certaines catégories. Elles seront
représentées par une référence bibliographique construire par un moteur de rendu
et triées selon certains critères.

    .. _fig-form-sections:

    .. figure:: images/form-sections.png
       :align: center
       :width: 50%

       Le formulaire pour créer une nouvelle section.

Le formulaire de saisie d'une section est montré sur la
:numref:`fig-form-sections`. Il est composé de six champs :

    * **Section**
        le nom de la section.
    * **Moteur de rendu**
        le moteur de rendu attaché à cette section.
    * **Code des catégories**
        le(s) code AERES des publications, séparés par une virgule.
    * **Conditions**
        opérations logiques, appliquées uniquement sur les champs de la table
        ``publications``, écrite en langage naturel.
    * **Trier par**
        ordonne les publications à partir des valeurs du champ spécifié.
        Il doit appartenir à la table ``publications``.
    * **Définition**

Liste
^^^^^
Une liste est une collection de sections dans lesquelles les publications
son organisé selon une arborescence. Par exemple :

    .. line-block::

        ``section``
            ``année``
                ``publications``

ou

    .. line-block::

        ``section``
            ``équipe``
                ``année``
                    ``publications``


L'arborescence est construite à partir des informations
sur les catégories, les équipes, les pays, les projets, les revues, les status
et le temps (année). Le nombre de niveaux est limité à quatre.

    .. _fig-form-lists:

    .. figure:: images/form-lists.png
       :align: center
       :width: 50%

       Le formulaire pour créer une nouvelle list.

Le formulaire de saisie, pour créer une nouvelle liste, est montré sur
la :numref:`fig-form-lists`. Il comprend cinq onglets :

Les variables les plus importantes, pour définir une liste, sont :

    * **Général**
        le nom et la définition de la liste
    * **Sections**
        une liste de noms de section séparé par une virgule
    * **Trié par**
        définit l'arborescence.
    * **Substitution**
    * **Header/Footer**