README.md 2.88 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 8
Licence
-------
GPL3.0
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 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
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

#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 in the folder mindmapping_to_hdoc/result

40 41 42
Unsupported
-----------

43 44 45
* Convert color
* Convert icon into summary elements.
* headers (especially keywords) are partially supported.
46

47 48 49
Known bugs
----------

50 51
* 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.
52

53 54 55
Todo
----

56 57 58
* Get mindmap from Framamind
* Mindmap to lexique conversion
* Mindmap to optim conversion
59

60 61
Technical notes
---------------
62 63 64 65 66 67 68 69 70
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.

Freemind / HDOC 

71
-- INSERT doc_language.md --
72 73 74

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