README.md 3.51 KB
Newer Older
1
# Converter framapad_to_hdoc
qaomia's avatar
qaomia committed
2 3 4 5 6

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

Jean Vintache's avatar
Jean Vintache committed
7
## Credits
8
- 2016
9 10
    - Etienne Chognard
    - Fabien Boucaud
Jean Vintache's avatar
Jean Vintache committed
11 12 13 14 15 16
- 2015
    - Jean-Côme Douteau
    - Gabrielle Rit
    - Jean Vintache
- 2014
    - Fecherolle Cécile
qaomia's avatar
qaomia committed
17 18 19 20 21 22

## Presentation
This module is able to convert several [etherpad](http://etherpad.org/) files (exported as html files) to the hdoc format.

## User documentation

23 24 25 26
## User Story

Vous êtes un utilisateur de framapad et en créez un pour un projet. Après avoir travaillé sur votre pad, vous souhaitez transformer ce document en un autre format que vous pourrez utiliser dans un nouveau contexte de travail. Pour ce faire, vous exportez le framapad au format HTML grâce au bouton « Import/Export ». Vous récupérez ensuite les fichiers nécessaires à la transformation framapad to hdoc sur le répertoire git du projet hdoc (voir http://hdoc.crzt.fr/). Il ne vous reste alors plus qu'à placer le fichier html précédemment récupéré dans le dossier « input » du dossier framapad_to_hdoc et à exécuter le /run.bat si vous êtes sur Windows ou le /run.sh si vous êtes sur Linux/Mac. Cela produira une archive .hdoc dont l'intérêt est de servir de format de passage pour une transformation d'un format à un autre, et ce pour une grande variété de format. Il vous restera ensuite à déterminer le nouveau format dans lequel vous voulez transformer votre hdoc et utiliser le convertisseur approprié s'il existe.

Jean Vintache's avatar
Jean Vintache committed
27 28 29 30 31
## Running etherpad_to_hdoc.ant
1. Create an etherpad document and export it as an html file.
2. please place your html files in the `/input` folder
3. run the `run.[bat|sh]` script of your choice depending on your OS
4. and retrieve the hdoc outputs in the `/output` folder
qaomia's avatar
qaomia committed
32 33

## Unsupported
Jean Vintache's avatar
Jean Vintache committed
34 35 36 37
- Markdown
- Author paternity
- Etherpad timeline
- Chat
qaomia's avatar
qaomia committed
38 39

## Known bugs
qaomia's avatar
qaomia committed
40
- Nested lists in lists are not supported
qaomia's avatar
qaomia committed
41 42 43 44 45 46 47 48 49 50
Example : 
`<ul>
	<li>
		<ul>
			<li>
			Never gonna give you up.
			</li>
		</ul>
	</li>
<ul>`
qaomia's avatar
qaomia committed
51
- As a consequence, etherpad indentation is not supported because it is coded as nested lists.
Jean Vintache's avatar
Jean Vintache committed
52

53 54 55 56
## Product Backlog

Currently available on: https://framemo.org/framapad_to_opale

57 58
See also : https://bimestriel.framapad.org/p/nf29_framapad_to_opale for the full documentation of our working process.

qaomia's avatar
qaomia committed
59
## TODO
60 61 62 63 64
- Nested Lists
- Indentation
- Titles (and therefore Structure of the doc)
- Coloured text
- Code
Jean Vintache's avatar
Jean Vintache committed
65
- Markdown
qaomia's avatar
qaomia committed
66 67 68 69 70

## Technical notes
### Description of etherpad_to_hdoc.ant

#### Prelude
Jean Vintache's avatar
Jean Vintache committed
71 72
- Importation of necessary classes (antlib, htmlcleaner, jing)
- Creation of directories architecture tree
qaomia's avatar
qaomia committed
73 74

#### Transformations
Jean Vintache's avatar
Jean Vintache committed
75 76 77 78 79 80
- Use of htmlcleaner to transform the input file from html to xhtml. For more info, see http://htmlcleaner.sourceforge.net/index.php.
- Apply html2xhtml.xsl : this xsl extracts the content into <body> tags
- 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
qaomia's avatar
qaomia committed
81 82

#### Post-transformations actions
Jean Vintache's avatar
Jean Vintache committed
83 84 85
- Build hdoc structure
- Jing checks if the output file is validated with the right rng schema
- Zip the directory into hdoc archive
qaomia's avatar
qaomia committed
86

qaomia's avatar
qaomia committed
87
### Supported tags
Jean Vintache's avatar
Jean Vintache committed
88 89 90 91 92
- html tags -> hdoc tags
- u, s, em, strong -> em
- li -> li
- ol -> ol
- br -> p
qaomia's avatar
qaomia committed
93 94

## Capitalisation
95
Using regular expression with xsl is a good way to parse a non xml file.