README.md 2.43 KB
Newer Older
1 2
Converter Mindmapping2HDOC
==========================
3

aperdria's avatar
aperdria committed
4
Conversion of Freemind file(s) (.mm) to Hdoc.
5

6 7
Licence
-------
aperdria's avatar
aperdria committed
8
http://www.gnu.org/licenses/gpl-3.0.txt
9

10 11
Credits
-------
12

13 14 15 16
* Amélie Perdriaud
* Thibault Brocheton
* Bastien Frémondière
* Guillaume Gomez
17 18 19

Presentation
------------
aperdria's avatar
aperdria committed
20
This project aims at converting mindmapping files (.mm) to hdoc files. If you use another tool to create mindmapping files, you can probably export it to a .mm file and use it in this converter.
21 22 23

User documentation
------------------
24

aperdria's avatar
aperdria committed
25 26
* 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
aperdria's avatar
aperdria committed
27
* Put your files in a folder 'mindmapping_to_hdoc/input'. The file has to be a Freemind file (.mm).
aperdria's avatar
aperdria committed
28 29 30 31
* 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>')
32

aperdria's avatar
aperdria committed
33 34
*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.*
35

aperdria's avatar
aperdria committed
36
You can use the converter mindmapping_to_opale in order to create Opale contents.
37

38 39 40
Unsupported
-----------

41
* Convert color
aperdria's avatar
aperdria committed
42
* Convert icon into summary elements
43

44 45 46 47 48 49
Known bugs
----------

Todo
----

aperdria's avatar
aperdria committed
50 51
* Mindmap to Lexique conversion
* Mindmap to Optim conversion
aperdria's avatar
aperdria committed
52
* Check the compatibility of version and software (files exported from Xmind etc.)
53

54 55
Technical notes
---------------
56 57 58 59 60 61 62
This converter is using standard NF29 conversion project structure : I use a main ANT file (named mapMapping2Hdoc.ant), which handles routine tasks (zipping archives, copying files, order tasks), XSL-XSLT transformation scripts calls. This main ANT file is composed of several targets.
During the conversion process, I use a few temporary files stored in a temp folder : their content depends on hdoc's files (such as "container.xml", "content.xml" and ressource files). See details below.
You can comment the part of code where temp directory is deleted in order to view raw files directly instead of unzipping hdoc file.

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.

63 64 65

Capitalisation
--------------