README.md 2.3 KB
Newer Older
jcomedouteau's avatar
jcomedouteau committed
1 2 3 4 5 6 7 8
# Etherpad2Optim -- HDOC CONVERTER PROJECT
## License
[GPL 3.0](http://www.gnu.org/licenses/gpl-3.0.txt)
## Credits
- Rit Gabrielle
- Vintache Jean
- Douteau Jean-Côme
- Fecherolle Cécile (2014)
Jean Vintache's avatar
Jean Vintache committed
9

jcomedouteau's avatar
jcomedouteau committed
10 11 12
##Presentation
How to transform an etherpad document in optim document.
Filepath in this document are relative to this file readme.
Jean Vintache's avatar
Jean Vintache committed
13

jcomedouteau's avatar
jcomedouteau committed
14 15 16
## Dependence
- Etherpad2Hdoc
- Hdoc2Optim
Jean Vintache's avatar
Jean Vintache committed
17

jcomedouteau's avatar
jcomedouteau committed
18 19 20 21 22 23
## User Documentation
1. Download an etherpad document in html format.
	1. Create or join an etherpad document then export it in html format (Import/Export Button) in the `/input` directory (if the directory does not exists, you have to create it).
	2. Name it pad.html
2. Execute the file `/run.bat` or `/run.sh` depending on the OS. A `.scar` file is created in the directory `/output`
*If the `/input` directory contains multiple files, they won't be all treated.
24 25
3. Open the document with Scenari
	1. Open Scenari, and choose "UTC-etu_optim" as distant depot.
jcomedouteau's avatar
jcomedouteau committed
26 27 28
	2. Go in the directory `sandBox/etherpad-to-otpim.`
	3. Import your `.scar` file in the directory.
	4. Open the file Main.xml created.
Jean Vintache's avatar
Jean Vintache committed
29

jcomedouteau's avatar
jcomedouteau committed
30 31 32 33
##Unsupported
- MarkDown
- Timeline and author paternity
- Chat
Jean Vintache's avatar
Jean Vintache committed
34

jcomedouteau's avatar
jcomedouteau committed
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
##Known bugs
Nested lists in lists are not supported
example : 
`<ul>
	<li>
		<ul>
			<li>
			Never gonna let you down.
			</li>
		</ul>
	</li>
<ul>`

## TODO
- Work with markdown
- Correct nested lists
Jean Vintache's avatar
Jean Vintache committed
51

jcomedouteau's avatar
jcomedouteau committed
52 53 54 55
## Technical notes
### Description of etherpad_to_hdoc.ant

#### Prelude
Jean Vintache's avatar
Jean Vintache committed
56 57
- Importation of necessary classes (antlib, htmlcleaner, jing)
- Creation of directories architecture tree
jcomedouteau's avatar
jcomedouteau committed
58 59

#### Transformations
Jean Vintache's avatar
Jean Vintache committed
60 61 62 63 64 65
- 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
jcomedouteau's avatar
jcomedouteau committed
66 67

#### Post-transformations actions
Jean Vintache's avatar
Jean Vintache committed
68 69 70
- Build hdoc structure
- Jing checks if the output file is validated with the right rng schema
- Zip the directory into hdoc archive
jcomedouteau's avatar
jcomedouteau committed
71 72 73 74 75 76 77

## Capitalisation