fix readmes

47782055 · Jean Vintache · 10c34c3c · 47782055 · 47782055 · 47782055
Commit 47782055 authored Jan 06, 2016 by Jean Vintache
4 changed files
--- a/etherpad_to_hdoc/README.md
+++ b/etherpad_to_hdoc/README.md
@@ -4,7 +4,7 @@
 License GPL3.0
 http://www.gnu.org/licenses/gpl-3.0.txt

-## Crédits
+## Credits
 - 2015
    - Jean-Côme Douteau
    - Gabrielle Rit
@@ -17,17 +17,17 @@ This module is able to convert several [etherpad](http://etherpad.org/) files (e

 ## 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
+## 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

 ## Unsupported
-	- Markdown
-	- Author paternity
-	- Etherpad timeline
-	- Chat
+- Markdown
+- Author paternity
+- Etherpad timeline
+- Chat

 ## Known bugs
 - Nested lists in lists are not supported
@@ -42,35 +42,36 @@ Example :
 	</li>
 <ul>`
 - As a consequence, etherpad indentation is not supported because it is coded as nested lists.
+
 ## TODO
-	- Markdown
+- Markdown

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

 #### Prelude
-	- Importation of necessary classes (antlib, htmlcleaner, jing)
-	- Creation of directories architecture tree
+- 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
+- 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
+- Build hdoc structure
+- Jing checks if the output file is validated with the right rng schema
+- Zip the directory into hdoc archive

 ### Supported tags
-html tags -> hdoc tags
-	- u, s, em, strong -> em
-	- li -> li
-	- ol -> ol
-	- br -> p
+- html tags -> hdoc tags
+- u, s, em, strong -> em
+- li -> li
+- ol -> ol
+- br -> p

 ## Capitalisation
 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
--- a/etherpad_to_lexique/README.md
+++ b/etherpad_to_lexique/README.md
@@ -6,12 +6,14 @@
 - Vintache Jean
 - Douteau Jean-Côme
 - Fecherolle Cécile (2014)
+
 ##Presentation
 How to transform an etherpad document in lexique document.
 Filepath in this document are relative to this file readme.
 ## Dependence
 - Etherpad2Hdoc
 - Hdoc2Lexique
+
 ## 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).
@@ -23,10 +25,12 @@ Filepath in this document are relative to this file readme.
 	2. Go in the directory `sandBox/etherpad-to-lexique.`
 	3. Import your `.scar` file in the directory.
 	4. Open the file Main.xml created.
+
 ##Unsupported
 - MarkDown
 - Timeline and author paternity
 - Chat
+
 ##Known bugs
 Nested lists in lists are not supported
 example : 
@@ -43,25 +47,26 @@ example :
 ## TODO
 - Work with markdown
 - Correct nested lists
+
 ## Technical notes
 ### Description of etherpad_to_hdoc.ant

 #### Prelude
-	- Importation of necessary classes (antlib, htmlcleaner, jing)
-	- Creation of directories architecture tree
+- 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
+- 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
+- Build hdoc structure
+- Jing checks if the output file is validated with the right rng schema
+- Zip the directory into hdoc archive

 ## Capitalisation


--- a/etherpad_to_opale/README.md
+++ b/etherpad_to_opale/README.md
@@ -6,12 +6,15 @@
 - Vintache Jean
 - Douteau Jean-Côme
 - Fecherolle Cécile (2014)
+
 ##Presentation
 How to transform an etherpad document in opale document.
 Filepath in this document are relative to this file readme.
+
 ## Dependence
 - Etherpad2Hdoc
 - Hdoc2Opale
+
 ## 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).
@@ -22,10 +25,12 @@ Filepath in this document are relative to this file readme.
 	2. Go in the directory `sandBox/etherpad-to-opale.`
 	3. Import your `.scar` file in the directory.
 	4. Open the file Main.xml created.
+
 ##Unsupported
 - MarkDown
 - Timeline and author paternity
 - Chat
+
 ##Known bugs
 Nested lists in lists are not supported
 example : 
@@ -42,25 +47,26 @@ example :
 ## TODO
 - Work with markdown
 - Correct nested lists
+
 ## Technical notes
 ### Description of etherpad_to_hdoc.ant

 #### Prelude
-	- Importation of necessary classes (antlib, htmlcleaner, jing)
-	- Creation of directories architecture tree
+- 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
+- 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
+- Build hdoc structure
+- Jing checks if the output file is validated with the right rng schema
+- Zip the directory into hdoc archive

 ## Capitalisation


--- a/etherpad_to_optim/README.md
+++ b/etherpad_to_optim/README.md
@@ -6,12 +6,15 @@
 - Vintache Jean
 - Douteau Jean-Côme
 - Fecherolle Cécile (2014)
+
 ##Presentation
 How to transform an etherpad document in optim document.
 Filepath in this document are relative to this file readme.
+
 ## Dependence
 - Etherpad2Hdoc
 - Hdoc2Optim
+
 ## 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).
@@ -23,10 +26,12 @@ Filepath in this document are relative to this file readme.
 	2. Go in the directory `sandBox/etherpad-to-otpim.`
 	3. Import your `.scar` file in the directory.
 	4. Open the file Main.xml created.
+
 ##Unsupported
 - MarkDown
 - Timeline and author paternity
 - Chat
+
 ##Known bugs
 Nested lists in lists are not supported
 example : 
@@ -43,25 +48,26 @@ example :
 ## TODO
 - Work with markdown
 - Correct nested lists
+
 ## Technical notes
 ### Description of etherpad_to_hdoc.ant

 #### Prelude
-	- Importation of necessary classes (antlib, htmlcleaner, jing)
-	- Creation of directories architecture tree
+- 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
+- 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
+- Build hdoc structure
+- Jing checks if the output file is validated with the right rng schema
+- Zip the directory into hdoc archive

 ## Capitalisation