This module is able to convert several [framad](https://framapad.org/) files (exported as html files) to the hdoc format.
This module is able to convert several [framapad](https://framapad.org/) files (exported as html files) to the hdoc format.
## User documentation
...
...
@@ -32,14 +32,15 @@ Vous êtes un utilisateur de framapad et en créez un pour un projet. Après avo
## Product Backlog
Currently available on: https://framemo.org/framapad_to_opale
Currently (january 2017) available on: https://framemo.org/framapad_to_opale
See also : https://bimestriel.framapad.org/p/nf29_framapad_to_opale for the full documentation of our working process.
## TODO
- Implémenter la gestion du code
- Gerer parfaitement les indentations
- (Possibilité d'utiliser des tags pour typer les sections)
- Code tags
- Markdown
- Tags for typing the structure
## Technical notes
### Description of framapad_to_hdoc.ant
...
...
@@ -54,7 +55,9 @@ See also : https://bimestriel.framapad.org/p/nf29_framapad_to_opale for the full
- Apply html2xhtmlv1.xsl : this xsl is used as a fix and adds br tag at the end of lists (ul and ol)
- Apply html2xhtmlv2.xsl : this xsl surround text line with p tags and transforms non-hdoc tags into hdoc tags as s, u, strong tags.
- Apply html2xhtml3.xsl : this xsl is used as a fix, it deletes p tags when its child is ul or ol
- Apply xhtml2hdoc.xsl : this xsl transforms the content into hdoc structure
- Apply html2hdocstruct1 to 6 : those xsl files are dedicated to building the hdoc structure based on the titles h1 to h6
- Apply html2hdocstructdivsection: this xsl completes the sections created in the previous xsl with <div> around the actual content of each level
- Apply xhtml2hdoc.xsl : this xsl transforms the content into hdoc structure and changes the namespace
#### Post-transformations actions
- Build hdoc structure
...
...
@@ -63,16 +66,20 @@ See also : https://bimestriel.framapad.org/p/nf29_framapad_to_opale for the full
### Supported tags
- html tags -> hdoc tags
- u, s, em, strong -> em
- u, s, em, strong, color -> em
- sub -> sub
- sup -> sup
- li -> li
- ol -> ol
- br -> p
- title tags (h1 to h6) -> section or division or ...
- span color -> em
- code -> p with a message to say that it's code
###Titles
- If it's h1 -> new section
- If following title is not h1 -> new division in the section
- If following title is at the same level -> new division at the same level
- If following title is at a lower level -> new division in the previous division
## Capitalisation
Using regular expression with xsl is a good way to parse a non xml file.
We can note about the creation of the hdoc's structure with the titles h1 to h6 that XSLT is probably not the best tool for these specific transformations. Something like SAX, which actually explore the XML files sequentially, would probably be more efficient and easier to use for these kinds of transformations.
- Cliquez sur "import" et importer le fichier JSON opale_to_elasticSearch/conf/kibana/dashboard.json
- Vous devriez voir un dashboard et des objets dans "vizualisation" s'ajouter à votre liste de saved objects
- Allez dans Dashboard, cliquez sur "Open" et sélectionnez le dashboard ajouté (Normalement "NF29_DATA_DASHBOARD")
- Vous pouvez cliquez sur les différents éléments des graphiques pour filtrer les informations, les graphiques s'actualiseront en fonction.
\ No newline at end of file
- Vous pouvez cliquez sur les différents éléments des graphiques pour filtrer les informations, les graphiques s'actualiseront en fonction.
##Bugs connus
-------------
- Logstash ne prend pas toujours en compte tout de suite le fichier une fois ajouté au dossier, il faut parfois l'éteindre/le relancer
- Kibana ne reconnait pas les champs JSON si une/des tabulations se retrouvent devant le nom du champ.
##Idée d'amélioration
-------------
- Maintenant que hdoc_to_elasticSearch permet la gestion des exercices / questions, ajouter des graphiques utiles à l'analyse de ceux-ci
- Former un dossier de requête REST pré-formulées pour pouvoir récupérer facilement les informations qui nous intéressent après filtrage des données grâce aux graphiques Kibana