Commit e1e0521b authored by Mar60's avatar Mar60

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

parents cc6ffd8e fd348ae9
# HDOC CONVERTER PROJECT # Hdoc Converter Projet
License GPL3.0
http://www.gnu.org/licenses/gpl-3.0.txt
Credits :
Université de Technologie de Compiègne (http://www.utc.fr)
NF29 students (http://www4.utc.fr/~nf29)
## What is Hdoc ? ## What is Hdoc ?
Please refer to the [Hdoc converter project website](http://hdoc.crzt.fr/www/co/hdocConverter.html) Please refer to the Hdoc Converter Project website:
>The aim of the project is to propose:
>- a generic XML schema based on XHTML5 for documentary purpose (Hdoc format); http://hdoc.crzt.fr
>- a set of converters to transform document formats from and to Hdoc;
>- a web site to manage the converters (Hdoc Converter Portal).
## What is this repository ? ## What is this repository ?
This repository gathers some of the Hdoc converters, if not all of them.
Project URL : https://gitlab.utc.fr/crozatst/hdoc.git
## How to use Hdoc Converters ?
This repository gathers some of the Hdoc converters, if not all of them. In order to use a converter, choose the corresponding folder and consult README.md for instructions.
\ No newline at end of file
# antce
"antce" is not for use, it is just a base for autonomous multi-OS ANT launcher
# Etherpad to Hdoc -- HDOC CONVERTER PROJECT # Converter etherpad_to_hdoc
## [TL;DR](http://i.imgur.com/18B7f07.jpg)
- This module is able to convert several [etherpad](http://etherpad.org/) files (exported as html files) to the hdoc format. ## License
- To do so : License GPL3.0
1. please place your html files in the `/input` folder http://www.gnu.org/licenses/gpl-3.0.txt
## Crédits
- 2015
- Jean-Côme Douteau
- Gabrielle Rit
- Jean Vintache
- 2014
- Fecherolle Cécile
## Presentation
This module is able to convert several [etherpad](http://etherpad.org/) files (exported as html files) to the hdoc format.
## User documentation
### Running etherpad_to_hdoc.ant
1. Create an etherpad document and export it as an html file.
1. please place your html files in the `/input` folder
2. run the `run.[bat|sh]` script of your choice depending on your OS 2. run the `run.[bat|sh]` script of your choice depending on your OS
3. and retrieve the hdoc outputs in the `/output` folder 3. and retrieve the hdoc outputs in the `/output` folder
## Unsupported
- Markdown
- Author paternity
- Etherpad timeline
- Chat
## Known bugs
- Nested lists in lists are not supported
Example :
`<ul>
<li>
<ul>
<li>
Never gonna give you up.
</li>
</ul>
</li>
<ul>`
- As a consequence, etherpad indentation is not supported because it is coded as nested lists.
## TODO
- Markdown
## Technical notes
### Description of etherpad_to_hdoc.ant
#### Prelude
- Importation of necessary classes (antlib, htmlcleaner, jing)
- Creation of directories architecture tree
#### Transformations
- Use of htmlcleaner to transform the input file from html to xhtml. For more info, see http://htmlcleaner.sourceforge.net/index.php.
- Apply html2xhtml.xsl : this xsl extracts the content into <body> tags
- Apply html2xhtmlv1.xsl : this xsl is used as a fix and adds br tag at the end of lists (ul and ol)
- Apply html2xhtmlv2.xsl : this xsl surround text line with p tags and transforms non-hdoc tags into hdoc tags as s, u, strong tags.
- Apply html2xhtml3.xsl : this xsl is used as a fix, it deletes p tags when its child is ul or ol
- Apply xhtml2hdoc.xsl : this xsl transforms the content into hdoc structure
#### Post-transformations actions
- Build hdoc structure
- Jing checks if the output file is validated with the right rng schema
- Zip the directory into hdoc archive
### Supported tags
html tags -> hdoc tags
- u, s, em, strong -> em
- li -> li
- ol -> ol
- br -> p
## Capitalisation
We learned how to use xsl sheets with text file as an input : we had to use regular expressions to extract content.
\ No newline at end of file
# Etherpad To Lexique -- HDOC CONVERTER PROJECT # Etherpad2Lexique -- HDOC CONVERTER PROJECT
Comment récupérer un document de type Etherpad et le transformer en document lexique. ## License
[GPL 3.0](http://www.gnu.org/licenses/gpl-3.0.txt)
*les chemins d'accès indiqués sont relatifs à ce fichier readme* ## Credits
- Rit Gabrielle
1. Télécharger un document Etherpad en format HTML - Vintache Jean
1. Créer ou rejoindre un document etherpad puis l'exporter sous un format html (bouton `Importer/Exporter`) - Douteau Jean-Côme
2. **Enregistrer le document sous le nom `pad.html`** dans le dossier `/input` (si le dossier n'existe pas, le créer) - Fecherolle Cécile (2014)
NB: il ne doit pour le moment n'y avoir qu'un seul fichier nommé de cette façon. ##Presentation
2. Exécuter le fichier `/run.bat` ou `/run.sh` selon l'OS ; un fichier `.scar` est créé dans le dossier `/output` How to transform an etherpad document in lexique document.
3. Ouvrir le document produit avec lexique Filepath in this document are relative to this file readme.
1. Ouvrir Scenari, ouvrir la liste des entrepôts distants et choisir UTC-etu_lexique. ## Dependence
2. Aller dans le dossier sandBox/etherpad-to-lexique. - Etherpad2Hdoc
3. Réaliser un cliquer glisser avec votre fichier `.scar` dans le dossier ou bien faire un clic droit sur le dossier puis Importer. - Hdoc2Lexique
4. Ouvrir le fichier Main.xml nouvellement créé. ## User Documentation
\ No newline at end of file 1. Download an etherpad document in html format.
1. Create or join an etherpad document then export it in html format (Import/Export Button) in the `/input` directory (if the directory does not exists, you have to create it).
2. Name it pad.html
2. Execute the file `/run.bat` or `/run.sh` depending on the OS. A `.scar` file is created in the directory `/output`
*If the `/input` directory contains multiple files, they won't be all treated.
3. Open the document with Scenari
1. Open Scenari, and choose "UTC-etu_lexique" as distant depot.
2. Go in the directory `sandBox/etherpad-to-lexique.`
3. Import your `.scar` file in the directory.
4. Open the file Main.xml created.
##Unsupported
- MarkDown
- Timeline and author paternity
- Chat
##Known bugs
Nested lists in lists are not supported
example :
`<ul>
<li>
<ul>
<li>
Never gonna let you down.
</li>
</ul>
</li>
<ul>`
## TODO
- Work with markdown
- Correct nested lists
## Technical notes
### Description of etherpad_to_hdoc.ant
#### Prelude
- Importation of necessary classes (antlib, htmlcleaner, jing)
- Creation of directories architecture tree
#### Transformations
- Use of htmlcleaner to transform the input file from html to xhtml. For more info, see http://htmlcleaner.sourceforge.net/index.php.
- Apply html2xhtml.xsl : this xsl extracts the content into <body> tags
- Apply html2xhtmlv1.xsl : this xsl is used as a fix and adds br tag at the end of lists (ul and ol)
- Apply html2xhtmlv2.xsl : this xsl surround text line with p tags and transforms non-hdoc tags into hdoc tags as s, u, strong tags.
- Apply html2xhtml3.xsl : this xsl is used as a fix, it deletes p tags when its child is ul or ol
- Apply xhtml2hdoc.xsl : this xsl transforms the content into hdoc structure
#### Post-transformations actions
- Build hdoc structure
- Jing checks if the output file is validated with the right rng schema
- Zip the directory into hdoc archive
## Capitalisation
# Etherpad To Opale -- HDOC CONVERTER PROJECT # Etherpad2Opale -- HDOC CONVERTER PROJECT
Comment récupérer un document de type Etherpad et le transformer en document opale. ## License
[GPL 3.0](http://www.gnu.org/licenses/gpl-3.0.txt)
*les chemins d'accès indiqués sont relatifs à ce fichier readme* ## Credits
- Rit Gabrielle
1. Télécharger un document Etherpad en format HTML - Vintache Jean
1. Créer ou rejoindre un document etherpad puis l'exporter sous un format html (bouton `Importer/Exporter`) dans le dossier `/input` (si le dossier n'existe pas, le créer) - Douteau Jean-Côme
2. Exécuter le fichier `/run.bat` ou `/run.sh` selon l'OS ; un fichier `.scar` est créé dans le dossier `/output` - Fecherolle Cécile (2014)
*si le dossier `/input` contient plusieurs fichiers html, ils sont tous traités* ##Presentation
3. Ouvrir le document produit avec opale How to transform an etherpad document in opale document.
1. Ouvrir Scenari, ouvrir la liste des entrepôts distants et choisir UTC-etu_opale. Filepath in this document are relative to this file readme.
2. Aller dans le dossier sandBox/etherpad-to-opale. ## Dependence
3. Réaliser un cliquer glisser avec votre fichier `.scar` dans le dossier ou bien faire un clic droit sur le dossier puis Importer. - Etherpad2Hdoc
4. Ouvrir le fichier Main.xml nouvellement créé. - Hdoc2Opale
## User Documentation
1. Download an etherpad document in html format.
1. Create or join an etherpad document then export it in html format (Import/Export Button) in the `/input` directory (if the directory does not exists, you have to create it).
2. Execute the file `/run.bat` or `/run.sh` depending on the OS. A `.scar` file is created in the directory `/output`
*If the `/input` directory contains multiple files, they will be all treated.
3. Open the document with Opale
1. Open Scenari, and choose "UTC-etu_opale" as distant depot.
2. Go in the directory `sandBox/etherpad-to-opale.`
3. Import your `.scar` file in the directory.
4. Open the file Main.xml created.
##Unsupported
- MarkDown
- Timeline and author paternity
- Chat
##Known bugs
Nested lists in lists are not supported
example :
`<ul>
<li>
<ul>
<li>
Never gonna give you up.
</li>
</ul>
</li>
<ul>`
## TODO
- Work with markdown
- Correct nested lists
## Technical notes
### Description of etherpad_to_hdoc.ant
#### Prelude
- Importation of necessary classes (antlib, htmlcleaner, jing)
- Creation of directories architecture tree
#### Transformations
- Use of htmlcleaner to transform the input file from html to xhtml. For more info, see http://htmlcleaner.sourceforge.net/index.php.
- Apply html2xhtml.xsl : this xsl extracts the content into <body> tags
- Apply html2xhtmlv1.xsl : this xsl is used as a fix and adds br tag at the end of lists (ul and ol)
- Apply html2xhtmlv2.xsl : this xsl surround text line with p tags and transforms non-hdoc tags into hdoc tags as s, u, strong tags.
- Apply html2xhtml3.xsl : this xsl is used as a fix, it deletes p tags when its child is ul or ol
- Apply xhtml2hdoc.xsl : this xsl transforms the content into hdoc structure
#### Post-transformations actions
- Build hdoc structure
- Jing checks if the output file is validated with the right rng schema
- Zip the directory into hdoc archive
## Capitalisation
# Etherpad To Optim -- HDOC CONVERTER PROJECT # Etherpad2Optim -- HDOC CONVERTER PROJECT
Comment récupérer un document de type Etherpad et le transformer en document optim. ## License
[GPL 3.0](http://www.gnu.org/licenses/gpl-3.0.txt)
*les chemins d'accès indiqués sont relatifs à ce fichier readme* ## Credits
- Rit Gabrielle
1. Télécharger un document Etherpad en format HTML - Vintache Jean
1. Créer ou rejoindre un document etherpad puis l'exporter sous un format html (bouton `Importer/Exporter`) - Douteau Jean-Côme
2. **Enregistrer le document sous le nom `pad.html`** dans le dossier `/input` (si le dossier n'existe pas, le créer) - Fecherolle Cécile (2014)
NB: il ne doit pour le moment n'y avoir qu'un seul fichier nommé de cette façon. ##Presentation
2. Exécuter le fichier `/run.bat` ou `/run.sh` selon l'OS ; un fichier `.scar` est créé dans le dossier `/output` How to transform an etherpad document in optim document.
3. Ouvrir le document produit avec optim Filepath in this document are relative to this file readme.
1. Ouvrir Scenari, ouvrir la liste des entrepôts distants et choisir UTC-etu_optim. ## Dependence
2. Aller dans le dossier sandBox/etherpad-to-optim. - Etherpad2Hdoc
3. Réaliser un cliquer glisser avec votre fichier `.scar` dans le dossier ou bien faire un clic droit sur le dossier puis Importer. - Hdoc2Optim
4. Ouvrir le fichier Main.xml nouvellement créé. ## User Documentation
1. Download an etherpad document in html format.
1. Create or join an etherpad document then export it in html format (Import/Export Button) in the `/input` directory (if the directory does not exists, you have to create it).
2. Name it pad.html
2. Execute the file `/run.bat` or `/run.sh` depending on the OS. A `.scar` file is created in the directory `/output`
*If the `/input` directory contains multiple files, they won't be all treated.
3. Open the document with Scenari
1. Open Scenari, and choose "UTC-etu_optim" as distant depot.
2. Go in the directory `sandBox/etherpad-to-otpim.`
3. Import your `.scar` file in the directory.
4. Open the file Main.xml created.
##Unsupported
- MarkDown
- Timeline and author paternity
- Chat
##Known bugs
Nested lists in lists are not supported
example :
`<ul>
<li>
<ul>
<li>
Never gonna let you down.
</li>
</ul>
</li>
<ul>`
## TODO
- Work with markdown
- Correct nested lists
## Technical notes
### Description of etherpad_to_hdoc.ant
#### Prelude
- Importation of necessary classes (antlib, htmlcleaner, jing)
- Creation of directories architecture tree
#### Transformations
- Use of htmlcleaner to transform the input file from html to xhtml. For more info, see http://htmlcleaner.sourceforge.net/index.php.
- Apply html2xhtml.xsl : this xsl extracts the content into <body> tags
- Apply html2xhtmlv1.xsl : this xsl is used as a fix and adds br tag at the end of lists (ul and ol)
- Apply html2xhtmlv2.xsl : this xsl surround text line with p tags and transforms non-hdoc tags into hdoc tags as s, u, strong tags.
- Apply html2xhtml3.xsl : this xsl is used as a fix, it deletes p tags when its child is ul or ol
- Apply xhtml2hdoc.xsl : this xsl transforms the content into hdoc structure
#### Post-transformations actions
- Build hdoc structure
- Jing checks if the output file is validated with the right rng schema
- Zip the directory into hdoc archive
## Capitalisation
...@@ -5,14 +5,14 @@ ...@@ -5,14 +5,14 @@
> >
<xsl:output method="xml" indent="yes" encoding="UTF-8"/> <xsl:output method="xml" indent="yes" encoding="UTF-8"/>
<xsl:param name="filename"/> <xsl:param name="filename"/>
<!-- This template matches the root and create a ANT project, the root of any ANT buildfile. --> <!-- This template matches the root and create a ANT project, the root of any ANT buildfile. -->
<xsl:template match="h:html"> <xsl:template match="h:html">
<project name="moveRessourceFiles" basedir="." default="moveRessourceFiles"> <project name="moveRessourceFiles" basedir="." default="moveRessourceFiles">
<property file="global.properties"/> <property file="global.properties"/>
<property name="filename" location="{$filename}"/> <property name="filename2" location="{$filename}"/>
<target name="moveRessourceFiles"> <target name="moveRessourceFiles">
<xsl:apply-templates select="./*"/> <xsl:apply-templates select="./*"/>
</target> </target>
...@@ -32,16 +32,16 @@ ...@@ -32,16 +32,16 @@
<!-- Targeted markups. --> <!-- Targeted markups. -->
<xsl:template match="h:img"> <xsl:template match="h:img">
<copy tofile="${{filename}}/decompressedOpale/res/{./@src}" file="${{filename}}/decompressedHdoc/{./@src}"/> <copy tofile="${{filename2}}/decompressedOpale/res/{./@src}" file="${{filename2}}/decompressedHdoc/{./@src}"/>
</xsl:template> </xsl:template>
<xsl:template match="h:audio"> <xsl:template match="h:audio">
<copy tofile="${{filename}}/decompressedOpale/res/{./@src}" file="${{filename}}/decompressedHdoc/{./@src}"/> <copy tofile="${{filename2}}/decompressedOpale/res/{./@src}" file="${{filename2}}/decompressedHdoc/{./@src}"/>
</xsl:template> </xsl:template>
<xsl:template match="h:video"> <xsl:template match="h:video">
<copy tofile="${{filename}}/decompressedOpale/res/{./@src}" file="${{filename}}/decompressedHdoc/{./@src}"/> <copy tofile="${{filename2}}/decompressedOpale/res/{./@src}" file="${{filename2}}/decompressedHdoc/{./@src}"/>
</xsl:template> </xsl:template>
<xsl:template match="h:object"> <xsl:template match="h:object">
<copy tofile="${{filename}}/decompressedOpale/res/{./@data}" file="${{filename}}/decompressedHdoc/{./@data}"/> <copy tofile="${{filename2}}/decompressedOpale/res/{./@data}" file="${{filename2}}/decompressedHdoc/{./@data}"/>
</xsl:template> </xsl:template>
<!-- These markups are matched in order to minimize "apply-templates" side-effects (i.e. their contents are not relevant for this transformation). --> <!-- These markups are matched in order to minimize "apply-templates" side-effects (i.e. their contents are not relevant for this transformation). -->
......
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
<property name="lib" location="${{basedir}}/lib"/> <property name="lib" location="${{basedir}}/lib"/>
<property name="log" location="${{basedir}}/log"/> <property name="log" location="${{basedir}}/log"/>
<property name="schema" location="${{basedir}}/schema"/> <property name="schema" location="${{basedir}}/schema"/>
<property name="filename" location="{$filename}"/> <property name="filename" location="${$filename}"/>
<taskdef name="jing" classname="com.thaiopensource.relaxng.util.JingTask"> <taskdef name="jing" classname="com.thaiopensource.relaxng.util.JingTask">
<classpath> <classpath>
<pathelement location="../${lib}/jing.jar"/> <pathelement location="../${lib}/jing.jar"/>
......
...@@ -36,7 +36,7 @@ ...@@ -36,7 +36,7 @@
style="${{xsl}}/moveRessourceFiles.xsl" style="${{xsl}}/moveRessourceFiles.xsl"
processor="org.apache.tools.ant.taskdefs.optional.TraXLiaison" processor="org.apache.tools.ant.taskdefs.optional.TraXLiaison"
> >
<param name="filename" expression="${{tmp}}/${{filename}}"/> <param name="filename" expression="${{tmp}}\${{filename}}"/>
</xslt> </xslt>
<chmod file="${{tmp}}/${{filename}}/moveRessourceFiles.xml" perm="777"/> <chmod file="${{tmp}}/${{filename}}/moveRessourceFiles.xml" perm="777"/>
<xslt <xslt
......
Ce convertisseur permet de convertir des fichiers du format Hdoc (.hdoc) en contenus Optim de type papier (.paper) ou diaporama (.slideshow) Converter hdoc_to_optim
-----------------------
Il y a deux façons de réaliser votre conversion:
The purpose of this converter is to obtain an Optim document (paper or slideshow) from a html file that complies the hdoc schema.
- Lancer le script run. Dans ce cas vous devez ajouter votre fichier .hdoc dans le dossier input. Veillez à ne placer qu'un seul fichier dans ce dossier. Le format par défaut utilisé pour le fichier cible est le type papier.
License GPL3.0
--------------
- En ligne de commande:
http://www.gnu.org/licenses/gpl-3.0.txt
ant -buildfile hdoc_to_optim.ant
Vous pouvez spécifier le fichier input, avec le paramètre -DInputFile, et le format de sortie avec le paramètre -DDocType (paper ou slideshow). Les deux paramètres sont optionnels. Credits
-------
Exemple:
Rihab HACHEM, Perrine RAVAUD (2014).
ant -buildfile hdoc_to_optim.ant -DDocType slideshow -DInputFile sample.hdoc
\ No newline at end of file
Dependance
----------
No dependance needed.
User documentation
------------------
There are two different ways to use the converter hdoc_to_optim: by running a script run.bat/run.sh or by command line using a terminal.
--- Running the script run.bat/run.sh:
Use this method if you do not want to use a terminal. D1. Download hdoc_converter.zip and unzip it.2. Add your source file to the Input folder.
3. Place only one file in that folder.
4. If you are using Linux, run the script run.sh. If you are using Windows, run the script run.bat.
5. Your file has been converted, the result is in the Output folder.
6. You can now open it with OptimOffice.
The default output document type used by this script is an Optim paper.
--- Terminal:
By using the terminal you can specify some parameters to the conversion : the source file, or the output type (either a paper or a slideshow).
1. Download hdoc_converter.zip and unzip it.
2. Open your terminal and go into the folder hdoc_to_optim.
3. Run the following command:
"ant -buildfile hdoc_to_optim.ant"
You can specify the source file, and the output document type by adding parameters to that command.
Use -DInputFile to specify the source file.
Use -DDocType to specify if it's a paper or a slideshow.
Exemple :"ant -buildfile hdoc_to_optim.ant -DDocType slideshow -DInputFile sample.hdoc"
Both parameters are optional.Your file has been converted, you can open your paper with OptimOffice.
Unsupported
-----------
- In paper and slideshow :
Inline : Superscript, Subscript
SpanType : Latex , Syntax- In slideshow :
Metadata : Description, Keywords
Known bugs
----------
No known bugs now.
Todo
----
- Offer the possibility of creating a website, or a webmedia document.
- For the slideshow, find a way to transform the metadata information (description, keywords) into something similar.- Integrate Concept trees.
Technical notes
---------------
The converter contains 5 files:
- hdoc_to_optim.ant :
When you launch the Converter (whether through the script or a terminal) it's the file hdoc_to_optim.ant that is launched, and executes the following files.
- find_content.xsl :
This XSLT program runs through the hdoc file container.xml to retrieve the path of the file to convert and creates a ANT script get_content.ant.
- find_ressources.xsl :
This XSLT program runs through the content file of hdoc to retrieve the path of each audio files, images and objects used in it and creates a ANT script get_ressources.ant.
- transfo.xsl (paper) :
This XSLT program runs through the content file of hdoc and convert each hdoc tag in Optim tags if possible. It converts it to a paper.
- transfo2.xsl (slideshow) :
This XSLT program runs through the content file of hdoc and convert each hdoc tag in Optim tags if possible. It converts it to a slideshow.
- .wspmeta :
This file contains Optim metadata informations, it must be placed in the result of the conversion
Capitalisation
--------------
Thanks to this project I deepened my knowledge in XSLT, ANT, RelaxNG Schema, and HTML.
I learned how to use OptimOffice.
......
...@@ -55,7 +55,7 @@ ...@@ -55,7 +55,7 @@
</target> </target>
<target name="buildOutput" depends="unzipSource"> <target name="buildOutput" depends="unzipSource">
<xslt classpath="${libdir}/saxon9he.jar" style="${xsldir}/termToRef.xsl" basedir="${srcdir}" destdir="${OutputPath}" followsymlinks="false" extension=".ref"> <xslt classpath="${libdir}/saxon9he.jar" style="${xsldir}/termToRdf.xsl" basedir="${srcdir}" destdir="${OutputPath}" followsymlinks="false" extension=".rdf">
<include name="**/*.term"/> <include name="**/*.term"/>
</xslt> </xslt>
<copy file="opale.wspmeta" tofile="${OutputPath}/.wspmeta"></copy> <copy file="opale.wspmeta" tofile="${OutputPath}/.wspmeta"></copy>
...@@ -71,4 +71,4 @@ ...@@ -71,4 +71,4 @@
<delete dir="${outdir}" /> <delete dir="${outdir}" />
</target> </target>
</project> </project>
\ No newline at end of file
...@@ -4,11 +4,9 @@ ...@@ -4,11 +4,9 @@
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:ont="nf29ont" xmlns:ont="nf29ont"
xmlns:sp="http://www.utc.fr/ics/scenari/v3/primitive" xmlns:sp="http://www.utc.fr/ics/scenari/v3/primitive"
xmlns:sc="http://www.utc.fr/ics/scenari/v3/core" xmlns:sc="http://www.utc.fr/ics/scenari/v3/core"
xmlns:lx="scpf.org:lexicon" xmlns:lx="scpf.org:lexicon"
xmlns:op="utc.fr:ics/opale3" exclude-result-prefixes="xs sp sc lx"
exclude-result-prefixes="xs"
version="2.0"> version="2.0">
<xsl:output method="xml" indent="yes" /> <xsl:output method="xml" indent="yes" />
......
...@@ -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 HDOC Mindmapping to Opale
=================== =================
Conversion of Freemind file(s) (.mm) to Opale Conversion of Freemind file(s) (.mm) to Opale (.scar)
# How to use the converter ## Licence
-------------------------------
http://www.gnu.org/licenses/gpl-3.0.txt
Use a terminal and go to the root of the folder (mindmapping_to_opale). ## Credits
-------------------------------
This section has been written by
#1 : You want to convert SEVERAL Freemind files in Opale * Thibault BROCHETON
- Put your files in a folder mindmapping_to_opale/input * Bastien FREMONDIERE
- Enter the command line corresponding to your OS : * Amélie PERDRIAUD
- On Linux : sh run.sh
- On Windows : run.bat
#2 : You want to convert ONE specific freemindFile in Opale It is based on the work of Guillaume GOMEZ in 2014.
- Put your file in a folder mindmapping_to_opale/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_opale/output ## Presentation
The project aims at converting Freemind files in Opale files.
IMPORTANT ## Dependence
========= -------------------------------
In dependence with mindmapping_to_hdoc and hdoc_to_opale