Commit 5f7f42df authored by Baptiste Perraud's avatar Baptiste Perraud

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

parents 28c61441 b082ad3b
...@@ -7,6 +7,7 @@ ...@@ -7,6 +7,7 @@
<target name="convert"> <target name="convert">
<!-- Preparation for the file transformation : delete old folders and create new folders --> <!-- Preparation for the file transformation : delete old folders and create new folders -->
<delete dir="${tmp}" failonerror="false"/>
<mkdir dir="${tmp}"/> <mkdir dir="${tmp}"/>
<delete dir="${out}" failonerror="false"/> <delete dir="${out}" failonerror="false"/>
<mkdir dir="${out}"/> <mkdir dir="${out}"/>
...@@ -37,7 +38,7 @@ ...@@ -37,7 +38,7 @@
</for> </for>
<!-- Clean--> <!-- Clean-->
<!-- <delete dir="${tmp}" failonerror="false"/> --> <delete dir="${tmp}" failonerror="false"/>
</target> </target>
......
<?xml version="1.0" encoding="UTF-8"?>
<container version="1.0" xmlns="urn:utc.fr:ics:hdoc:container">
<rootfiles>
<rootfile full-path="content.xml" media-type="text/xml" />
</rootfiles>
</container>
This diff is collapsed.
application/x-hdoc+zip
\ No newline at end of file
...@@ -27,6 +27,10 @@ The project aims at converting Freemind files in Opale files. If you use another ...@@ -27,6 +27,10 @@ The project aims at converting Freemind files in Opale files. If you use another
------------------------------- -------------------------------
In dependence with mindmapping_to_hdoc and hdoc_to_opale In dependence with mindmapping_to_hdoc and hdoc_to_opale
##Installation
-------------------------------
* To get the tool, go to the page https://gitlab.utc.fr/crozatst/hdoc/tree/master4 and click the download icon on the right of the screen : you can get a .zip version of the project. For the git users, the clone link is available on the same site.
## User documentation ## User documentation
------------------------------- -------------------------------
...@@ -38,16 +42,13 @@ In dependence with mindmapping_to_hdoc and hdoc_to_opale ...@@ -38,16 +42,13 @@ In dependence with mindmapping_to_hdoc and hdoc_to_opale
* On Windows : 'run.bat' * 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>') 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>')
If the input folder happens to be missing, you should create your own input folder in the root of the mindmapping_to_opale folder, and add your own samples inside.
*You will find the result of the conversion in the folder mindmapping_to_opale/output* *You will find the result of the conversion in the folder mindmapping_to_opale/output*
*You can find a sample file il the folder /samples.* *You can find a sample file il the folder /samples.*
### Rules to follow ### Rules to follow
You can use the native formating in order to complete your Module :
* By using the "Text Bold" option, you will get an emphasis.
* By using the "Text Italic" option, you will get a quote.
You can use special rules in Freemind to personnalize your Scenari Module : You can use special rules in Freemind to personnalize your Scenari Module :
* By default, a "Division" is created with the name of the main node of your MindMap * By default, a "Division" is created with the name of the main node of your MindMap
...@@ -67,7 +68,7 @@ You can use special rules in Freemind to personnalize your Scenari Module : ...@@ -67,7 +68,7 @@ You can use special rules in Freemind to personnalize your Scenari Module :
* **#question** : a MCQ * **#question** : a MCQ
* **#singlechoicequestion** : a QCU * **#singlechoicequestion** : a QCU
* **#choice-qcu** : an answer within a QCU * **#choice-qcu** : an answer within a QCU
* **#list** : a list, first node being the title and children being the content. * **#list** : a list inside a paragraph, first node being the title and children being the content.
* **#solution** : a solution associated to a single choice within a QCU (matches an integer) * **#solution** : a solution associated to a single choice within a QCU (matches an integer)
* **#choice-correct** : a correct answer within a MCQ * **#choice-correct** : a correct answer within a MCQ
* **#choice-incorrect** : an incorrect answer within a MCQ * **#choice-incorrect** : an incorrect answer within a MCQ
...@@ -83,11 +84,12 @@ You can use special rules in Freemind to personnalize your Scenari Module : ...@@ -83,11 +84,12 @@ You can use special rules in Freemind to personnalize your Scenari Module :
## Known bugs ## Known bugs
* Current xsl cant handle anything else than a hierarchy of nodes named "nodes". It should be investigated in order to be able to use other types of children, in order to work with native mindmap formatting, as bold or italic. * Currently, the xsl is lacking : there is no support for childs of nodes who are not named "nodes" themselves. The bug has been investigated and is therefore non trivial, and should be solved in order to handle functionnalities outside of the special rules formatting.
## TODO ## TODO
* Develop new hashtags to create other type of Opale contents (such as self-evaluation, exercices other than QCM or QCU, etc.) * Develop new hashtags to create other type of Opale contents (such as new exercises types, self-evaluation etc.)
* Explore native freemind functionalities to allow a more user friendly formatting : using the bold and italic formatting was tried but failed due to a xsl malfunction.
## Technicals notes ## Technicals notes
...@@ -100,7 +102,7 @@ This converter is using standard NF29 conversion project structure : a main ANT ...@@ -100,7 +102,7 @@ This converter is using standard NF29 conversion project structure : a main ANT
This ant file is called by a script (run.sh or run.bat), with ou without parameters. This ant file is called by a script (run.sh or run.bat), with ou without parameters.
### Hdoc files ### Hdoc files
During the conversion process, the converter is using the converter mindmapping_to_hdoc. The result of this conversion is also available in the folder output. During the conversion process, the converter is using the converter mindmapping_to_hodc. The result of this conversion is also available in the folder output.
### What does the main ANT file do ? ### What does the main ANT file do ?
...@@ -113,4 +115,6 @@ During the conversion process, the converter is using the converter mindmapping_ ...@@ -113,4 +115,6 @@ During the conversion process, the converter is using the converter mindmapping_
* Copy the results of the conversion in the folder /output/scar * Copy the results of the conversion in the folder /output/scar
* Finally, clean temporary files * Finally, clean temporary files
## Capitalization ## Capitalization
\ No newline at end of file
* Concerning the xsl malfunction, we know that the issue comes from a mispriority between nodes without childs and nodes with childs who aren't named "nodes". There is a confusion between the two because previous implementation didn't take the seconds into account. We didnt manage to find a way to force the xsl to recognize those nodes, but this is where you should look if you happen to need to fix the issue. A simple but time consuming fix would be to rewrite the xsl with the functionnality in mind, but we didn't took that option as we lacked time. The problematic functions are at the root of the xsl transformation, and therefore a simple fix hasn't been found yet.
...@@ -2,9 +2,12 @@ ...@@ -2,9 +2,12 @@
<property file="build.properties"/> <property file="build.properties"/>
<target name="AllFiles"> <target name="AllFiles">
<delete>
<delete dir="${outputPath}" failonerror="false"/>
<mkdir dir="${outputPath}"/>
<!-- <delete>
<fileset dir="${outputPath}" /> <fileset dir="${outputPath}" />
</delete> </delete> -->
<!-- Copy input files into input folder of project opale_to_hdoc and execute it --> <!-- Copy input files into input folder of project opale_to_hdoc and execute it -->
<copy todir="${inputOpaleToHdoc}"> <copy todir="${inputOpaleToHdoc}">
......
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