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

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

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

10
11
Credits
-------
12

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

Presentation
------------
This project aims at converting mindmapping files to hdoc files.
21
22
23

User documentation
------------------
aperdria's avatar
aperdria committed
24

aperdria's avatar
aperdria committed
25
26
27
28
29
30
31
* 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>')
aperdria's avatar
aperdria committed
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.*
aperdria's avatar
aperdria committed
35

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

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

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

44
45
46
Known bugs
----------

47
48
* All hdoc samples given in the "Download" section have been tested and should work well. If you want to use your own hdoc files, make sure that container.xml's root contains version="1.0" and xmlns="urn:utc.fr:ics:hdoc:container" attributes. Otherwise ant building will fail.
* It is not specified in hdoc's standard but I assume that hdoc's content file (usually named "content.xml") fullpath is a relative path that begins at the root of the hdoc archive. That means that the full-path attribute of <rootfile> (in container.xml) begins with a character, and not a special sequence such as ".", ".." or "/". It is already the case for my samples, but if you want to use your own samples make sure this full-path attribute is ok.
49

50
51
52
Todo
----

aperdria's avatar
aperdria committed
53
54
* Mindmap to Lexique conversion
* Mindmap to Optim conversion
55

56
57
Technical notes
---------------
58
59
60
61
62
63
64
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.

65
66
67

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