Commit a98c03d1 authored by Daniel Berthereau's avatar Daniel Berthereau
Browse files

Updated readme.

parent c2aac9d8
......@@ -3,7 +3,7 @@ Rameau (module pour Omeka S)
> __Les nouvelles versions de ce module et l’assistance pour Omeka S version 3.0
> et supérieur sont disponibles sur [GitLab], qui semble mieux respecter les
> utilisateurs et la vie privée.__
> utilisateurs et la vie privée que le précédent entrepôt.__
See [English readme].
......@@ -88,31 +88,44 @@ type de données d’une propriété d’un modèle de ressources.
### Solr
Pour inclure la liste des synonymes avec Solr, copiez le fichier "files/rameau/data/synonyms_fr.txt"
dans la configuration de votre nœud Solr, ou remplacez le fichier par défaut
"synonyms.txt" :
Pour inclure la liste des synonymes avec Solr, remplacez le fichier par défaut
"synonyms.txt" par le fichier "files/rameau/data/synonyms_fr.txt" si le fichier
des synonymes français n’existe pas dans la configuration Solr, sinon remplacez
ce dernier :
```sh
sudo cp files/rameau/data/synonyms_fr.txt /var/solr/data/omeka/conf/lang/
sudo chown solr:sor /var/solr/data/omeka/conf/lang/synonyms_fr.txt
sudo cp files/rameau/data/synonyms_fr.txt /var/solr/data/omeka/conf/synonyms.txt
sudo chown solr:solr /var/solr/data/omeka/conf/synonyms.txt
sudo chmod 0664 /var/solr/data/omeka/conf/synonyms.txt
```
ou
```sh
sudo cp files/rameau/data/synonyms_fr.txt /var/solr/data/omeka/conf/lang/synonyms_fr.txt
sudo chown solr:solr /var/solr/data/omeka/conf/lang/synonyms_fr.txt
sudo chmod 0664 /var/solr/data/omeka/conf/lang/synonyms_fr.txt
```
Puis vérifiez votre schéma. Une configuration fonctionnelle pour interroger par
sujet peut être, avec un seul fichier :
Si vous remplacez le fichier des synonymes par défaut, la configuration devrait
fonctionner automatiquement.
Il est également possible d’utiliser la liste séparément, par exemple pour une
interrogation directe par sujet :
```xml
<fieldType name="rameau" class="solr.TextField" autoGeneratePhraseQueries="true" positionIncrementGap="100">
<analyzer type="index">
<tokenizer class="solr.KeywordTokenizerFactory"/>
<filter class="solr.SynonymGraphFilterFactory" expand="false" ignoreCase="false" synonyms="lang/synonyms_fr.label_uri.txt" tokenizerFactory="solr.KeywordTokenizerFactory"/>
<filter class="solr.SynonymGraphFilterFactory" expand="false" ignoreCase="true" synonyms="lang/synonyms_fr.txt" tokenizerFactory="solr.KeywordTokenizerFactory"/>
<filter class="solr.FlattenGraphFilterFactory"/>
</analyzer>
<analyzer type="query">
<tokenizer class="solr.KeywordTokenizerFactory"/>
<filter class="solr.SynonymGraphFilterFactory" expand="false" ignoreCase="false" synonyms="lang/synonyms_fr.label_uri.txt" tokenizerFactory="solr.KeywordTokenizerFactory"/>
<filter class="solr.SynonymGraphFilterFactory" expand="false" ignoreCase="true" synonyms="lang/synonyms_fr.txt" tokenizerFactory="solr.KeywordTokenizerFactory"/>
</analyzer>
</fieldType>
<dynamicField name="*_rameau" type="rameau" indexed="true" stored="true"/>
<dynamicField name="*_rameau" type="rameau" stored="true" indexed="true"/>
<dynamicField name="*_rameaux" type="rameau" stored="true" indexed="true" multiValued="true"/>
```
Après enregistrement, redémarrer Solr et **patientez quelques minutes** le temps
......@@ -235,6 +248,7 @@ TODO
- [ ] Utiliser XmlReader pour la création des fichiers de skos pour éviter Saxon.
- [ ] Créer une sortie pour la [gestion automatique des synonymes](https://lucene.apache.org/solr/guide/8_7/filter-descriptions.html#managed-synonym-graph-filter) dans Solr.
- [ ] Ne mettre dans le fichier des synonymes que les synonymes présents dans la base (et la mettre à jour via la gestion automatique des synonymes).
- [ ] Créer l’arborescence Rameau ou intégrer un autre outil de thésaurus.
......@@ -282,8 +296,8 @@ utilisateurs sont donc encouragés à charger et à tester l’adéquation du lo
systèmes et/ou de leurs données et, plus généralement, à l’utiliser et à
l’exploiter dans les mêmes conditions en matière de sécurité.
Le fait que vous lisez actuellement ce document signifie que vous avez eu des
connaissances de la licence CeCILL et que vous en acceptez les termes.
Le fait que vous lisez actuellement ce document signifie que vous avez pris
connaissance de la licence CeCILL et que vous en acceptez les termes.
Voir [ci-dessus] pour la licence du vocabulaire.
......@@ -304,6 +318,7 @@ de l’Université des Antilles et Université de la Guyane, actuellement géré
[RAMEAU]: http://rameau.bnf.fr
[Log]: https://gitlab.com/Daniel-KM/Omeka-S-module-Log
[Value Suggest]: https://github.com/omeka-s-modules/ValueSuggest
[Search Solr]: https://gitlab.com/Daniel-KM/Omeka-S-module-SearchSolr
[Licence ouverte]: https://www.etalab.gouv.fr/licence-ouverte-open-licence
[Etalab]: https://www.etalab.gouv.fr
[ici]: https://www.bnf.fr/sites/default/files/2018-11/metadonnees_bnf_cond_utilisation.pdf
......
......@@ -2,7 +2,8 @@ Rameau (module for Omeka S)
===========================
> __New versions of this module and support for Omeka S version 3.0 and above
> are available on [GitLab], which seems to respect users and privacy better.__
> are available on [GitLab], which seems to respect users and privacy better
> than previous repository.__
Voir le [lisez-moi] en français.
......@@ -85,30 +86,41 @@ property of a resource template.
### Solr
To include the list of synonyms with Solr, copy the file "files/rameau/data/synonyms_fr.txt"
into your Solr node config, or replace the default file "synonyms.txt":
To include the list of synonyms with Solr, replace the default file
"synonyms.txt" by the file "files/rameau/data/synonyms_fr.txt" if the file for
French synonyms does not exists in the Solr config, else replace the latter:
```sh
sudo cp files/rameau/data/synonyms_fr.txt /var/solr/data/omeka/conf/lang/
sudo chown solr:sor /var/solr/data/omeka/conf/lang/synonyms_fr.txt
sudo cp files/rameau/data/synonyms_fr.txt /var/solr/data/omeka/conf/synonyms.txt
sudo chown solr:solr /var/solr/data/omeka/conf/synonyms.txt
sudo chmod 0664 /var/solr/data/omeka/conf/synonyms.txt
```
or
```sh
sudo cp files/rameau/data/synonyms_fr.txt /var/solr/data/omeka/conf/lang/synonyms_fr.txt
sudo chown solr:solr /var/solr/data/omeka/conf/lang/synonyms_fr.txt
sudo chmod 0664 /var/solr/data/omeka/conf/lang/synonyms_fr.txt
```
Then, check your schema. A working config to request by subject may be, with one
file:
If you replace the default synonyms file, the config would run automatically.
The list can be used separately too, for exemple for a direct request by subject:
```xml
<fieldType name="rameau" class="solr.TextField" autoGeneratePhraseQueries="true" positionIncrementGap="100">
<analyzer type="index">
<tokenizer class="solr.KeywordTokenizerFactory"/>
<filter class="solr.SynonymGraphFilterFactory" expand="false" ignoreCase="false" synonyms="lang/synonyms_fr.label_uri.txt" tokenizerFactory="solr.KeywordTokenizerFactory"/>
<filter class="solr.SynonymGraphFilterFactory" expand="false" ignoreCase="true" synonyms="lang/synonyms_fr.txt" tokenizerFactory="solr.KeywordTokenizerFactory"/>
<filter class="solr.FlattenGraphFilterFactory"/>
</analyzer>
<analyzer type="query">
<tokenizer class="solr.KeywordTokenizerFactory"/>
<filter class="solr.SynonymGraphFilterFactory" expand="false" ignoreCase="false" synonyms="lang/synonyms_fr.label_uri.txt" tokenizerFactory="solr.KeywordTokenizerFactory"/>
<filter class="solr.SynonymGraphFilterFactory" expand="false" ignoreCase="true" synonyms="lang/synonyms_fr.txt" tokenizerFactory="solr.KeywordTokenizerFactory"/>
</analyzer>
</fieldType>
<dynamicField name="*_rameau" type="rameau" indexed="true" stored="true"/>
<dynamicField name="*_rameau" type="rameau" stored="true" indexed="true"/>
<dynamicField name="*_rameaux" type="rameau" stored="true" indexed="true" multiValued="true"/>
```
After saving, restart Solr and **wait some minutes** for Solr to load the list
......@@ -226,6 +238,7 @@ TODO
- [ ] Use XmlReader for the creation of the skos files to avoid Saxon.
- [ ] Create an output for the [automatically managed synonyms](https://lucene.apache.org/solr/guide/8_7/filter-descriptions.html#managed-synonym-graph-filter) in Solr.
- [ ] FIll in synonyms file only the synonymes that are present in the database (and update it via the automatic management of synonyms).
- [ ] Create the Rameau hierarchic tree or integrate another thesaurus tool.
......@@ -292,6 +305,7 @@ Université des Antilles and Université de la Guyane, currently managed with
[RAMEAU]: http://rameau.bnf.fr
[Log]: https://gitlab.com/Daniel-KM/Omeka-S-module-Log
[Value Suggest]: https://github.com/omeka-s-modules/ValueSuggest
[Search Solr]: https://gitlab.com/Daniel-KM/Omeka-S-module-SearchSolr
[Open License]: https://www.etalab.gouv.fr/licence-ouverte-open-licence
[Etalab]: https://www.etalab.gouv.fr
[here]: https://www.bnf.fr/sites/default/files/2018-11/metadonnees_bnf_cond_utilisation.pdf
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment