diff --git a/hdoc_to_basex/README.md b/hdoc_to_basex/README.md new file mode 100644 index 0000000000000000000000000000000000000000..94a76b0f48f6f1873efea7c42b6546dbc402f82d --- /dev/null +++ b/hdoc_to_basex/README.md @@ -0,0 +1,34 @@ +Converter hdoc_to_basex +----------------------- + +The purpose of this converter is to obtain an XML data file suitable for importation into basex for futher XQuery requests from a HDOC file + +License GPL3.0 +-------------- + +http://www.gnu.org/licenses/gpl-3.0.txt + + +Credits +------- + +* Simei YIN +* Baptiste MONTANGE + + +Dependance +---------- + +This project can be used alone if you want to import an HDOC file into basex. + + +## User stories +------------------ +- Among a group of courses, user can search by title, author or keywords of the course. +- By searching a certain keyword, user can obtain the sections that contain it with their hierarchy levels in the course. +- In a certain section, by searching a key word, user can obtain paragraphes that contain it. +- User can get definitions related to a keyword +- User can get examples whose titles contain a keyword +[Step 1] + - Unzip works, creation of a XML file with the title of the hdoc. (little problem, all of the document is in the output). + - the file created is in the tmp/{hdocfile} directory. \ No newline at end of file diff --git a/hdoc_to_basex/build.properties b/hdoc_to_basex/build.properties new file mode 100644 index 0000000000000000000000000000000000000000..073c1050c2eb4ae2d1828685c96145da192aea96 --- /dev/null +++ b/hdoc_to_basex/build.properties @@ -0,0 +1,7 @@ +libdir=${basedir}/lib +rngdir=${basedir}/rng +xsldir=${basedir}/xsl +srcdir=${basedir}/in +outdir=${basedir}/out +InputPath=${basedir}/input +OutputPath=${basedir}/output diff --git a/hdoc_to_basex/hdoc_to_basex.ant b/hdoc_to_basex/hdoc_to_basex.ant new file mode 100644 index 0000000000000000000000000000000000000000..3ac4be8bb7e21bf05462d3b37ef88ff57845d6bf --- /dev/null +++ b/hdoc_to_basex/hdoc_to_basex.ant @@ -0,0 +1,70 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/hdoc_to_basex/input/sample.hdoc b/hdoc_to_basex/input/sample.hdoc new file mode 100644 index 0000000000000000000000000000000000000000..29de6baa29e3acb2a30b7dc73b610f3bea7024f9 Binary files /dev/null and b/hdoc_to_basex/input/sample.hdoc differ diff --git a/hdoc_to_basex/lib/ant-contrib.jar b/hdoc_to_basex/lib/ant-contrib.jar new file mode 100644 index 0000000000000000000000000000000000000000..062537661a514c2ce97d18948f4f25f7226cc1a0 Binary files /dev/null and b/hdoc_to_basex/lib/ant-contrib.jar differ diff --git a/hdoc_to_basex/lib/ant-launcher.jar b/hdoc_to_basex/lib/ant-launcher.jar new file mode 100644 index 0000000000000000000000000000000000000000..939abb57975f5ba08484e582f84ed3702d570a89 Binary files /dev/null and b/hdoc_to_basex/lib/ant-launcher.jar differ diff --git a/hdoc_to_basex/lib/ant.jar b/hdoc_to_basex/lib/ant.jar new file mode 100644 index 0000000000000000000000000000000000000000..7f5be4a4e05939429353a90e882846aeac72b976 Binary files /dev/null and b/hdoc_to_basex/lib/ant.jar differ diff --git a/hdoc_to_basex/lib/jing.jar b/hdoc_to_basex/lib/jing.jar new file mode 100644 index 0000000000000000000000000000000000000000..fe01514e80920805e2e9169381fcf72cc5994aed Binary files /dev/null and b/hdoc_to_basex/lib/jing.jar differ diff --git a/hdoc_to_basex/lib/saxon9he.jar b/hdoc_to_basex/lib/saxon9he.jar new file mode 100644 index 0000000000000000000000000000000000000000..4e635175be11bc83187a2525f2a821bb85a1a566 Binary files /dev/null and b/hdoc_to_basex/lib/saxon9he.jar differ diff --git a/hdoc_to_basex/run.bat b/hdoc_to_basex/run.bat new file mode 100644 index 0000000000000000000000000000000000000000..8b56ebe9ae7e1a6d236886a7d4c2a277caf9c2ca --- /dev/null +++ b/hdoc_to_basex/run.bat @@ -0,0 +1,11 @@ +@echo off +set lib=lib +set ant=hdoc_to_basex.ant +set antparam=-Dprogram.param=%1 + +set scJarList=%lib%\* + +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% diff --git a/hdoc_to_basex/run.sh b/hdoc_to_basex/run.sh new file mode 100644 index 0000000000000000000000000000000000000000..b19d0994deaa07979879a6ecbdc67cb14d506ebe --- /dev/null +++ b/hdoc_to_basex/run.sh @@ -0,0 +1,35 @@ +#!/bin/sh +lib="lib" +ant="hdoc_to_basex.ant" +antparam="-Dprogram.param=$1" + +#Recherche de java et controle que se soit une version SUN +vJavaCmd="java" +xCheckJava () { + vInputVarName=\$"$1" + vInputVarVal=`eval "expr \"$vInputVarName\" "` + if [ -z "$vInputVarVal" ];then + eval "$1=false" + return + fi + vSunJavaFound=`$vInputVarVal -version 2>&1 | grep -Eo -m 1 "(HotSpot)|(OpenJDK)"` + if [ "$vSunJavaFound" != "HotSpot" ] && [ "$vSunJavaFound" != "OpenJDK" ] ; then + eval "$1=false" + return + fi +} +xCheckJava vJavaCmd +if [ "$vJavaCmd" = "false" ]; then + vJavaCmd="$JAVA_HOME/bin/java" + xCheckJava vJavaCmd + if [ "$vJavaCmd" = "false" ]; then + echo "ERREUR: JRE de SUN introuvable. Veuillez déclarer la variable d'environnement JAVA_HOME." + exit 1 + fi +fi + +#Lancer la commande +scJarList="$lib/*" + + +$vJavaCmd -classpath "$scJarList:" -Xmx150m org.apache.tools.ant.Main -buildfile $ant $antparam diff --git a/hdoc_to_basex/xsl/transformation.xsl b/hdoc_to_basex/xsl/transformation.xsl new file mode 100644 index 0000000000000000000000000000000000000000..fe8a1b1e46b840346c05dec3f95d716bbf4cc698 --- /dev/null +++ b/hdoc_to_basex/xsl/transformation.xsl @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/hdoc_to_pdf/README.md b/hdoc_to_pdf/README.md index bc4c313b024075160bea7b1f467400b1e10c8074..e30ae5858fd561de80e2bde398424dcc5401b6cb 100644 --- a/hdoc_to_pdf/README.md +++ b/hdoc_to_pdf/README.md @@ -1,7 +1,7 @@ Converter hdoc_to_pdf ----------------------- -The purpose of this converter is to obtain an PDF file from a hdoc document. +The purpose of this converter is to obtain a PDF file from a hdoc document. License GPL3.0 @@ -51,9 +51,6 @@ Generic Todo Technical notes --------------- -* The product backlog of the current project can be found through the following url: -* Time-sheets can be found through the following urls: - - User Story ---------- diff --git a/hdoc_to_pdf/input/sample.hdoc b/hdoc_to_pdf/input/sample.hdoc new file mode 100644 index 0000000000000000000000000000000000000000..3b4b40443f3fd32f9eef347d1029dd5e64729351 Binary files /dev/null and b/hdoc_to_pdf/input/sample.hdoc differ diff --git a/hdoc_to_pdf/prepare_hdoc.ant b/hdoc_to_pdf/prepare_hdoc.ant new file mode 100755 index 0000000000000000000000000000000000000000..58b0caa25d573eb67242af33c4bfea5f92affdd5 --- /dev/null +++ b/hdoc_to_pdf/prepare_hdoc.ant @@ -0,0 +1,16 @@ + + + + + + + + + diff --git a/hdoc_to_pdf/run.sh b/hdoc_to_pdf/run.sh old mode 100644 new mode 100755 diff --git a/opale_to_basex/README.md b/opale_to_basex/README.md new file mode 100644 index 0000000000000000000000000000000000000000..1488a43ea0a3085017f8d6e1e4656cd1887ce36a --- /dev/null +++ b/opale_to_basex/README.md @@ -0,0 +1,32 @@ +Converter opale_to_basex +----------------------- + +The purpose of this converter is to obtain an HDOC file from an Opale document. + + +License GPL3.0 +-------------- + +http://www.gnu.org/licenses/gpl-3.0.txt + + +Credits +------- + +* Simei YIN +* Baptiste MONTANGE + + +Dependance +---------- + +In order to work properly, this module needs + +1. [`opale_to_hdoc`](https://gitlab.utc.fr/crozatst/hdoc/tree/master/opale_to_hdoc) (Opale to Hdoc conversion) +2. [`hdoc_to_basex`](https://gitlab.utc.fr/crozatst/hdoc/tree/master/hdoc_to_basex) (Hdoc to Basex conversion) + + +User Stories +---------- + +Please consult the section "User Stories" of README.md file in [`hdoc_to_basex`] (https://gitlab.utc.fr/crozatst/hdoc/tree/master/hdoc_to_basex/README.md) \ No newline at end of file diff --git a/opale_to_basex/build.properties b/opale_to_basex/build.properties new file mode 100644 index 0000000000000000000000000000000000000000..073c1050c2eb4ae2d1828685c96145da192aea96 --- /dev/null +++ b/opale_to_basex/build.properties @@ -0,0 +1,7 @@ +libdir=${basedir}/lib +rngdir=${basedir}/rng +xsldir=${basedir}/xsl +srcdir=${basedir}/in +outdir=${basedir}/out +InputPath=${basedir}/input +OutputPath=${basedir}/output diff --git a/opale_to_basex/lib/ant-contrib.jar b/opale_to_basex/lib/ant-contrib.jar new file mode 100644 index 0000000000000000000000000000000000000000..062537661a514c2ce97d18948f4f25f7226cc1a0 Binary files /dev/null and b/opale_to_basex/lib/ant-contrib.jar differ diff --git a/opale_to_basex/lib/ant-launcher.jar b/opale_to_basex/lib/ant-launcher.jar new file mode 100644 index 0000000000000000000000000000000000000000..939abb57975f5ba08484e582f84ed3702d570a89 Binary files /dev/null and b/opale_to_basex/lib/ant-launcher.jar differ diff --git a/opale_to_basex/lib/ant.jar b/opale_to_basex/lib/ant.jar new file mode 100644 index 0000000000000000000000000000000000000000..7f5be4a4e05939429353a90e882846aeac72b976 Binary files /dev/null and b/opale_to_basex/lib/ant.jar differ diff --git a/opale_to_basex/lib/saxon9he.jar b/opale_to_basex/lib/saxon9he.jar new file mode 100644 index 0000000000000000000000000000000000000000..4e635175be11bc83187a2525f2a821bb85a1a566 Binary files /dev/null and b/opale_to_basex/lib/saxon9he.jar differ diff --git a/opale_to_basex/opale_to_basex.ant b/opale_to_basex/opale_to_basex.ant new file mode 100644 index 0000000000000000000000000000000000000000..aa6fac159ba50c2b6714d5ceb9de0aec18baba89 --- /dev/null +++ b/opale_to_basex/opale_to_basex.ant @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/opale_to_basex/run.bat b/opale_to_basex/run.bat new file mode 100644 index 0000000000000000000000000000000000000000..8685675866f50bc2b7fc2a90e9b3bc4f03ccc86a --- /dev/null +++ b/opale_to_basex/run.bat @@ -0,0 +1,11 @@ +@echo off +set lib=lib +set ant=opale_to_basex.ant +set antparam=-Dprogram.param=%1 + +set scJarList=%lib%\* + +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% diff --git a/opale_to_basex/run.sh b/opale_to_basex/run.sh new file mode 100644 index 0000000000000000000000000000000000000000..e84079dd8d0d76976d86de374d69af17e7b098da --- /dev/null +++ b/opale_to_basex/run.sh @@ -0,0 +1,35 @@ +#!/bin/sh +lib="lib" +ant="opale_to_basex.ant" +antparam="-Dprogram.param=$1" + +#Recherche de java et controle que se soit une version SUN +vJavaCmd="java" +xCheckJava () { + vInputVarName=\$"$1" + vInputVarVal=`eval "expr \"$vInputVarName\" "` + if [ -z "$vInputVarVal" ];then + eval "$1=false" + return + fi + vSunJavaFound=`$vInputVarVal -version 2>&1 | grep -Eo -m 1 "(HotSpot)|(OpenJDK)"` + if [ "$vSunJavaFound" != "HotSpot" ] && [ "$vSunJavaFound" != "OpenJDK" ] ; then + eval "$1=false" + return + fi +} +xCheckJava vJavaCmd +if [ "$vJavaCmd" = "false" ]; then + vJavaCmd="$JAVA_HOME/bin/java" + xCheckJava vJavaCmd + if [ "$vJavaCmd" = "false" ]; then + echo "ERREUR: JRE de SUN introuvable. Veuillez déclarer la variable d'environnement JAVA_HOME." + exit 1 + fi +fi + +#Lancer la commande +scJarList="$lib/*" + + +$vJavaCmd -classpath "$scJarList:" -Xmx150m org.apache.tools.ant.Main -buildfile $ant $antparam diff --git a/opale_to_elasticSearch/README.md b/opale_to_elasticSearch/README.md index 953ab19e5516a015b4f159aa3a49dd3cfb1724fd..8ff0794e009bc2560532f6f4f679d0421071d430 100644 --- a/opale_to_elasticSearch/README.md +++ b/opale_to_elasticSearch/README.md @@ -19,3 +19,11 @@ Opale to ElasticSearch module extract data from an Opale file to use it with Ela - Opale To Hdoc Converter - Hdoc to ElasticSearch Converter + +## User Story +------------- +"Vous disposez d'un ensemble de contenus Opale à votre disposition et vous aimeriez pouvoir l'analyser selon les différents types d'éléments possibles : cours, exercices, notions tout en permettant de trier par rapport aux différents sujets de ces dit contenus. +Pour se faire, vous mettrez les contenus que vous voulez analyser en input de opale_to_elasticSearch et vous lancerez le script lançant le fichier ANT. +Vous pourrez ensuite accéder à des graphiques Kibana à une adresse donnée et paramétrer vos graphiques afin d'obtenir les informations qui vous intéresse. + +A savoir que les contenus opale de plusieurs machines/utilisateurs peuvent être capitalisés car l'ensemble des instances de base elasticSearch installées forment un cluster accessible via l'interface Kibana"