Commit 297380da authored by Jean Vintache's avatar Jean Vintache

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

parents 57713d35 80d4ba6a
......@@ -74,4 +74,4 @@ Example :
- 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
Using regular expression with xsl is a good way to parse a non xml file.
\ No newline at end of file
# Etherpad2Lexique -- HDOC CONVERTER PROJECT
# Etherpad2Lexique -- HDOC CONVERTER PROJECT
## License
[GPL 3.0](http://www.gnu.org/licenses/gpl-3.0.txt)
## Credits
- Rit Gabrielle
- Vintache Jean
<<<<<<< HEAD
- Douteau Jean-Come
- Fecherolle Cecile (2014)
##Presentation
=======
- Douteau Jean-Côme
- Fecherolle Cécile (2014)
## Presentation
>>>>>>> c48dac707699113384445195f6949017212e8164
How to transform an etherpad document in lexique document.
Filepath in this document are relative to this file readme.
......@@ -71,4 +77,8 @@ Example :
- Jing checks if the output file is validated with the right rng schema
- Zip the directory into hdoc archive
## Capitalisation
\ No newline at end of file
## Capitalisation
We have to change how we get the input file:
1 Get the first file of the input directory
2 Make the run with the name of the file as parameter
Finally, ant should be changed to manage multiple entries
\ No newline at end of file
# Etherpad2Opale -- HDOC CONVERTER PROJECT
# Etherpad2Opale -- HDOC CONVERTER PROJECT
## License
[GPL 3.0](http://www.gnu.org/licenses/gpl-3.0.txt)
## Credits
- Rit Gabrielle
- Vintache Jean
<<<<<<< HEAD
- Douteau Jean-Come
- Fecherolle Cecile (2014)
##Presentation
=======
- Douteau Jean-Côme
- Fecherolle Cécile (2014)
## Presentation
>>>>>>> c48dac707699113384445195f6949017212e8164
How to transform an etherpad document in opale document.
Filepaths in this document are relative to this readme file.
......@@ -72,4 +78,8 @@ Here's an example :
- Jing checks if the output file is validated with the right rng schema
- Zip the directory into hdoc archive
## Capitalisation
\ No newline at end of file
## Capitalisation
We have to change how we get the input file:
1 Get the first file of the input directory
2 Make the run with the name of the file as parameter
Finally, ant should be changed to manage multiple entries
\ No newline at end of file
# Etherpad2Optim -- HDOC CONVERTER PROJECT
# Etherpad2Optim -- HDOC CONVERTER PROJECT
## License
[GPL 3.0](http://www.gnu.org/licenses/gpl-3.0.txt)
## Credits
- Rit Gabrielle
- Vintache Jean
<<<<<<< HEAD
- Douteau Jean-Come
- Fecherolle Cecile (2014)
##Presentation
=======
- Douteau Jean-Côme
- Fecherolle Cécile (2014)
## Presentation
>>>>>>> c48dac707699113384445195f6949017212e8164
How to transform an etherpad document in optim document.
Filepath in this document are relative to this file readme.
......@@ -68,8 +74,12 @@ Example :
- 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
- Build hdoc structure
- Jing checks if the output file is validated with the right rng schema
- Zip the directory into hdoc archive
## Capitalisation
\ No newline at end of file
## Capitalisation
We have to change how we get the input file:
1 Get the first file of the input directory
2 Make the run with the name of the file as parameter
Finally, ant should be changed to manage multiple entries
\ No newline at end of file
Converter Mindmapping2HDOC
==========================
Conversion of Freemind file(s) (.mm) to Hdoc
Conversion of Freemind file(s) (.mm) to Hdoc.
Licence
-------
......@@ -17,14 +17,14 @@ Credits
Presentation
------------
This project aims at converting mindmapping files to hdoc files.
This project aims at converting mindmapping files (.mm) to hdoc files. If you use another tool to create mindmapping files, you can probably export it to a .mm file and use it in this converter.
User documentation
------------------
* 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'
* Put your files in a folder 'mindmapping_to_hdoc/input'. The file has to be a Freemind file (.mm).
* Enter the command line corresponding to your OS :
* On Linux : 'sh run.sh'
* On Windows : 'run.bat'
......@@ -44,14 +44,12 @@ Unsupported
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
----
* Mindmap to Lexique conversion
* Mindmap to Optim conversion
* Check the compatibility of version and software (files exported from Xmind etc.)
Technical notes
---------------
......
......@@ -32,10 +32,10 @@ fi
#Lancer la commande
scJarList="$lib/*"
if [ "$inputPath" == '' ] ; then
if [ -z "$inputPath" ]; then
echo "Appel sans paramètre"
$vJavaCmd -classpath "$scJarList:" -Xmx150m org.apache.tools.ant.Main -buildfile $ant $antparam
else
echo "Appel avec paramètre"
$vJavaCmd -classpath "$scJarList:" -Xmx150m org.apache.tools.ant.Main -buildfile $ant $antparam -DinputPath $inputPath
fi
\ No newline at end of file
fi
This diff is collapsed.
......@@ -19,7 +19,7 @@ It is based on the work of Guillaume GOMEZ in 2014.
## Presentation
The project aims at converting Freemind files in Opale files.
The project aims at converting Freemind files in Opale files. If you use another tool to create mindmapping files, you can probably export it to a .mm file and use it in this converter.
## Dependence
-------------------------------
......
......@@ -2,10 +2,13 @@
set lib=lib
set ant=mindmapping_to_opale.ant
set antparam=-Dprogram.param=%1
set inputPath=%2
set scJarList=%lib%\*
java.exe -classpath "%scJarList%" -Xmx150m org.apache.tools.ant.Main -buildfile %ant% %antparam%
if defined %inputPath% java.exe -classpath "%scJarList%" -Xmx150m org.apache.tools.ant.Main -buildfile %ant% %antparam% -DinputPath %inputPath%
pause
if not defined %inputPath% java.exe -classpath "%scJarList%" -Xmx150m org.apache.tools.ant.Main -buildfile %ant% %antparam%
pause
REM start /MIN java.exe -classpath "%scJarList%" -Xmx150m org.apache.tools.ant.Main -buildfile %ant% %antparam%
This diff is collapsed.
......@@ -33,8 +33,12 @@ Todo
- tests more files
- clean output of optim source files
- resolve bugs
- the level of unit of content for the Opal conversion if basically set to sections witch doesn't contains any section but some could need it to be set to another level. Create a selection of this level could be a next step for this project
- qualify supported version of Optim
- the level of unit of content for the Opal conversion if basically set to sections witch doesn't contains any section but some could need it to be set to another level. Create a selection of this level could be a next step for this project
- maybe define it from the opale root file (paper, section, website, slideshow and webpage)
- and/or define it from the command line
- and/or choose it terms of heuristic (size of content, number of imbricated parts...)
- and/or generate different hdoc version
Technicals notes
......
Optim to Opale (`optim_to_opale`)
=================================
Last edit: January 6, 2016
Last edit: January 7, 2016
License
-------
......@@ -73,4 +73,4 @@ During all the process it also prints some basic information both on screen and
Capitalization
--------------
While working on this project, we have learned more about ANT scripting (more specifically bulding an multi-os script and running scripts by detecting the OS) and about problem solving in general (how to go from one specific need to a result).
N/A for now
......@@ -19,12 +19,12 @@ Previous developers
Presentation
---------------
This converter transforms a wkipedia page (from a link or a saved page) to a Hdoc document.
This converter transforms a wikipedia page (from a link or a saved page) to a Hdoc document.
User Documentation
---------------
Use a terminal and go to the root of the folder (Wikipedia_to_hdoc).
Use a terminal and go to the folder's root (Wikipedia_to_hdoc).
Generating .hdoc of a Wikipedia article with an URL
---------------------------------------------------
......@@ -51,6 +51,8 @@ Generating .hdoc of a Wikipedia article with a local file
---------------------------------------------------------
1 - Copy the content of the Wikipedia article you want to convert in the directory named "input" and in a file called "source.xml".
Display the source code of the wikipedia page, copy it and paste it in the new file source.xml
Make sure to copy/paste the source code and not save it directly as a file.
2 - Run the comand corresponding to your OS
......@@ -65,6 +67,13 @@ Generating .hdoc of a Wikipedia article with a local file
To do
---------------------------------------------------------
In general :
1 - Handle Notes and References
2 - Display the table on the right in the introduction (text and images)
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.
......@@ -85,12 +94,11 @@ Concerning tables :
2 - Change Hdoc Scheme in order to accept images in tables?
3 - Display complex tables as tables in Opale (not as extern files)
3 - Display complex tables as tables in Opale (not as extern files).
Technical notes
---------------
For images you can refer to the get-ressources-with-meta.xsl and official-meta.xml. Read the commentary and it will help you
to finish the to do task regarding images. These files are included just for the seek of Capitalization.
For images you can refer to the get-ressources-with-meta.xsl and official-meta.xml. Read the commentary and it will help you finish the to do task regarding images. These files are included just for the needs of Capitalization.
Be aware of the following things
---------------------------------------------------------
......@@ -102,7 +110,7 @@ BUG
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.
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 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.
......
......@@ -21,10 +21,9 @@ Previous developers
Presentation
------------
Wikipedia to Opale is a converter that tronsform wikipedia pagaes to opale.
Wikipedia to Opale is a converter that transforms Wikipedia pages to Opale.
Dependece
Dependence
---------
- Wikipedia To Hdoc Converter
- Hdoc to Opale Converter
......@@ -36,7 +35,7 @@ User Documentation
Generating .hdoc of a Wikipedia article with an URL
---------------------------------------------------
1 - Run the comand corresponding to your OS
1 - Run the command corresponding to your OS
On windows :
runURL.bat yourWikipediaUrl yourFilename
......@@ -58,8 +57,10 @@ Generating .hdoc of a Wikipedia article with a local file
---------------------------------------------------------
1 - Copy the content of the Wikipedia article you want to convert in the directory named “input” and in a file called “source.xml".
2 - Run the comand corresponding to your OS
Display the source code of the wikipedia page, copy it and paste it in the new file source.xml
Make sure to copy/paste the source code and not save it directly as a file.
2 - Run the command corresponding to your OS
On windows :
runFile.bat
......@@ -76,20 +77,17 @@ BUG
Unsupported
-----------
1 Images:
- images inside text are not supported because of schema validation.
Known Bugs
----------
- Images inside text are not supported because of schema validation.
To do
-----
1 Images:
- Do a preposition to modify the hdoc schema so that we will be able to manage images inside text
- Complete the extraction of the metadata information of images
Technical notes
---------------
Capitalisation
--------------
For images you can refer to the get-ressources-with-meta.xsl and official-meta.xml in the hdoc_to_wikipedia/xslt Folder Read the commentary. It will help you to finish the task regarding images. These files are included to give you a solution to start from.
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