Commit 47782055 authored by Jean Vintache's avatar Jean Vintache

fix readmes

parent 10c34c3c
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
License GPL3.0 License GPL3.0
http://www.gnu.org/licenses/gpl-3.0.txt http://www.gnu.org/licenses/gpl-3.0.txt
## Crédits ## Credits
- 2015 - 2015
- Jean-Côme Douteau - Jean-Côme Douteau
- Gabrielle Rit - Gabrielle Rit
...@@ -17,17 +17,17 @@ This module is able to convert several [etherpad](http://etherpad.org/) files (e ...@@ -17,17 +17,17 @@ This module is able to convert several [etherpad](http://etherpad.org/) files (e
## User documentation ## User documentation
### Running etherpad_to_hdoc.ant ## Running etherpad_to_hdoc.ant
1. Create an etherpad document and export it as an html file. 1. Create an etherpad document and export it as an html file.
1. please place your html files in the `/input` folder 2. please place your html files in the `/input` folder
2. run the `run.[bat|sh]` script of your choice depending on your OS 3. run the `run.[bat|sh]` script of your choice depending on your OS
3. and retrieve the hdoc outputs in the `/output` folder 4. and retrieve the hdoc outputs in the `/output` folder
## Unsupported ## Unsupported
- Markdown - Markdown
- Author paternity - Author paternity
- Etherpad timeline - Etherpad timeline
- Chat - Chat
## Known bugs ## Known bugs
- Nested lists in lists are not supported - Nested lists in lists are not supported
...@@ -42,35 +42,36 @@ Example : ...@@ -42,35 +42,36 @@ Example :
</li> </li>
<ul>` <ul>`
- As a consequence, etherpad indentation is not supported because it is coded as nested lists. - As a consequence, etherpad indentation is not supported because it is coded as nested lists.
## TODO ## TODO
- Markdown - Markdown
## Technical notes ## Technical notes
### Description of etherpad_to_hdoc.ant ### Description of etherpad_to_hdoc.ant
#### Prelude #### Prelude
- Importation of necessary classes (antlib, htmlcleaner, jing) - Importation of necessary classes (antlib, htmlcleaner, jing)
- Creation of directories architecture tree - Creation of directories architecture tree
#### Transformations #### Transformations
- Use of htmlcleaner to transform the input file from html to xhtml. For more info, see http://htmlcleaner.sourceforge.net/index.php. - 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 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 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 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 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 xhtml2hdoc.xsl : this xsl transforms the content into hdoc structure
#### Post-transformations actions #### Post-transformations actions
- Build hdoc structure - Build hdoc structure
- Jing checks if the output file is validated with the right rng schema - Jing checks if the output file is validated with the right rng schema
- Zip the directory into hdoc archive - Zip the directory into hdoc archive
### Supported tags ### Supported tags
html tags -> hdoc tags - html tags -> hdoc tags
- u, s, em, strong -> em - u, s, em, strong -> em
- li -> li - li -> li
- ol -> ol - ol -> ol
- br -> p - br -> p
## Capitalisation ## Capitalisation
We learned how to use xsl sheets with text file as an input : we had to use regular expressions to extract content. We learned how to use xsl sheets with text file as an input : we had to use regular expressions to extract content.
\ No newline at end of file
...@@ -6,12 +6,14 @@ ...@@ -6,12 +6,14 @@
- Vintache Jean - Vintache Jean
- Douteau Jean-Côme - Douteau Jean-Côme
- Fecherolle Cécile (2014) - Fecherolle Cécile (2014)
##Presentation ##Presentation
How to transform an etherpad document in lexique document. How to transform an etherpad document in lexique document.
Filepath in this document are relative to this file readme. Filepath in this document are relative to this file readme.
## Dependence ## Dependence
- Etherpad2Hdoc - Etherpad2Hdoc
- Hdoc2Lexique - Hdoc2Lexique
## User Documentation ## User Documentation
1. Download an etherpad document in html format. 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). 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).
...@@ -23,10 +25,12 @@ Filepath in this document are relative to this file readme. ...@@ -23,10 +25,12 @@ Filepath in this document are relative to this file readme.
2. Go in the directory `sandBox/etherpad-to-lexique.` 2. Go in the directory `sandBox/etherpad-to-lexique.`
3. Import your `.scar` file in the directory. 3. Import your `.scar` file in the directory.
4. Open the file Main.xml created. 4. Open the file Main.xml created.
##Unsupported ##Unsupported
- MarkDown - MarkDown
- Timeline and author paternity - Timeline and author paternity
- Chat - Chat
##Known bugs ##Known bugs
Nested lists in lists are not supported Nested lists in lists are not supported
example : example :
...@@ -43,25 +47,26 @@ example : ...@@ -43,25 +47,26 @@ example :
## TODO ## TODO
- Work with markdown - Work with markdown
- Correct nested lists - Correct nested lists
## Technical notes ## Technical notes
### Description of etherpad_to_hdoc.ant ### Description of etherpad_to_hdoc.ant
#### Prelude #### Prelude
- Importation of necessary classes (antlib, htmlcleaner, jing) - Importation of necessary classes (antlib, htmlcleaner, jing)
- Creation of directories architecture tree - Creation of directories architecture tree
#### Transformations #### Transformations
- Use of htmlcleaner to transform the input file from html to xhtml. For more info, see http://htmlcleaner.sourceforge.net/index.php. - 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 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 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 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 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 xhtml2hdoc.xsl : this xsl transforms the content into hdoc structure
#### Post-transformations actions #### Post-transformations actions
- Build hdoc structure - Build hdoc structure
- Jing checks if the output file is validated with the right rng schema - Jing checks if the output file is validated with the right rng schema
- Zip the directory into hdoc archive - Zip the directory into hdoc archive
## Capitalisation ## Capitalisation
......
...@@ -6,12 +6,15 @@ ...@@ -6,12 +6,15 @@
- Vintache Jean - Vintache Jean
- Douteau Jean-Côme - Douteau Jean-Côme
- Fecherolle Cécile (2014) - Fecherolle Cécile (2014)
##Presentation ##Presentation
How to transform an etherpad document in opale document. How to transform an etherpad document in opale document.
Filepath in this document are relative to this file readme. Filepath in this document are relative to this file readme.
## Dependence ## Dependence
- Etherpad2Hdoc - Etherpad2Hdoc
- Hdoc2Opale - Hdoc2Opale
## User Documentation ## User Documentation
1. Download an etherpad document in html format. 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). 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).
...@@ -22,10 +25,12 @@ Filepath in this document are relative to this file readme. ...@@ -22,10 +25,12 @@ Filepath in this document are relative to this file readme.
2. Go in the directory `sandBox/etherpad-to-opale.` 2. Go in the directory `sandBox/etherpad-to-opale.`
3. Import your `.scar` file in the directory. 3. Import your `.scar` file in the directory.
4. Open the file Main.xml created. 4. Open the file Main.xml created.
##Unsupported ##Unsupported
- MarkDown - MarkDown
- Timeline and author paternity - Timeline and author paternity
- Chat - Chat
##Known bugs ##Known bugs
Nested lists in lists are not supported Nested lists in lists are not supported
example : example :
...@@ -42,25 +47,26 @@ example : ...@@ -42,25 +47,26 @@ example :
## TODO ## TODO
- Work with markdown - Work with markdown
- Correct nested lists - Correct nested lists
## Technical notes ## Technical notes
### Description of etherpad_to_hdoc.ant ### Description of etherpad_to_hdoc.ant
#### Prelude #### Prelude
- Importation of necessary classes (antlib, htmlcleaner, jing) - Importation of necessary classes (antlib, htmlcleaner, jing)
- Creation of directories architecture tree - Creation of directories architecture tree
#### Transformations #### Transformations
- Use of htmlcleaner to transform the input file from html to xhtml. For more info, see http://htmlcleaner.sourceforge.net/index.php. - 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 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 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 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 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 xhtml2hdoc.xsl : this xsl transforms the content into hdoc structure
#### Post-transformations actions #### Post-transformations actions
- Build hdoc structure - Build hdoc structure
- Jing checks if the output file is validated with the right rng schema - Jing checks if the output file is validated with the right rng schema
- Zip the directory into hdoc archive - Zip the directory into hdoc archive
## Capitalisation ## Capitalisation
......
...@@ -6,12 +6,15 @@ ...@@ -6,12 +6,15 @@
- Vintache Jean - Vintache Jean
- Douteau Jean-Côme - Douteau Jean-Côme
- Fecherolle Cécile (2014) - Fecherolle Cécile (2014)
##Presentation ##Presentation
How to transform an etherpad document in optim document. How to transform an etherpad document in optim document.
Filepath in this document are relative to this file readme. Filepath in this document are relative to this file readme.
## Dependence ## Dependence
- Etherpad2Hdoc - Etherpad2Hdoc
- Hdoc2Optim - Hdoc2Optim
## User Documentation ## User Documentation
1. Download an etherpad document in html format. 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). 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).
...@@ -23,10 +26,12 @@ Filepath in this document are relative to this file readme. ...@@ -23,10 +26,12 @@ Filepath in this document are relative to this file readme.
2. Go in the directory `sandBox/etherpad-to-otpim.` 2. Go in the directory `sandBox/etherpad-to-otpim.`
3. Import your `.scar` file in the directory. 3. Import your `.scar` file in the directory.
4. Open the file Main.xml created. 4. Open the file Main.xml created.
##Unsupported ##Unsupported
- MarkDown - MarkDown
- Timeline and author paternity - Timeline and author paternity
- Chat - Chat
##Known bugs ##Known bugs
Nested lists in lists are not supported Nested lists in lists are not supported
example : example :
...@@ -43,25 +48,26 @@ example : ...@@ -43,25 +48,26 @@ example :
## TODO ## TODO
- Work with markdown - Work with markdown
- Correct nested lists - Correct nested lists
## Technical notes ## Technical notes
### Description of etherpad_to_hdoc.ant ### Description of etherpad_to_hdoc.ant
#### Prelude #### Prelude
- Importation of necessary classes (antlib, htmlcleaner, jing) - Importation of necessary classes (antlib, htmlcleaner, jing)
- Creation of directories architecture tree - Creation of directories architecture tree
#### Transformations #### Transformations
- Use of htmlcleaner to transform the input file from html to xhtml. For more info, see http://htmlcleaner.sourceforge.net/index.php. - 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 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 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 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 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 xhtml2hdoc.xsl : this xsl transforms the content into hdoc structure
#### Post-transformations actions #### Post-transformations actions
- Build hdoc structure - Build hdoc structure
- Jing checks if the output file is validated with the right rng schema - Jing checks if the output file is validated with the right rng schema
- Zip the directory into hdoc archive - Zip the directory into hdoc archive
## Capitalisation ## Capitalisation
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment