Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Stephane Crozat
hdoc
Commits
ec61917a
Commit
ec61917a
authored
Jan 04, 2016
by
qaomia
Browse files
add documentation
parent
4d976df1
Changes
1
Hide whitespace changes
Inline
Side-by-side
etherpad_to_hdoc/README.md
100644 → 100755
View file @
ec61917a
# Etherpad to Hdoc -- HDOC CONVERTER PROJECT
## [TL;DR](http://i.imgur.com/18B7f07.jpg)
-
This module is able to convert several
[
etherpad
](
http://etherpad.org/
)
files (exported as html files) to the hdoc format.
-
To do so :
1.
please place your html files in the
`/input`
folder
# Converter etherpad_to_hdoc
## License
License GPL3.0
http://www.gnu.org/licenses/gpl-3.0.txt
## Crédits
-
Jean-Côme Douteau
-
Gabrielle Rit
-
Jean Vintache
-
Fecherolle Cécile
## Presentation
This module is able to convert several
[
etherpad
](
http://etherpad.org/
)
files (exported as html files) to the hdoc format.
## User documentation
### Running etherpad_to_hdoc.ant
1.
Create an etherpad document and export it as an html file.
1.
please place your html files in the
`/input`
folder
2.
run the
`run.[bat|sh]`
script of your choice depending on your OS
3.
and retrieve the hdoc outputs in the
`/output`
folder
## Unsupported
-
Markdown
-
Author paternity
-
Etherpad timeline
-
Chat
## Known bugs
## TODO
## Technical notes
### Description of etherpad_to_hdoc.ant
#### Prelude
-
Importation of necessary classes (antlib, htmlcleaner, jing)
-
Creation of directories architecture tree
#### Transformations
-
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
#### Post-transformations actions
-
Build hdoc structure
-
Jing checks if the output file is validated with the right rng schema
-
Zip the directory into hdoc archive
## Capitalisation
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment