Commit fd348ae9 authored by Jean-Baptiste Martin's avatar Jean-Baptiste Martin

Merge branch 'master' of gitlab.utc.fr:crozatst/hdoc

parents 9d08e757 dd9a8045
......@@ -5,10 +5,12 @@ 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
- 2015
- Jean-Côme Douteau
- Gabrielle Rit
- Jean Vintache
- 2014
- Fecherolle Cécile
## Presentation
This module is able to convert several [etherpad](http://etherpad.org/) files (exported as html files) to the hdoc format.
......@@ -28,7 +30,7 @@ This module is able to convert several [etherpad](http://etherpad.org/) files (e
- Chat
## Known bugs
Nested lists in lists are not supported
- Nested lists in lists are not supported
Example :
`<ul>
<li>
......@@ -39,6 +41,7 @@ Example :
</ul>
</li>
<ul>`
- As a consequence, etherpad indentation is not supported because it is coded as nested lists.
## TODO
- Markdown
......
Ce convertisseur permet de convertir des fichiers du format Hdoc (.hdoc) en contenus Optim de type papier (.paper) ou diaporama (.slideshow)
Il y a deux façons de réaliser votre conversion:
- Lancer le script run. Dans ce cas vous devez ajouter votre fichier .hdoc dans le dossier input. Veillez à ne placer qu'un seul fichier dans ce dossier. Le format par défaut utilisé pour le fichier cible est le type papier.
- En ligne de commande:
ant -buildfile hdoc_to_optim.ant
Vous pouvez spécifier le fichier input, avec le paramètre -DInputFile, et le format de sortie avec le paramètre -DDocType (paper ou slideshow). Les deux paramètres sont optionnels.
Exemple:
ant -buildfile hdoc_to_optim.ant -DDocType slideshow -DInputFile sample.hdoc
\ No newline at end of file
Converter hdoc_to_optim
-----------------------
The purpose of this converter is to obtain an Optim document (paper or slideshow) from a html file that complies the hdoc schema.
License GPL3.0
--------------
http://www.gnu.org/licenses/gpl-3.0.txt
Credits
-------
Rihab HACHEM, Perrine RAVAUD (2014).
Dependance
----------
No dependance needed.
User documentation
------------------
There are two different ways to use the converter hdoc_to_optim: by running a script run.bat/run.sh or by command line using a terminal.
--- Running the script run.bat/run.sh:
Use this method if you do not want to use a terminal. D1. Download hdoc_converter.zip and unzip it.2. Add your source file to the Input folder.
3. Place only one file in that folder.
4. If you are using Linux, run the script run.sh. If you are using Windows, run the script run.bat.
5. Your file has been converted, the result is in the Output folder.
6. You can now open it with OptimOffice.
The default output document type used by this script is an Optim paper.
--- Terminal:
By using the terminal you can specify some parameters to the conversion : the source file, or the output type (either a paper or a slideshow).
1. Download hdoc_converter.zip and unzip it.
2. Open your terminal and go into the folder hdoc_to_optim.
3. Run the following command:
"ant -buildfile hdoc_to_optim.ant"
You can specify the source file, and the output document type by adding parameters to that command.
Use -DInputFile to specify the source file.
Use -DDocType to specify if it's a paper or a slideshow.
Exemple :"ant -buildfile hdoc_to_optim.ant -DDocType slideshow -DInputFile sample.hdoc"
Both parameters are optional.Your file has been converted, you can open your paper with OptimOffice.
Unsupported
-----------
- In paper and slideshow :
Inline : Superscript, Subscript
SpanType : Latex , Syntax- In slideshow :
Metadata : Description, Keywords
Known bugs
----------
No known bugs now.
Todo
----
- Offer the possibility of creating a website, or a webmedia document.
- For the slideshow, find a way to transform the metadata information (description, keywords) into something similar.- Integrate Concept trees.
Technical notes
---------------
The converter contains 5 files:
- hdoc_to_optim.ant :
When you launch the Converter (whether through the script or a terminal) it's the file hdoc_to_optim.ant that is launched, and executes the following files.
- find_content.xsl :
This XSLT program runs through the hdoc file container.xml to retrieve the path of the file to convert and creates a ANT script get_content.ant.
- find_ressources.xsl :
This XSLT program runs through the content file of hdoc to retrieve the path of each audio files, images and objects used in it and creates a ANT script get_ressources.ant.
- transfo.xsl (paper) :
This XSLT program runs through the content file of hdoc and convert each hdoc tag in Optim tags if possible. It converts it to a paper.
- transfo2.xsl (slideshow) :
This XSLT program runs through the content file of hdoc and convert each hdoc tag in Optim tags if possible. It converts it to a slideshow.
- .wspmeta :
This file contains Optim metadata informations, it must be placed in the result of the conversion
Capitalisation
--------------
Thanks to this project I deepened my knowledge in XSLT, ANT, RelaxNG Schema, and HTML.
I learned how to use OptimOffice.
......
......@@ -5,7 +5,7 @@ Conversion of Freemind file(s) (.mm) to Hdoc
Licence
-------
GPL3.0
http://www.gnu.org/licenses/gpl-3.0.txt
Credits
-------
......@@ -21,28 +21,25 @@ This project aims at converting mindmapping files to hdoc files.
User documentation
------------------
Use a terminal and go to the root of the folder (mindmapping_to_hdoc).
#1 : You want to convert SEVERAL Freemind files in Hdoc
- Put your files in a folder mindmapping_to_hdoc/input
- Enter the command line corresponding to your OS :
- On Linux : sh run.sh
- On Windows : run.bat
* Use a terminal and go to the root of the folder (mindmapping_to_hdoc).
* Please refer to the part *Rules to follow* to understand the rules that can help you to personalize the output
* Put your files in a folder 'mindmapping_to_hdoc/input'
* Enter the command line corresponding to your OS :
* On Linux : 'sh run.sh'
* On Windows : 'run.bat'
If you want to convert one specific file that is in the input folder, use the parameters ' -DinputPath input/<yourFilename>' (ex : 'sh run.sh -DinputPath input/<yourFilename>')
#2 : You want to convert ONE specific freemindFile in Hdoc
- Put your file in a folder mindmapping_to_hdoc/input
- Enter the command line corresponding to your OS :
- On Linux : sh run.sh -DinputPath input/<yourFilename>
- On Windows : run.bat -DinputPath input/<yourFilename>
*You will find the result of the conversion in the folder mindmapping_to_hdoc/output*
*You can find a sample file il the folder /samples.*
You will find the result in the folder mindmapping_to_hdoc/result
You can use the converter mindmapping_to_opale in order to create Opale contents.
Unsupported
-----------
* Convert color
* Convert icon into summary elements.
* headers (especially keywords) are partially supported.
* Convert icon into summary elements
Known bugs
----------
......@@ -53,9 +50,8 @@ Known bugs
Todo
----
* Get mindmap from Framamind
* Mindmap to lexique conversion
* Mindmap to optim conversion
* Mindmap to Lexique conversion
* Mindmap to Optim conversion
Technical notes
---------------
......@@ -66,9 +62,6 @@ You can comment the part of code where temp directory is deleted in order to vie
What is META-INF folder ?
This is a simple folder with a xml file named 'content.xml' that contains useful information for Opale. Every .scar archives must contain this file, what it exactly does is not the purpose of this project.
Freemind / HDOC
-- INSERT doc_language.md --
Capitalisation
--------------
Mindmapping to Opale
=================
**Conversion of Freemind file(s) (.mm) to Opale**
Conversion of Freemind file(s) (.mm) to Opale (.scar)
## Licence
-------------------------------
......@@ -17,6 +17,10 @@ This section has been written by
It is based on the work of Guillaume GOMEZ in 2014.
## Presentation
The project aims at converting Freemind files in Opale files.
## Dependence
-------------------------------
In dependence with mindmapping_to_hdoc and hdoc_to_opale
......@@ -24,10 +28,7 @@ In dependence with mindmapping_to_hdoc and hdoc_to_opale
## User documentation
-------------------------------
Use a terminal and go to the root of the folder (mindmapping_to_opale).
### 1. You want to convert SEVERAL Freemind files in Opale
* Use a terminal and go to the root of the folder (mindmapping_to_opale).
* Please refer to the part *Rules to follow* to understand the rules that can help you to personalize the output
* Put your files in a folder 'mindmapping_to_opale/input'
* Enter the command line corresponding to your OS :
......
......@@ -4,8 +4,7 @@ Optim to Hdoc
Licence
-------
License GPL3.0
http://www.gnu.org/licenses/gpl-3.0.txt
This project is under [GPL 3.0](http://www.gnu.org/licenses/gpl-3.0.txt).
Credits
......
......@@ -87,7 +87,11 @@ Concerning tables :
3 - Display complex tables as tables in Opale (not as extern files)
Technical notes
---------------
For images you can refer to the get-ressources-with-meta.xsl and official-meta.xml. Read the commentary and it will help you
to finish the to do task regarding images. These files are included just for the seek of Capitalization.
Be aware of the following things
---------------------------------------------------------
1 - Not all images have a metadata information (only the ones who )
......
Getting started
Converter : Wikipedia To Opale
==============================
Licence :
---------------
GPL 3.0
http://www.gnu.org/licenses/gpl-3.0.txt
Credits :
---------------
Carrel Billiard Harold
Harriga Merouane
Lhomme Nicolas
Previous developers
Presentation
------------
Wikipedia to Opale is a converter that tronsform wikipedia pagaes to opale.
Use a terminal and go to the root of the folder (Wikipedia_to_opale).
Dependece
---------
- Wikipedia To Hdoc Converter
- Hdoc to Opale Converter
User Documentation
------------------
Generating .hdoc of a Wikipedia article with an URL
---------------------------------------------------
......@@ -42,4 +72,24 @@ Generating .hdoc of a Wikipedia article with a local file
BUG
---
1 - Linux sh files doesn't work with UTC proxy but works outside UTC
\ No newline at end of file
1 - Linux sh files doesn't work with UTC proxy but works outside UTC
Unsupported
-----------
1 Images:
- images inside text are not supported because of schema validation.
Known Bugs
----------
To do
-----
Technical notes
---------------
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