Commit ed6461d0 authored by Hachem Rihab's avatar Hachem Rihab
Browse files

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

parents b4664a3f 042ec9aa
...@@ -5,7 +5,7 @@ Conversion of Freemind file(s) (.mm) to Hdoc ...@@ -5,7 +5,7 @@ Conversion of Freemind file(s) (.mm) to Hdoc
Licence Licence
------- -------
GPL3.0 http://www.gnu.org/licenses/gpl-3.0.txt
Credits Credits
------- -------
...@@ -21,28 +21,25 @@ This project aims at converting mindmapping files to hdoc files. ...@@ -21,28 +21,25 @@ This project aims at converting mindmapping files to hdoc files.
User documentation 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 * Use a terminal and go to the root of the folder (mindmapping_to_hdoc).
- Put your files in a folder mindmapping_to_hdoc/input * Please refer to the part *Rules to follow* to understand the rules that can help you to personalize the output
- Enter the command line corresponding to your OS : * Put your files in a folder 'mindmapping_to_hdoc/input'
- On Linux : sh run.sh * Enter the command line corresponding to your OS :
- On Windows : run.bat * 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 *You will find the result of the conversion in the folder mindmapping_to_hdoc/output*
- Put your file in a folder mindmapping_to_hdoc/input *You can find a sample file il the folder /samples.*
- 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 in the folder mindmapping_to_hdoc/result You can use the converter mindmapping_to_opale in order to create Opale contents.
Unsupported Unsupported
----------- -----------
* Convert color * Convert color
* Convert icon into summary elements. * Convert icon into summary elements
* headers (especially keywords) are partially supported.
Known bugs Known bugs
---------- ----------
...@@ -53,9 +50,8 @@ Known bugs ...@@ -53,9 +50,8 @@ Known bugs
Todo Todo
---- ----
* Get mindmap from Framamind * Mindmap to Lexique conversion
* Mindmap to lexique conversion * Mindmap to Optim conversion
* Mindmap to optim conversion
Technical notes Technical notes
--------------- ---------------
...@@ -66,9 +62,6 @@ You can comment the part of code where temp directory is deleted in order to vie ...@@ -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 ? 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. 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 Capitalisation
-------------- --------------
Mindmapping to Opale Mindmapping to Opale
================= =================
**Conversion of Freemind file(s) (.mm) to Opale** Conversion of Freemind file(s) (.mm) to Opale (.scar)
## Licence ## Licence
------------------------------- -------------------------------
...@@ -17,6 +17,10 @@ This section has been written by ...@@ -17,6 +17,10 @@ This section has been written by
It is based on the work of Guillaume GOMEZ in 2014. It is based on the work of Guillaume GOMEZ in 2014.
## Presentation
The project aims at converting Freemind files in Opale files.
## Dependence ## Dependence
------------------------------- -------------------------------
In dependence with mindmapping_to_hdoc and hdoc_to_opale In dependence with mindmapping_to_hdoc and hdoc_to_opale
...@@ -24,10 +28,7 @@ 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 ## User documentation
------------------------------- -------------------------------
Use a terminal and go to the root of the folder (mindmapping_to_opale). * Use a terminal and go to the root of the folder (mindmapping_to_opale).
### 1. You want to convert SEVERAL Freemind files in Opale
* Please refer to the part *Rules to follow* to understand the rules that can help you to personalize the output * 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' * Put your files in a folder 'mindmapping_to_opale/input'
* Enter the command line corresponding to your OS : * Enter the command line corresponding to your OS :
......
...@@ -87,7 +87,11 @@ Concerning tables : ...@@ -87,7 +87,11 @@ Concerning tables :
3 - Display complex tables as tables in Opale (not as extern files) 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 Be aware of the following things
--------------------------------------------------------- ---------------------------------------------------------
1 - Not all images have a metadata information (only the ones who ) 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 Generating .hdoc of a Wikipedia article with an URL
--------------------------------------------------- ---------------------------------------------------
...@@ -42,4 +72,24 @@ Generating .hdoc of a Wikipedia article with a local file ...@@ -42,4 +72,24 @@ Generating .hdoc of a Wikipedia article with a local file
BUG BUG
--- ---
1 - Linux sh files doesn't work with UTC proxy but works outside UTC 1 - Linux sh files doesn't work with UTC proxy but works outside UTC
\ No newline at end of file
Unsupported
-----------
1 Images:
- images inside text are not supported because of schema validation.
Known Bugs
----------
To do
-----
Technical notes
---------------
Capitalisation
--------------
Supports Markdown
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