README.md 1.65 KB
Newer Older
Gregory's avatar
Gregory committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
# HDOC to ElasticSearch

## License
-------------
License GPL3.0 http://www.gnu.org/licenses/gpl-3.0.txt

## Credits
-------------
DELAUNAY Grégory
KELLER Vincent

## Presentation
-------------
Hdoc to ElasticSearch module extract data from an Hdoc file to use it with ElasticSearch


## Dependence
-------------
19 20 21 22 23 24 25
No depedencies

##Utilisation
-------------
Pour utiliser ce convertisseur, veuillez suivre les étapes suivantes : 
1 - Placer le(s) fichier(s) hdoc que vous souhaitez convertir dans le dossier input (des exemples sont fournis dans le dossier sample).
2 - Lancer l'un des executable run.bat ou run.sh en fonction du système d'exploitation de votre ordinateur.
Vincent Keller's avatar
Vincent Keller committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
3 - Récupérer le(s) résultat(s) au format .json dans le dossier output.

##Conversion
------------
Ce module permet : 
	- L'extraction des données du header
		- Titre
		- Auteurs
		- Mots clés
		- Droits
	- L'extraction des exercices conformément aux attentes de Kibana : 
		- Récupération des exercices et affectation d'un ID unique.
		- Association des questions aux exercices grâce aux ID générés précédemment.
		

##TODO
------

- Prendre en compte les futures modification de la conversion opale_to_hdoc pour les exercices.
- Ajouter la gestion des sections sachant que Kibana ne considère pas les tableaux d'objets JSON. Pour cela, la solution que nous avons retenu :
	- Générer des ID via la function generate-id() pour produire une clé de la forme section_ID.
	- Ajouter une références vers l'id de la section mère dans chacun des fils. (Ex : "parent" : "section_ID")


##Technical notes
-----------------
Les tabulations lors de la conversion en JSON sont déconseillés car cela pose problème avec Kibana.