Public | Automated Build

Last pushed: 10 months ago
Short Description
Interface d'évaluation de l'indexation automatique Termith http://www.atilf.fr/ressources/termith/
Full Description

IDEFIX

IDEFIX est une interface graphique de notation de mot clés pour des fichiers XML-TEI

En savoir plus sur Termith

Sommaire

Les prérequis

Installation sans serveur (Use it if you want to try/dev Idefix on a simple personal computer)

Installation avec ezMaster (Use it on a server , or if you want to start many apps locally)

Liste des options

Guide utilisateur

Les prérequis

  • Votre OS doit être de type UNIX ( linux / Mac ) , Windows non supporté

  • Node.Js (Version >= 10)

  • MongoDB

  • Le navigateur Firefox (Version > 26)

  • Un dossier contenant vos fichiers TEI

Installer IDEFIX

Installation sur ordinateur personnel

Téléchargement

Avec Git:

  • Ouvrir l'invite de commande et lancer :
    git clone https://github.com/termith-anr/idefix.git
    

Sans Git:

Installation

  • Rendez-vous dans le dossier issu de l'extraction de l'archive:

       cd dossierExtraitAvecGit
    
  • Pour installer idefix tapez :

       npm install
    

Lancer IDEFIX

Créer un fichier de configuration

  • Ce fichier doit posséder exactement le même nom que le dossier contenant vos fichiers TEI et avoir ".json" comme extension
  • Ce fichier JSON doit être placé à côté du dossier de fichiers
    ├── Ordinateur/
    │   ├── nomDeDossier.json
    │   ├── nomDeDossier
    │   │   ├── fichier-tei-1.xml
    │   │   ├── fichier-tei-2.xml
    │   │   ├── ...
    │   │   ├── fichier-tei-x.xml
    
  • Ensuite remplissez ce fichier avec les paramétres suivants (sc2) :
 {
   "domain": "Archéologie",
   "unlockIDEFIX": false,
   "teiFormat": "2015-02-13",
   "showSilence": true,
   "showArticle": false,
   "showPreference": [
     1
   ],
   "showCorrespondance": [
     0
   ],
   "autoPertinence": true,
   "autoSilence": true,
   "magicScore": true,
   "circleSeuil": 2,
   "circleDesign": "opacity",
   "exports": {
     "csv": true,
     "xml": false,
     "zipXML": true
   },
   "comments": [
     "Trop générique",
     "(P)Trop spécifique",
     "(P) Forme canonique absente du texte.",
     "(P) Forme préférée dans le texte.",
     "(S) Erreur d’indexation.",
     "(S) Forme variante dans le texte.",
     "(S) Générique.",
     "(S) Implicite.",
     "(S) Notion absente du résumé.",
     "(S) Préférence pour ",
     "(S) Secondaire",
     "(S)  Segmentation erronée"
   ]
 }

Lancement

  • Grâce au terminal dans votre dossier contenant l'application idefix lancez :
    .idefix ~/Document/nomDeDossier
  • ~/Document/nomDeDossier est le lien vers le dossier contenant vos fichiers TEI

Installation avec ezMaster ( sur un Serveur )

Plus d'info sur (ezMaster)

  • Installer ezMaster (installation en anglais)
  • Rendez-vous sur Liste des version d'Idefix et copiez le lien "source code" lié au fichier tar.gz d ela version souhaitée
  • Téléchargez Idefix dans ~/apps

      cd ~/apps
    
      curl -L  https://exemple.tar.gz | tar zx
    
      ///Remplacez exemple.targz avec le bon lienn////
    
  • Installez Idefix
  • Lancer ezMaster
      ezMaster ~/apps
    
  • Dans votre navigateur , rendez-vous sur --> localhost:35267
  • Ajouter une instance en cliquant sur "+ Add an instance"
  • Rentrez les informations demandées (à titres indicatives pour leur gestion).
  • Editer la configuration de l'instance en cliquant sur le bouton de paramétres de l'instance ajoutée
  • Appuyez sur "text" en hauteur pour switcher en mode texte
  • Copiez-Collez la configuration de base)
  • Ajoutez vos propres options si voulu ( /!\ Ne pas ajouter les option "--- Non ezMaster ---" ) Voir la liste d'option

Liste des options

  • "ezMaster Seulement" précise que cette option n'est à utiliser qu'avec ezMaster
  • "Non ezMaster" précise que cette option est à ne pas utiliser avec ezMaster config (could break it)
title (OBLIGATOIRE/texte) --- ezMaster Seulement ---

Le titre de l'instance dans ezMaster ( à gauche )

"title": "A title"
unlockIDEFIX (OPTIONAL/booléen)

Il s'agit du mode administrateur de l'instance , tout est débloqué par default , l'évaluation du silence & au contenu validé peut se faire à tout moment.

port (OBLIGATOIRE/Nombre) --- Non ezMaster ---

Demande à Idefix d'utiliser un port en particulier

"port": 3001
connexionURI (OBLIGATOIRE/texte) --- Non ezMaster ---

Il s'agit de la connexion à mongoDB , IDEFIX utilise une base "Test" simple , cette option ne devrait pas être utilisée

"connexionURI" : "mongodb://localhost:27017/test/"

domain (OPTIONAL/texte)

Décrit le type de fichier du corpus ( chimie , linguistique ... )

"domain" : "linguistique"

teiFormat (OBLIGATOIRE/texte)

Choix de la version du format des fichiers TEI
Voici la liste actuelle :

  • "2015-02-13" (Phase II)
  • "2014-11-01" (Phase I)

showSilence (OPTIONAL/Boolean)

Activer/Desactiver la visualisation des silences

"showSilence" : true

showArticle (OPTIONAL/Boolean)

Activer/Desactiver la visualisation de l'article complet

"showArticle" : false

exports(OPTIONAL/Object)

Activer/Desactiver certaines formes d'exports

  • csv , export au formats CSV de l'ensemble (note,temps passé,..) dans un fichier csv

  • xml, exporten XML de tous les fichiers en un seul corpus TEI

  • zipXML, retourne chaque fichier séparément avec leurs scores

"exports" : {
    "csv" : true,
    "xml" : true,
    "zipXML" : true
  }

showPreference(OPTIONAL/Tableau)

Tableau contenant les valeur ou l'on souhaite pouvoir acceder aux préférences

"showPreference" : [0,2]

showCorrespondance(OPTIONAL/Tableau)

Tableau contenant les valeur ou l'on souhaite pouvoir acceder aux correspondances

"showCorrespondance" : [1]

comments(OPTIONAL/Tableau)

Un tableau contenant une liste de commentaires souvent utilisés , ces commentaires seront proposés dans l'interface

"comments" : ["Commentaire 1","Commentaire 2","Commentaire 3"]

autoPertinence(OPTIONNAL/Boolean)

Activer/Desactiver la génération automatique de score pour les pertinences
Activé par default

"autoPertinence" : true

autoSilence(OPTIONNAL/Boolean)

Activer/Desactiver la génération automatique de score pour les silences
Activé par default

"autoPertinence" : true
negativeSilence (OPTIONNAL/Boolean)

Si activé , affiche les scores de silences en negatifs :
ex : 0 /-1 /-2

magicScore (OPTIONNAL/Boolean)

Si activé , permet en cliquant sur un bouton de répercuter les scores de mots identiques de toutes les autres méthodes à celle ouverte

Désactivé par default

circleSeuil (OPTIONNAL/Number)

Permet de définir un seuil : si le nombre de mot clés non encore notés d'une méthode passe sous ce seuil , un effet est produit.

2 est le seuil par default

circleDesign (OPTIONNAL/Number)

Permet de définir le look souhaité à l'affiche du seuil de mot clés ainsi que l'effet pour une méthode complétement évaluée

  • "grey", option par default , la méthode clignote lors du seuil et se grise une fois terminée.
  • "opacity", la méthode clignote lors du seuil et devient transparente une fois terminée.
  • "colors" , la méthode devient orange lors du seuil et devient verte une fois terminée.

-Si vous pensez avoir trouvé un bug ajoutez une issue sur : github issue

Docker Pull Command
Owner
inistcnrs
Source Repository

Comments (0)