[PATCH 05 of 10 saem_ref] [doc] More content about skos and eac

Denis Laxalde denis.laxalde at logilab.fr
Tue Apr 11 09:13:58 CEST 2017


Sylvain Thenault a écrit :
> # HG changeset patch
> # User Sylvain Thénault <sylvain.thenault at logilab.fr>
> # Date 1491826635 -7200
> #      Mon Apr 10 14:17:15 2017 +0200
> # Node ID 45f72f19776612b2f7bcfeeafaee60bedeaf86d0
> # Parent  92d7b8ce532ccea55a93df088eb0b78acf5e8d13
> [doc] More content about skos and eac
>
> Notice eac was already referenced by the index but file wasn't in there.
>
> diff --git a/doc/eac.rst b/doc/eac.rst
> new file mode 100644
> --- /dev/null
> +++ b/doc/eac.rst
> @@ -0,0 +1,28 @@
> +=======
> +EAC-CPF
> +=======
> +
> +Le référentiel fournit une implémentation de EAC-CPF_ relativement complète. Les notices d'autorités
> +peuvent être créés ou importés directement dans l'interface web ou bien importés en ligne de
> +commande.
> +
> +.. section sur les balises supportées ou non
> +.. include:: ../../cubicweb-eac/doc/supported.rst

Meh. Couldn't we publish cubicweb-eac documentation on readthedocs and link
it here instead? Or find another way than relative path to include it if
possible.

> +
> +Import de notices d'autorités en ligne de commande
> +==================================================
> +
> +Pour importer un fichier EAC-CPF, vous pouvez utiliser la commande 'eac-import' de `cubicweb-ctl` :
> +
> +::
> +
> +    CW_MODE=user cubicweb-ctl eac-import saemref --authority <NAA name> fichier.rdf

I don't get why we need this CW_MODE=user everywhere?

> +
> +À moins qu'il n'y ait qu'une seul autorité de nommage définie dans votre référentiel, il vous faudra
> +spécifier le nom de l'autorité à utiliser avec l'option `--authority`. Si vous ne connaissez pas le
> +nom de votre autorité de nommage, lancer la commande sans l'option elle vous indiquera les valeurs
> +possibles.
> +
> +.. _EAC-CPF: http://eac.staatsbibliothek-berlin.de/
> \ No newline at end of file
> diff --git a/doc/index.rst b/doc/index.rst
> --- a/doc/index.rst
> +++ b/doc/index.rst
> @@ -8,9 +8,9 @@ SAEM-Ref - Guide de l'administrateur
>
>  .. toctree::
>     :maxdepth: 2
>
>     install
> -   web-services
> +   skos
>     eac
> -   skos
> +   web-services
>     ChangeLog_fr
> \ No newline at end of file
> diff --git a/doc/skos.rst b/doc/skos.rst
> --- a/doc/skos.rst
> +++ b/doc/skos.rst
> @@ -1,25 +1,48 @@
> -Import de thésaurus SKOS
> -========================
> +====
> +SKOS
> +====
> +
> +Le référentiel fournit une implémentation de SKOS_. Les thésaurus ou vocabulaires contrôlés peuvent
> +être créés ou importés directement dans l'interface web ou bien importés en ligne de commande.
> +
> +Notez qu'un vocabulaire importé peut être rattaché à une **source** ou non. L'intérêt de passer par
> +une source est que cette dernière permet de conserver l'URL d'origine du vocabulaire et ainsi de le
> +(re)synchroniser plus tard. De plus le vocabulaire et ses concepts sont identifiés comme provenant
> +de cette source.
> +
> +Dans l'interface web, le seul moyen accessible pour importer un vocabulaire est d'ajouter une
> +source. Si vous souhaitez importer un fichier SKOS directement, il faut utiliser l'import en ligne
> +de commande expliqué ci-dessous.

It seems to me that one can create a concept scheme and then import 
concepts from a file. Arguably, it's not the same as importing a concept 
scheme directly but quite similar.

> +
> +Import de thésaurus en ligne de commande
> +========================================
>
>  Lorsqu'il est lancé par l'interface web, l'import de thésaurus SKOS ne peut
>  utiliser les optimisations qui deviennent nécessaires dès que le thésaurus est
>  de taille conséquente (plus d'une centaine de concepts). En effet ces
>  optimisations nécessitent que l'import soit effectué sans que d'autres
>  connexions à la base de données soient actives (ce qui implique donc de stopper
>  le serveur web pendant ce temps).
>
> -Pour importer un fichier SKOS RDF sans que celui-ci soit rattaché à une source de données (cette
> -dernière permettant de conserver la source et donc de synchroniser les données plus tard), vous
> -pouvez utiliser la commande 'skos-import' : ::
> +Pour importer un fichier SKOS RDF sans que celui-ci soit rattaché à une source de données, vous
> +pouvez utiliser la commande 'skos-import' de `cubicweb-ctl` :
>
> -  cubicweb-ctl skos-import saem fichier.rdf
> +::
>
> +    CW_MODE=user cubicweb-ctl skos-import saemref fichier.rdf
>
>  Pour déclencher l'import initial ou la synchronisation de données SKOS RDF dont l'URL a été
>  spécifiée par l'ajout d'une source dans l'interface web, vous pouvez utiliser la commande
> -'source-sync' : ::
> +'source-sync' :
>
> -  cubicweb-ctl source-sync saem <nom de la source>
> +::
> +
> +    CW_MODE=user cubicweb-ctl source-sync saemref <nom de la source>
>
>  Ces deux exemples supposent que votre instance se nomme "saem" et que vous avez coupé l'interface

The instance name changed in examples ;)

> -web au préalable (``cubicweb-ctl stop saem``).
> +web au préalable (``cubicweb-ctl stop saemref`` ou ``supervisorctl stop saemref`` si votre instance est
> +supervisée).
> +
> +
> +.. _SKOS: https://fr.wikipedia.org/wiki/Simple_Knowledge_Organization_System
>



More information about the saem-devel mailing list