AR282 EN user doc is done

doc/user/EN/README.md

@@ -1,7 +1,5 @@
 # User documentation
 
-_Note : english documentation is not fully translated yet_
-
 * [How to install _Find and Compare Records_](./how_to_install.md)
 * [Input file documentation](./input_file.md)
 * [How to use _Find and Compare Records_](./how_to_use.md)

doc/user/EN/how_to_use.md

@@ -67,43 +67,43 @@ The _Save main processing configuration settings_ button is used to saved curren
 
 ![Processing configuration screen, mapping configuration tab](./img/UI_processing_conf_db_conf_tab.png)
 
-Cet onglet est le plus complexe mais également celui qui, une fois sauvegardée, n'a plus besoin d'être reconfiguré.
+This tab is the most complex one, but also the one who does not need to be reconfigured once it is saved.
 
-Il permet de configurer via une interface quelles données seront récupérées dans les notices bibliographiques (configurées dans le fichier `json_configs/marc_fields.json`).
-Pour plus d'informations sur comment configurer ces mappings, se référer à [la documentation sur l'extracteur de données universel](../../../doc/UDE.md).
+It is used to configure which data will be retrieved from records (graphic interface to configure `json_configs/marc_fields.json`).
+For more information on how to configure those mapping, see [universal data extractor docuemention](../../../doc/UDE.md).
 
-Dans un premier temps, il est nécessaire de sélectionner le mapping que l'on souhaite modifier.
-Il est possible de créer un nouveau mapping à l'aide du bouton _Sauvegarder ce mapping comme un nouveau_, qui copiera l'ensemble des données actuellement configurées pour le mapping actuellement sélectionné vers le nouveau.
-Le bouton ouvrira une boîte de dialogue vous demandant de renseigner le nom du nouveau mapping, il faudra ensuite valider avec `Ok` pour procéder à la sauvegarde.
+Firstly, you need to select which ampping to edit.
+It is possible to add a new mapping using the _Save this mpping as a new one_ button, which will copy the whole curent mapping under a new name.
+The button will open a dialog window asking for the name of the new mapping, which is saved using the _OK_ button.
 
-![Boîte de dialogue pour enregistrer le nouveau mapping](./img/UI_save_new_mapping.png)
+![Dialog window to save a new mapping](./img/UI_save_new_mapping.png)
 
-Dans un second temps, il est nécessaire de choisir la donnée à configurer.
-Il est possible de renommer cette donnée pour la langue actuelle avec le bouton _Renommer_.
-Le bouton ouvrira une boîte de dialogue vous demandant de renseigner le nouveau nom de la donnée, il faudra ensuite valider avec `Ok` pour procéder à la sauvegarde.
-Pour s'assurer de la donnée qui est en cours d'édition, entre parenthèses se trouve l'identifiant de la donnée.
+Secondly, you need to chose which data to configure.
+This data can be renammed for the current langauge using the _Rename_ button.
+The button will open a new dialog window asking for the new name, which then needs to be confirmed using the _OK_ button to save.
+To make sure which data is currently being renammed, its internal id is written between parenthesis.
 
-![Boîte de dialogue pour enregistrer le nouveau nom de la donnée](./img/UI_save_new_data_name.png)
+![Dialog window to save the data rename](./img/UI_save_new_data_name.png)
 
-Dans un troisième temps, il est nécessaire de choisir le champ UNIMARC à configurer.
-Pour chaque champ, quatre données sont à remplir (ou non) :
+Thirdly, you need to chose a MARC field to configure.
+For each field, 4 data can be set up (or not) :
 
-* Est une donnée codée en une ligne : permet de déterminer si le champ est une donnée codée présente dans un seul sous-champ (exemple `100`)
-* Sous-champ filtre : permet de renseigner le sous-champ qui doit permettre d'exclure les champs non voulus (exemple : uniquement traiter les exemplaires de la bibliothèque renseignée)
-* Sous-champs à exporter : la liste des sous-champs à exporter, qui doivent être séparés par des virgules (les espaces entre les virgules ne sont pas pris en compte)
-* Positions à exporter :
-  * La liste des positions à exporter, qui doivent être séparées par des virgules (les espaces entre les virgules ne sont pas pris en compte)
-  * Cette information n'est utile que si le champ est déterminé comme étant une donnée codée en une seule ligne
-  * Pour extraire un caractère uniquement, renseigner sa position
-  * Pour extraire une chaîne de caractères, renseigner la première position à exporter et la dernière position à exporter, séparées par un tiret
+* Is single line coded data : is used if the field is a coded data in only one subfield (example : UNIMARC `100`)
+* Filtering subfield : is used to set up which subfield must be used to rule out unwanted fields (example : keeping only items for a library)
+* Subfields to export : the subfield list to export, separated with commas (spaces bewteen commas will be deleted)
+* Positions to export :
+  * Positions list to export, separated with commas (spaces bewteen commas will be deleted)
+  * This information is only used if the field is set as a single line coded data
+  * To extract only 1 character, write it's position
+  * Ro extract a strinf of characters, write the first position to export and the last position to export, separated by a dash
 
-Pour ajouter des nouveaux champs, sélectionner le champ `Ajouter un nouveau champ`, qui fera apparaître une nouvelle donnée à remplir à côté de lui.
-Renseignez dedans le numéro du champ voulu.
+To add new fields, select the field _Add new field_, which will make a new completable data appear next to it.
+Input the field tag in that new text input.
 
-![Configuration d'un nouveau champ](./img/UI_add_new_field.png)
+![New field configuration](./img/UI_add_new_field.png)
 
-Pour sauvegarder la modification effectuée sur le champ, cliquez sur le bouton _Sauvegarder ce champ MARC_.
-Cette opération est nécessaire __pour chaque champ__, sinon les données ne seront pas sauvegardées.
+To save a modification on a field, clic on the _Save this MARC field button_
+This operation is needed __for every field__, otherwise the modifications will not be saved.
 
 ### _Chose database mappings_ tab
 

doc/user/EN/input_file.md

@@ -1,24 +1,24 @@
 # Input file documentation
 
-Le fichier à traiter varie selon le traitement sélectionné :
+The input file changes depending on the processing :
 
-* [Suite `BETTER_ITEM`](#suite-better_item) (`BETTER_ITEM`, `BETTER_ITEM_DVD`, `BETTER_ITEM_NO_ISBN`, `BETTER_ITEM_MAPS`)
+* [`BETTER_ITEM` suite](#better_item-suite) (`BETTER_ITEM`, `BETTER_ITEM_DVD`, `BETTER_ITEM_NO_ISBN`, `BETTER_ITEM_MAPS`)
 * [`MARC_FILE_IN_KOHA_SRU`](#marc_file_in_koha_sru)
 
-## Suite `BETTER_ITEM`
+## `BETTER_ITEM` suite
 
-Le fichier utilisé est un fichier de type CSV utilisant un `;` comme délimiteur.
+The file used is a CSV like, using `;` as separator.
 
-Celui-ci contient les informations d'un exemplaire, l'identifiant dans la base de donnée d'origine et (parfois) un identifiant pour certaines requêtes.
-Ce dernier identifiant est utilisé unisuement pour le traitement `BETTER_ITEM` et doit être un ISBN.
+This file contains informations about an item, the origin database identifier and (sometimes) an identifier used in some queries.
+This last identifer is only used in the `BETTER_ITEM` processing and must be an ISBN.
 
-Le fichier doit __forcément__ avoir comme :
+The file __has to__ have as :
 
-* Première colonne la colonne contenant l'identifiant pour les reqûetes (l'ISBN pour `BETTER_ITEM`, une colonne vide ou avec un autre donnée pour les autres)
-* Dernière colonne celle contenant l'identifiant de la base de donnée d'origine
+* First column the column using the identifier for queries (ISBN for `BETTER_ITEM`, empty columns or with another data for the other processings)
+* Last column is the one containing origin database identifier
 
-Toutes les colonnes du fichier seront exportées à la fin du fichier de sortie.
+Every column of the file will be exported at the end of the CSV export.
 
 ## `MARC_FILE_IN_KOHA_SRU`
 
-Le fichier utilisé est un simple fichier de notices en ISO 2709, contenant les exemplaires.
+File used is a simple records file in ISO 2709, containing items.

doc/user/EN/output_data.md

@@ -5,37 +5,37 @@ _Those who only are a simple extraction from the record are not listed here, ple
 
 |Internal Name|Column name (default)|Column name (`BETTER_ITEM`)|Data origin|
 |---|---|---|---|
-|`INPUT_QUERY`|_Requête originale_|_Requête originale_|Input file first column content for currently analysed row|
-|`ORIGIN_DB_INPUT_ID`|_ID fichier original_|_Biblionumber fichier original_|Input file last column content for currently analysed row, stripped of final spaces|
-|`ERROR`|_Erreur_|_Erreur_|Did an error occurred ?|
-|`ERROR_MSG`|_Message d'erreur_|_Message d'erreur_|If an error occured, the error message, sometimes with informations about the part of FCR that caused the error|
-|`GLOBAL_VALIDATION_RESULT`|_Validation globale_|_Validation globale_|[See file dedicated to the analysis](./analysis.md#analysis-results)|
-|`GLOBAL_VALIDATION_NB_SUCCESSFUL_CHECKS`|_Nombre de validations réussies_|_Nombre de validations réussies_|[See file dedicated to the analysis](./analysis.md#analysis-results)|
-|`GLOBAL_VALIDATION_TITLE_CHECK`|_Validation des titres_|_Validation des titres_|[See file dedicated to the analysis](./analysis.md#analysis-results)|
-|`GLOBAL_VALIDATION_PUBLISHER_CHECK`|_Validation des éditeurs_|_Validation des éditeurs_|[See file dedicated to the analysis](./analysis.md#analysis-results)|
-|`GLOBAL_VALIDATION_DATE_CHECK`|_Validation des dates_|_Validation des dates_|[See file dedicated to the analysis](./analysis.md#analysis-results)|
-|`MATCH_RECORDS_QUERY`|_Requête pour recherche de correspondances_|_Requête pour recherche de correspondances_|Query used|
-|`FCR_ACTION_USED`|_Action FCR utilisée_|_Action FCR utilisée_|Last action used (so the one who succeeded if records were found)|
-|`MATCH_RECORDS_NB_RESULTS`|_Nombre de correspondances_|_Nombre de PPN trouvés_|Number of records found|
-|`MATCH_RECORDS_RESULTS`|_IDs correspondants_|_PPN trouvés_|Identifiers of found records|
-|`MATCHED_ID`|_ID en cours de traitement_|_PPN en cours de traitement_|Identifier of the target database processed|
-|`TARGET_DB_NB_OTHER_ID`|_Nombre d'IDs d'autres bases de données BDD de destination_|_Nombre de biblionumbers dans Sudoc_|Number of other database identifiers found|
-|`IS_ORIGIN_ID_IN_TARGET_OTHER_DB_IDS`|_ID BDD d'origine compris dans les IDs d'auters bases de données BDD de destination ?_|_Biblionumber Koha dans le Sudoc ?_|Is the origin database identifier in the other database identifiers from the target database ?|
-|`TARGET_DB_HAS_ITEMS`|_Déjà des exemplaires dans BDD de destination ?_|_Déjà des exemplaires dans Sudoc ?_|Has the target database alerady items ?|
-|`ORIGIN_DB_TITLE_KEY`|_Clef de titre BDD d'origine_|_Clef de titre Koha_|Origin database title key (notably used in the analysis)|
-|`TARGET_DB_TITLE_KEY`|_Clef de titre BDD de destination_|_Clef de titre Sudoc_|Target database title key (notably used in the analysis)|
-|`ORIGIN_DB_CHOSEN_PUBLISHER`|_Clef d'éditeur choisi BDD d'origine_|_Clef d'éditeur choisi Koha_|Origin database chosen publisher key (notably used in the analysis)|
-|`TARGET_DB_CHOSEN_PUBLISHER`|_Clef d'éditeur choisi BDD de destination_|_Clef d'éditeur choisi Sudoc_|Trget database chosen publisher key (notably used in the analysis)|
-|`ORIGIN_DB_DATE_1`|_Date de publication 1 BDD d'origine_|_Date de publication 1 Koha_|First origin database general processing data date|
-|`TARGET_DB_DATE_1`|_Date de publication 1 BDD de destination_|_Date de publication 1 Sudoc_|First target database general processing data date|
-|`ORIGIN_DB_DATE_2`|_Date de publication 2 BDD d'origine_|_Date de publication 2 Koha_|Second origin database general processing data date|
-|`TARGET_DB_DATE_2`|_Date de publication 2 BDD de destination_|_Date de publication 2 Sudoc_|Second target database general processing data date|
-|`ORIGIN_DB_PUBLICATION_DATES`|_Dates de publication BDD d'origine_|_Dates de publication Koha_|All 4 number long strings found in data extracted as publication date in the origin database record|
-|`TARGET_DB_PUBLICATION_DATES`|_Dates de publication BDD de destination_|_Dates de publication Sudoc_|All 4 number long strings found in data extracted as publication date in the target database record|
-|`ORIGIN_DB_PHYSICAL_DESCRIPTION`|__Is not computed in default behaviour__|_Description physique Koha_|Specific to `BETTER_ITEM` suite (as a cumpoted data), all 4 number long strings found in data extracted as physical description in the origin database record|
-|`MATCHING_TITLE_RATIO`|_Score de similarité des titres_|_Score de similarité des titres_|Title simple ratio|
-|`MATCHING_TITLE_PARTIAL_RATIO`|_Score d'appartenance des titres_|_Score d'appartenance des titres_|Title partial ratio|
-|`MATCHING_TITLE_TOKEN_SORT_RATIO`|_Score d'inversion des titres_|_Score d'inversion des titres_|Title token sort ratio|
-|`MATCHING_TITLE_TOKEN_SET_RATIO`|_Score d'inversion appartenance des titres_|_Score d'inversion appartenance des titres_|Title token set ratio|
-|`MATCHING_DATES_RESULT`|_Correspondance des dates de publications_|_Correspondance des dates de publications_|[See file dedicated to the analysis](./analysis.md#analysis-results)|
-|`MATCHING_PUBLISHER_RESULT`|_Score de similarité des éditeurs choisis_|_Score de similarité des éditeurs choisis_|Chosen publishers simple ratio|
+|`INPUT_QUERY`|_Input query_|_Input query_|Input file first column content for currently analysed row|
+|`ORIGIN_DB_INPUT_ID`|_Original file ID_|_Original file biblionumber_|Input file last column content for currently analysed row, stripped of final spaces|
+|`ERROR`|_Error_|_Error_|Did an error occurred ?|
+|`ERROR_MSG`|_Error message_|_Error message_|If an error occured, the error message, sometimes with informations about the part of FCR that caused the error|
+|`GLOBAL_VALIDATION_RESULT`|_Global validation result_|_Global validation result_|[See file dedicated to the analysis](./analysis.md#analysis-results)|
+|`GLOBAL_VALIDATION_NB_SUCCESSFUL_CHECKS`|_Number of successful checks_|_Number of successful checks_|[See file dedicated to the analysis](./analysis.md#analysis-results)|
+|`GLOBAL_VALIDATION_TITLE_CHECK`|_Title check_|_Title check_|[See file dedicated to the analysis](./analysis.md#analysis-results)|
+|`GLOBAL_VALIDATION_PUBLISHER_CHECK`|_Publishers check_|_Publishers check_|[See file dedicated to the analysis](./analysis.md#analysis-results)|
+|`GLOBAL_VALIDATION_DATE_CHECK`|_Dates check_|_Dates check_|[See file dedicated to the analysis](./analysis.md#analysis-results)|
+|`MATCH_RECORDS_QUERY`|_Query used to match records_|_Query used to match records_|Query used|
+|`FCR_ACTION_USED`|_FCR action used_|_FCR action used_|Last action used (so the one who succeeded if records were found)|
+|`MATCH_RECORDS_NB_RESULTS`|_Number of matches_|_Number of found PPN_|Number of records found|
+|`MATCH_RECORDS_RESULTS`|_Matched IDs_|_Matched PPN_|Identifiers of found records|
+|`MATCHED_ID`|_Current ID_|_Current PPN_|Identifier of the target database processed|
+|`TARGET_DB_NB_OTHER_ID`|_Number of IDs in other databases target DB_|_Number of biblionumbers in Sudoc_|Number of other database identifiers found|
+|`IS_ORIGIN_ID_IN_TARGET_OTHER_DB_IDS`|_Is origin DB ID in target DB IDs in other databases ?_|_Koha biblionumber in Sudoc ?_|Is the origin database identifier in the other database identifiers from the target database ?|
+|`TARGET_DB_HAS_ITEMS`|_Already items in target DB ?_|_Already items in Sudoc ?_|Has the target database alerady items ?|
+|`ORIGIN_DB_TITLE_KEY`|_Title key origin DB_|_Title key Koha_|Origin database title key (notably used in the analysis)|
+|`TARGET_DB_TITLE_KEY`|_Title key target DB_|_Title key Sudoc_|Target database title key (notably used in the analysis)|
+|`ORIGIN_DB_CHOSEN_PUBLISHER`|_Chosen publisher key origin DB_|_Chosen publisher key Koha_|Origin database chosen publisher key (notably used in the analysis)|
+|`TARGET_DB_CHOSEN_PUBLISHER`|_Chosen publisher key target DB_|_Chosen publisher key Sudoc_|Trget database chosen publisher key (notably used in the analysis)|
+|`ORIGIN_DB_DATE_1`|_Publication date 1 origin DB_|_Publication date 1 Koha_|First origin database general processing data date|
+|`TARGET_DB_DATE_1`|_Publication date 1 target DB_|_Publication date 1 Sudoc_|First target database general processing data date|
+|`ORIGIN_DB_DATE_2`|_Publication date 2 origin DB_|_Publication date 2 Koha_|Second origin database general processing data date|
+|`TARGET_DB_DATE_2`|_Publication date 2 target DB_|_Publication date 2 Sudoc_|Second target database general processing data date|
+|`ORIGIN_DB_PUBLICATION_DATES`|_Publication dates origin DB_|_Publication dates Koha_|All 4 number long strings found in data extracted as publication date in the origin database record|
+|`TARGET_DB_PUBLICATION_DATES`|_Publication dates target DB_|_Publication dates Sudoc_|All 4 number long strings found in data extracted as publication date in the target database record|
+|`ORIGIN_DB_PHYSICAL_DESCRIPTION`|__Is not computed in default behaviour__|_Physical description Koha_|Specific to `BETTER_ITEM` suite (as a cumpoted data), all 4 number long strings found in data extracted as physical description in the origin database record|
+|`MATCHING_TITLE_RATIO`|_Matching title ratio_|_Matching title ratio_|Title simple ratio|
+|`MATCHING_TITLE_PARTIAL_RATIO`|_Matching title partial ratio_|_Matching title partial ratio_|Title partial ratio|
+|`MATCHING_TITLE_TOKEN_SORT_RATIO`|_Matching title token sort ratio_|_Matching title token sort ratio_|Title token sort ratio|
+|`MATCHING_TITLE_TOKEN_SET_RATIO`|_Matching title token set ratio_|_Matching title token set ratio_|Title token set ratio|
+|`MATCHING_DATES_RESULT`|_Matching dates result_|_Matching dates result_|[See file dedicated to the analysis](./analysis.md#analysis-results)|
+|`MATCHING_PUBLISHER_RESULT`|_Matching publishers result_|_Matching publishers result_|Chosen publishers simple ratio|

doc/user/FR/input_file.md

@@ -10,11 +10,11 @@ Le fichier à traiter varie selon le traitement sélectionné :
 Le fichier utilisé est un fichier de type CSV utilisant un `;` comme délimiteur.
 
 Celui-ci contient les informations d'un exemplaire, l'identifiant dans la base de donnée d'origine et (parfois) un identifiant pour certaines requêtes.
-Ce dernier identifiant est utilisé unisuement pour le traitement `BETTER_ITEM` et doit être un ISBN.
+Ce dernier identifiant est utilisé uniquement pour le traitement `BETTER_ITEM` et doit être un ISBN.
 
 Le fichier doit __forcément__ avoir comme :
 
-* Première colonne la colonne contenant l'identifiant pour les reqûetes (l'ISBN pour `BETTER_ITEM`, une colonne vide ou avec un autre donnée pour les autres)
+* Première colonne la colonne contenant l'identifiant pour les requêtes (l'ISBN pour `BETTER_ITEM`, une colonne vide ou avec un autre donnée pour les autres)
 * Dernière colonne celle contenant l'identifiant de la base de donnée d'origine
 
 Toutes les colonnes du fichier seront exportées à la fin du fichier de sortie.