Author: jcouteau Date: 2011-02-08 17:19:43 +0000 (Tue, 08 Feb 2011) New Revision: 716 Log: First doc trnaslmation to english Modified: trunk/ trunk/coser-business/ trunk/coser-ui/ trunk/coser-web/ trunk/src/site/rst/en/user/configuration.rst trunk/src/site/rst/en/user/controls.rst trunk/src/site/rst/en/user/faq.rst trunk/src/site/rst/en/user/guide_control.rst trunk/src/site/rst/en/user/guide_listcontrols.rst Property changes on: trunk ___________________________________________________________________ Modified: svn:ignore - .settings .project target + .settings .project target *.iml *.ipr *.iws Property changes on: trunk/coser-business ___________________________________________________________________ Modified: svn:ignore - .classpath .project .settings target + .classpath .project .settings target *.iws *.ipr *.iml Property changes on: trunk/coser-ui ___________________________________________________________________ Modified: svn:ignore - .settings target bin .classpath + .settings target bin .classpath *.ipr *.iml *.iws Property changes on: trunk/coser-web ___________________________________________________________________ Modified: svn:ignore - .settings target .classpath .project + .settings target .classpath .project *.ipr *.iml *.iws Modified: trunk/src/site/rst/en/user/configuration.rst =================================================================== --- trunk/src/site/rst/en/user/configuration.rst 2011-02-08 16:51:05 UTC (rev 715) +++ trunk/src/site/rst/en/user/configuration.rst 2011-02-08 17:19:43 UTC (rev 716) @@ -25,8 +25,8 @@ Configuration ============= -Before using Coser, it need to be configured, especially about files not provided -with coser. +Before using Coser, it need to be configured, especially about files not +provided with it. A wizard is available with the menu *Options/Configuration* @@ -64,7 +64,7 @@ coser.control.diffcatchlength Percentage of acceptable difference between the total numbers of individual - captured in the capture file and the same amount in lenght file. + captured in the capture file and the same amount in length file. coser.control.typeFish Fish species type code name. Used by some controls to exclude some species. Modified: trunk/src/site/rst/en/user/controls.rst =================================================================== --- trunk/src/site/rst/en/user/controls.rst 2011-02-08 16:51:05 UTC (rev 715) +++ trunk/src/site/rst/en/user/controls.rst 2011-02-08 17:19:43 UTC (rev 716) @@ -22,47 +22,45 @@ .. * <http://www.gnu.org/licenses/lgpl-3.0.html>. .. * #L% .. - -Contrôles -========= -Coser dispose d'un interface permettant de personnaliser les contrôles. +Controls +======== -Cependant, leurs personnalisation est très technique et est réservé aux -utilisateurs expérimentée. +Coser provides a user interface allowing to customise the controls. -Cette interface est composé d'un arbre avec la liste des 4 fichiers (captures, -tailles, traits, strates) et pour chacun d'eux, les niveaux des erreurs -detectable. +But this customisation is quite technical and must be performed only by +advanced users. -A chaque niveau, un fichier XML décrivant les controles peut être associés -pour les décrires. +This interface is made of a tree with the list of the 4 files (catch, length, +hauls, stratas) and for each one of them, the level of error possible. +For each level, a XML file describing the controls can be associated in order +to describe them. + Documentation ------------- -Les fichiers XML sont basé sur une syntaxe utilisé par le framework Java XWork. +The XML files are based on a syntax used by the Java framework XWork. -La documentation de cette syntaxe peut être trouvé à cette adresse : +The documentation of this syntax can be found at this address : http://struts.apache.org/2.x/docs/validation.html - -Champs +Fields ------ -Pour chaque fichier, les champs sont accessible par leur nom anglais -(``survey``, ``stratum``...) dans leur type relatif (par exemple, ``number`` -est un double java). +For each file, the fields are reachable by their english name (``survey``, +``stratum``…) in their relative type (for example,``number`` is a Java double). -Pour chaque champs, il y a également un autre champs correspondant à sa -donnée sous forme de chaine de caracteres. Par exemple, le champs ``survey`` est -également accessible via le nom ``surveyAsString``. -Le champs ``number`` (de type double) est egalement accessible sous le nom -``numberAsString` (de type chaine). +For each field, there is also an other field corresponding to its data under a +String form. For example, the field ``survey`` is also reachable using the name +``surveyAsString``. +The field ``number`` (of type double) is also reachable under the name +``numberAsString`` (of string type). -Exemple +Example ------- -Exemple du fichier de validation strate (niveau erreur) :: +Example of the startas validation file (error level) :: <validators> <field name="survey"> @@ -85,9 +83,7 @@ </field> </validators> +In this example: -Dans cet exemple: - - * le champs ``survey`` est obligatoire (requiredstring) - * le champs ``surfaceAsString`` doit être un réel valide (la valeur NA étant - autorisée) + * the field ``survey`` is mandatory (requiredstring) + * the field ``surface`` must be a valid number (the value NA is valid). \ No newline at end of file Modified: trunk/src/site/rst/en/user/faq.rst =================================================================== --- trunk/src/site/rst/en/user/faq.rst 2011-02-08 16:51:05 UTC (rev 715) +++ trunk/src/site/rst/en/user/faq.rst 2011-02-08 17:19:43 UTC (rev 716) @@ -22,13 +22,13 @@ .. * <http://www.gnu.org/licenses/lgpl-3.0.html>. .. * #L% .. - -Foire aux questions -=================== +Requently Asked Questions +========================= .. contents:: -Au lancement de l'application JavaWebStart le message "Impossible de lancer l'application" apparaît ---------------------------------------------------------------------------------------------------- +When I launch the JavaWebStart application, I got the message "Cannot launch the application" +--------------------------------------------------------------------------------------------- -Si le détail de l'erreur cite une erreur de certificats, essayez de mettre à -jour java avant de recommencer. +If the detail of this error talks about certificates, try to update Java and +then start again. Modified: trunk/src/site/rst/en/user/guide_control.rst =================================================================== --- trunk/src/site/rst/en/user/guide_control.rst 2011-02-08 16:51:05 UTC (rev 715) +++ trunk/src/site/rst/en/user/guide_control.rst 2011-02-08 17:19:43 UTC (rev 716) @@ -39,109 +39,99 @@ Coser will check: * line by line errors on 4 tables - * - * vérification par croissement avec le referentiel taxonomique + * verification by cross-checking files + * verification by cross-checking with the taxonomic referential -À la fin des 10 étapes de vérification, un arbre de toutes les erreurs -s'affiche avec toutes les erreurs détectées. +After the 10 verificatiosn steps, a tree with all the errors is displayed with +all the errors detected. -Pour plus de détails concernant les erreurs : `liste des contrôles`_. +For more information on the errors : `controls list`_. -.. _liste des contrôles: guide_listcontrols.html +.. _controls list: guide_listcontrols.html -Corrections des données ------------------------ +Fixing data +----------- -Lors de la sélection d'une erreur, Coser affiche la ligne concernée par l'erreur -vous permettant d'apporter une correction. -Les lignes en rouge correspondent à des champs en erreurs. La partie droite -détaille les messages d'erreurs. +When selecting an error, Coser displays the line of the error allowing you to +fix it. +The lines in red corresponds to the fields with errors. The right part details +the error messages. -Dans l'exemple précédant, l'année est manquante, l'utilisateur peut l'ajouter -à la main et valider la modification. +In the previous example, the year is missing, the user can add it by hand and +then validate the modification. +Bulk fixing +------- -Corrections de masse --------------------- +In the case of the same error on several lines : -Dans le cas où une erreur concerne plusieurs lignes: + * either the error is caused by an export error of the 4 tables and it is + better to do the export again, fixing being impossible in coser. + * either the error can be fixed. - * soit l'erreur est dûe à une erreur d'export des 4 tables et il est - préféreable de refaire l'export en amont, la correction se reverant impossible - depuis coser - * soit l'erreur est corrigeable +The table that displays the data got a contextual menu allowing to : -Le tableau affichant toute les données comporte un menu contextuel permettant: + * delete several selected lines. + * find a pattern and replace it by another one - * de supprimer plusieurs lignes sélectionné - * de chercher un motif et de le remplacer par un autre - .. image:: ../images/11-controlmenu1.png -Par exemple, dans le cas ou tous les nombres comporterais une virgule (,) au -lieu d'un point (.), il est possible de remplacer un la virgule par un point -pour toutes les lignes sur une colonne en une seule opération. +For example, if all the numbers got a comma (,) instead of a point (.) for +decimal separation, it is possible to replace all the commas by points in one +operation. -Graphique ---------- +Charts +------ -Coser est également capable de générer des graphiques pour faciliter -la prise de décision (notement concernant les warning détectés par la -vérification globale). +Coser can also generate charts to ease the decision taking (specifically +regarding warning errors). -Le bouton ``Comparaison Captures/Tailles`` affiche une interface où un -graphique est générée pour chaque espèce. Les données correspondent à la somme -des ``Nombre``s dans les fichiers captures et tailles par année. -Une différence peut traduire une erreur dans les données d'origines. +The button ``Comparaison Captures/Tailles`` displays an interface where a chart +is generated for each species. The data corresponds to the sum of the +``Number``s in the catch and length per year files. A difference can show an +error in the original data. .. image:: ../images/13-controlgraphdiff.png -Le bouton ``Strutures en taille`` affiche une interface un peu plus compliquée -mais permettant de générer des graphiques sur des sous ensembles de données -sélectionnés. +The button``Structures en taille`` displays an interface that can generate +charts on a subset of data. -Il est par exemple possible d'afficher la struture en taille mais seulement -pour une strate, ou seulement pour une espece, de faire la somme... +It is for example possible to display the length structure but only for a +stratum, or a specy, or get the sum… .. image:: ../images/14-controlgraphlength.png - -Rapport +Reports ------- -Dans l'étape de contrôle, il est possible de générer deux rapports. +In the control step, it is possible to generate 2 reports. -Rapport de modification -~~~~~~~~~~~~~~~~~~~~~~~ +Modifications report +~~~~~~~~~~~~~~~~~~~~ +The modifications report, reachable through the ``Rapport de modifications`` +button, is generated in HTML and shoud open in a web browser. You can visualize +and print the report in/from the browser. -Le rapport des modifications, accessible via le bouton `Rapport des -modifications`, est généré sous forme de rapport HTML et doit normalement -s'ouvrir dans un nivigateur internet. Vous pouvez à partir de ce navigateur -visualisé ou imprimer ce rapport. +Controls report +~~~~~~~~~~~~~~~ -Rapport de contrôle -~~~~~~~~~~~~~~~~~~~ +This report is reachable by right clic on the errors tree after verifying the +errors in the data. -Ce rapport est accessible par clic droit sur l'arbre des erreurs après -vérification des erreurs sur les données. - .. image:: ../images/12-controlmenu2.png -Ca rapport contient les mêmes erreurs que celle affiché dans l'arbre et -les graphiques de comparaison Captures/Tailles. +This report contains the same errors thant the one displayed in the tree and the +Catch/length comparison charts. +Save and validation +------------------- -Sauvegarde et validation ------------------------- +You can save whenever you want the state of the data while fixing data. -Vous pouvez à tout moment sauvegarder l'état des données au fur et à mesure -de vos corrections. +After the data verification, and if this one ended with ** no errors** the +``Valider le contrôle`` button become active and allows you to validate. -Àprès la vérification des données, et si celle ci c'est terminée **sans erreurs** -le bouton `Valider le contôle` devient actif et vous permet de valider. +The validation of the control step is encessary to go the `selection step`_. -La validation de l'étape de contrôle est nécéssaire pour pouvoir passer -à l'`étape de sélection`_. - -.. _étape de sélection: guide_selection.html +.. _selection step: guide_selection.html Modified: trunk/src/site/rst/en/user/guide_listcontrols.rst =================================================================== --- trunk/src/site/rst/en/user/guide_listcontrols.rst 2011-02-08 16:51:05 UTC (rev 715) +++ trunk/src/site/rst/en/user/guide_listcontrols.rst 2011-02-08 17:19:43 UTC (rev 716) @@ -22,185 +22,177 @@ .. * <http://www.gnu.org/licenses/lgpl-3.0.html>. .. * #L% .. - -Liste des contrôles -=================== +Controls list +============= -Cette page détaille la liste des contrôles effectué par Coser lors -de l'étape de vérification des erreurs. +This page details the list of the controls made by Coser when verifying the +data. -Captures --------- +Catches +------- +------------+----------------------------------------------------------------+----------+ -| Champs | Vérification | Niveau | +| Field | Check | Level | +============+================================================================+==========+ -| Campagne | Champs obligatoire | Erreur | +| Campagne | Mandatory field | Error | +------------+----------------------------------------------------------------+----------+ -| | Champs composé de 4 chiffres obligatoires et 2 chiffres | | -| Année | facultatifs séparés par un point (trimestre) ex: 2002.25 | Erreur | +| | Field with 4 mandatory numbers and 2 optional numbers separated by a point (trimester) ex : 2002.25 | | +| Année |  | Error | +------------+----------------------------------------------------------------+----------+ -| Traits | Composé de lettres et chiffres | Erreur | +| Traits | Made up of letters and numbers | Error | +------------+----------------------------------------------------------------+----------+ -| Especes | Champs obligatoire | Erreur | +| Especes | Mandatory field | Error | +------------+----------------------------------------------------------------+----------+ -| Nombre | Réel, vide ou NA | Erreur | +| Nombre | Number, empty or NA | Error | +------------+----------------------------------------------------------------+----------+ -| Poids | Réel, vide ou NA | Erreur | +| Poids | Number, empty or NA | Error | +------------+----------------------------------------------------------------+----------+ +-----------------------------------------------------------------------------+----------+ -| Autres vérifications | Niveau | +| Other checks | Level | +=============================================================================+==========+ -| Si le Poids est un réel différent de 0, alors le Nombre doit être | | -| également différent de 0 | Erreur | +| If the weight is a number different of 0, then the number also needs to be different from 0 | | +| | Error | +-----------------------------------------------------------------------------+----------+ -| Verification des lignes dupliquées sur la clé "Campagne", "Annee", "Trait", | | -| "Espece" | Erreur | +| Check of duplicate entries with the keys "Campagne", "Annee", "Trait", | | +| "Espece" | Error | +-----------------------------------------------------------------------------+----------+ -| Vérification du nombre minimal d'observations dans table CAPTURES$Nombre | | -| par espèce par strate par année | Warning | +| Check of the minimal number of observations in the table CAPTURES$Nombre | | +| by species by stratum by year | Warning | +-----------------------------------------------------------------------------+----------+ -Strates +Stratas ------- +------------+----------------------------------------------------------------+----------+ -| Champs | Vérification | Niveau | +| Fields | Check | Level | +============+================================================================+==========+ -| Campagne | Champs obligatoire | Erreur | +| Campagne | Mandatory field | Error | +------------+----------------------------------------------------------------+----------+ -| Strate | Champs obligatoire | Erreur | +| Strate | Mandatory field | Error | +------------+----------------------------------------------------------------+----------+ -| Surface | Réel, vide ou NA | Erreur | +| Surface | Number, empty or NA | Error | +------------+----------------------------------------------------------------+----------+ +-----------------------------------------------------------------------------+----------+ -| Autres vérifications | Niveau | +| Other Checks | Level | +=============================================================================+==========+ -| Verification des lignes dupliquées sur la clé "Campagne", "Strate" | Erreur | +| Check the duplicate lines on the keys "Campagne", "Strate" | Error | +-----------------------------------------------------------------------------+----------+ -Tailles +Lengths ------- +------------+----------------------------------------------------------------+----------+ -| Champs | Vérification | Niveau | +| Fields | Check | Level | +============+================================================================+==========+ -| Campagne | Champs obligatoire | Erreur | +| Campagne | Mandatory field | Error | +------------+----------------------------------------------------------------+----------+ -| Année | Champs composé de 4 chiffres obligatoires et 2 chiffres | | -| | facultatifs séparés par un point (trimestre) ex: 2002.25 | Erreur | +| Année | Field with 4 mandatory numbers and 2 optional numbers separated by a point (trimester) ex : 2002.25 | | +| |  | Error | +------------+----------------------------------------------------------------+----------+ -| Traits | Composé de lettres et chiffres | Erreur | +| Traits | Made up of letters and numbers | Error | +------------+----------------------------------------------------------------+----------+ -| Espece | Champs obligatoire | Erreur | +| Espece | Mandatory field | Error | +------------+----------------------------------------------------------------+----------+ -| Sexe | Champs obligatoire | Erreur | +| Sexe | Mandatory field | Error | +------------+----------------------------------------------------------------+----------+ -| Maturite | Champs obligatoire | Erreur | +| Maturite | Mandatory field | Error | +------------+----------------------------------------------------------------+----------+ -| Longueur | Réel valide, vide | Erreur | +| Longueur | Number or empty | Error | +------------+----------------------------------------------------------------+----------+ -| Nombre | Réel valide, vide ou NA | Erreur | +| Nombre | Number, empty or NA | Error | +------------+----------------------------------------------------------------+----------+ -| Poids | Réel valide, vide ou NA | Erreur | +| Poids | Number, empty or NA | Error | +------------+----------------------------------------------------------------+----------+ -| Age | Réel valide, vide ou NA | Fatal | +| Age | Number, empty or NA | Fatal | +------------+----------------------------------------------------------------+----------+ +-----------------------------------------------------------------------------+----------+ -| Autres vérifications | Niveau | +| Other Checks | Level | +=============================================================================+==========+ -| Si le Poids est un réel différent de 0, alors le Nombre doit être | Erreur | -| également différent de 0 | | +| If the Weight is a number different from 0, the Number must be also different from 0 | Error | +| | | +-----------------------------------------------------------------------------+----------+ -| Verification des lignes dupliquées sur la clé "Campagne", "Annee", "Trait", | Erreur | +| Check duplicate lines on keys "Campagne", "Annee", "Trait", | Error | | "Espece", "Sexe", "Maturite", "Longueur" | | +-----------------------------------------------------------------------------+----------+ -| Vérification du nombre minimal d'observation dans table TAILLES$Nombre par | Erreur | -| espèce par strate par année | | +| Check the minimal number of observations in the table TAILLES$Nombre by | Error | +| species by stratum by year | | +-----------------------------------------------------------------------------+----------+ -Traits ------- +Hauls +----- +-----------------+----------------------------------------------------------------+----------+ -| Champs | Vérification | Niveau | +| Fields | Check | Level | +=================+================================================================+==========+ -| Campagne | Champs obligatoire | Erreur | +| Campagne | Mandatory field | Error | +-----------------+----------------------------------------------------------------+----------+ -| | Champs composé de 4 chiffres obligatoires et 2 chiffres | | -| Année | facultatifs séparés par un point (trimestre) ex: 2002.25 | Erreur | +| | Field with 4 mandatory numbers and 2 optional numbers separated by a point (trimester) ex : 2002.25 | | +| Année |  | Error | +-----------------+----------------------------------------------------------------+----------+ -| Traits | Composé de lettres et chiffres | Erreur | +| Traits | Made up of letters and numbers | Error | +-----------------+----------------------------------------------------------------+----------+ -| Mois | 2 chiffres | Erreur | +| Mois | 2 numbers | Error | +-----------------+----------------------------------------------------------------+----------+ -| Strates | Champs obligatoire | Erreur | +| Strates | Mandatory field | Error | +-----------------+----------------------------------------------------------------+----------+ -| SurfaceBalayee | Champs obligatoire et réel valide ou NA | Erreur | +| SurfaceBalayee | Mandatory field and number or NA | Error | +-----------------+----------------------------------------------------------------+----------+ -| Lat | Réel valide, vide ou NA | Erreur | +| Lat | Number, empty or NA | Error | +-----------------+----------------------------------------------------------------+----------+ -| Long | Réel valide, vide ou NA | Erreur | +| Long | Number, empty or NA | Error | +-----------------+----------------------------------------------------------------+----------+ -| ProfMoy | Réel valide, vide ou NA | Erreur | +| ProfMoy | Number, empty or NA | Error | +-----------------+----------------------------------------------------------------+----------+ -| SurfaceBalayee | Composé de au moins 3 décimales | Fatal | +| SurfaceBalayee | With at least 3 decimals | Fatal | +-----------------+----------------------------------------------------------------+----------+ -| Lat | Composé de au moins 4 décimales | Warning | +| Lat | With at least 4 decimals | Warning | +-----------------+----------------------------------------------------------------+----------+ -| Long | Composé de au moins 4 décimales | Warning | +| Long | With at least 4 decimals | Warning | +-----------------+----------------------------------------------------------------+----------+ +-----------------------------------------------------------------------------+----------+ -| Autres vérifications | Niveau | +| Other Checks | Level | +=============================================================================+==========+ -| Si le Poids est un réel différent de 0, alors le Nombre doit être | | -| également différent de 0 | Erreur | +| If the Weight is a number different from 0, the Number must be also different from 0 | | +| | Error | +-----------------------------------------------------------------------------+----------+ -| Verification des lignes dupliquées sur la clé "Campagne", "Annee", "Trait", | | -| "Mois" | Erreur | +| Check duplicate lines on keys "Campagne", "Annee", "Trait", | | +| "Mois" | Error | +-----------------------------------------------------------------------------+----------+ -Coisement de fichier +Files cross-checking -------------------- +-----------------------------------------------------------------------------+----------+ -| Vérifications | Niveau | +| Checks | Level | +=============================================================================+==========+ -| Vérification que le nom de campagne est le même dans les 4 tables | Fatal | +| Check the campaign name is the same in the 4 files | Fatal | +-----------------------------------------------------------------------------+----------+ -| La liste des années doit être identique entre les fichiers Captures, | | -| tailles et Traits | Fatal | +| The list of years must be the same in the Catches, Lengthes and Hauls files | Fatal | +-----------------------------------------------------------------------------+----------+ -| Verification des lignes dupliquées sur la clé "Campagne", "Annee", "Trait", | | -| "Espece", "Sexe", "Maturite", "Longueur" | Erreur | +| For the fishes, the Length field must have a full or half step (for example: 4.0 or 4.5 but not 4.25) |  | +| | Warning | +-----------------------------------------------------------------------------+----------+ -| Vérification du nombre minimal d'observation dans table TAILLES$Nombre par | | -| espèce par strate par année | Erreur | +| Check that for each species present in a haul of a year in the length file | Fatal | +| (noted Year/Haul/Species) there is a data in the catch files (the opposite |  | +| is not true) |  | +-----------------------------------------------------------------------------+----------+ -| Pour les poissons, le champs Longueur doit utiliser un pas entier ou un |  | -| demi pas (par exemple: 4.0 ou 4.5, mais pas 4.25) | Warning | +| Check qthat for each haul present in a year (noted Year/Haul) in the lengthes files and catches, there is a data in the haul file | | +| | Fatal | +-----------------------------------------------------------------------------+----------+ -| Vérification que pour chaque espèce présent dans un trait d'une année |  | -| dans le fichier tailles (noté Annee/Trait/Espece) il y a une donnée | | -| dans le fichier captures (le contraire n'est pas vraie) | Fatal | -+-----------------------------------------------------------------------------+----------+ -| Vérification que pour chaque trait présent une année (noté Annee/Trait) | | -| dans les fichiers tailles et capt il y a une donnée dans le fichier | | -| traits | Fatal | -+-----------------------------------------------------------------------------+----------+ -Croissement avec le reférentiel taxonomique -------------------------------------------- +Cross checking with the taxonomic referential +--------------------------------------------- +-----------------------------------------------------------------------------+----------+ -| Vérifications | Niveau | +| Checks | Level | +=============================================================================+==========+ -| Le champs Especes du fichier Captures doit correspondre à une espèce |  | -| présente dans le référentiel taxonomique | Erreur | +| The Field Species of the catches file must corresponf to a species present in the taxonomic referential |  | +| | Error | +-----------------------------------------------------------------------------+----------+ -| Le champs Especes du fichier Taille doit correspondre à une espèce |  | -| présente dans le référentiel taxonomique | Erreur | +| The Field Species of the lengthes file must corresponf to a species present in the taxonomic referential |  | +| | Error | +-----------------------------------------------------------------------------+----------+