Commit 61b96be8 authored by Ivan D'halluin's avatar Ivan D'halluin

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

parents 05e933c6 0e2e3f72
This diff is collapsed.
This diff is collapsed.
Mindmapping to HDOC
===================
Converter Mindmapping2HDOC
==========================
Conversion of Freemind file(s) (.mm) to Hdoc
# How to use the converter
Licence
-------
GPL3.0
Credits
-------
* Amélie Perdriaud
* Thibault Brocheton
* Bastien Frémondière
* Guillaume Gomez
Presentation
------------
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
......@@ -21,3 +37,38 @@ Use a terminal and go to the root of the folder (mindmapping_to_hdoc).
You will find the result in the folder mindmapping_to_hdoc/result
Unsupported
-----------
* Convert color
* Convert icon into summary elements.
* headers (especially keywords) are partially supported.
Known bugs
----------
* 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.
Todo
----
* Get mindmap from Framamind
* Mindmap to lexique conversion
* Mindmap to optim conversion
Technical notes
---------------
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
-- INSERT doc_language.md --
Capitalisation
--------------
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
Converter : Wikipedia_to_Hdoc
---------------
Licence :
---------------
GPL 3.0
http://www.gnu.org/licenses/gpl-3.0.txt
Credits :
---------------
Carrel Billiard Harold
Harriga Merouane
Lhomme Nicolas
Previous developers
Getting started
---------------
......@@ -45,9 +65,12 @@ To do
Concerning images :
1 - Extract the metadata information from the meta.xml file for each image. You can do that by creating an XSL file that will be called from the ant task generated by xslt/get_ressources_urls.xsl. In that file you have the hand on each meta.xml File.
2 - Verify that images are well zipped to avoid any problem while testing in Opale
3 - Images inside paragraphs break the validation of the hdoc schema, do a preposition to change the schema and handle that.
Concerning listings :
1 - Succeed in finding the language of the part of code of the wikipedia article
......@@ -56,8 +79,11 @@ Concerning listings :
Concerning tables :
1 - Solve the encoding problem,
2 - Change Hdoc Scheme in order to accept images in tables?
3 - Display complex tables as tables in Opale (not extern files)
3 - Display complex tables as tables in Opale (not as extern files)
Be aware of the following things
---------------------------------------------------------
......@@ -66,4 +92,11 @@ Be aware of the following things
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 of UTC.
2 - Random errors might occur
Wikipedia is a great tool : everyone can participe. However, it does not provide contributors with best practices that everyone follows. The result is a lot of different ways to write articles. This is why this converter might not handle some situations (even if all files I have tried worked), and it might not be able to output some Wikipedia articles at its current state.
3 - Small issues with Opale
Links can be invisible if you use an old version of Opale. This is not a problem coming from the Wikipedia to Hdoc converter. Make sure you use an updated version of Opale to test your scar archives.
Another thing is that Opale might indicate that the scar file contains errors once imported. Actually, these "errors" are warnings. The archives work, as they were validated when making the scar file. These warnings come from Opale, but you can ignore them.
\ No newline at end of file
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