Commit 62615c4f authored by bperraud's avatar bperraud

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

parents 7fb71411 c86a4ad6
...@@ -22,11 +22,11 @@ Dependance ...@@ -22,11 +22,11 @@ Dependance
This project can be used alone if you want to import an HDOC file into basex. This project can be used alone if you want to import an HDOC file into basex.
## User stories User stories
------------------ ------------------
- Among a group of courses, user can search by title, author or keywords of the course. - 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. - 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. - In a certain section, by searching a key word, user can obtain paragraphs that contain it.
- User can get definitions related to a keyword - User can get definitions related to a keyword
- User can get examples whose titles contain a keyword - User can get examples whose titles contain a keyword
...@@ -37,7 +37,7 @@ Step by step : ...@@ -37,7 +37,7 @@ Step by step :
- Run the transformation progam (Win : double click run.bat, Linux : execute run.sh) - Run the transformation progam (Win : double click run.bat, Linux : execute run.sh)
- This transformation includes : - This transformation includes :
* Title, authors, keywords * Title, authors, keywords
* First Level section : title, type * First Level section : title, type, paragraphs
[`Step 2 : Create data base in basex`] [`Step 2 : Create data base in basex`]
- Download and install [BaseX](http://basex.org/products/download/all-downloads/) - Download and install [BaseX](http://basex.org/products/download/all-downloads/)
...@@ -56,13 +56,13 @@ Step by step : ...@@ -56,13 +56,13 @@ Step by step :
* searchSectionByTitle.xqm * searchSectionByTitle.xqm
## TODO List TODO List
------------------ ------------------
- xlst Transformation : - xlst Transformation :
* texts of sections * Remove text formats
* sub sections * Sub sections
* exercices * Exercices
* resources : images, ... * Resources : images, ...
- XQuery requests : - XQuery requests :
* Search keywords in text * Search keywords in text
......
...@@ -3,4 +3,4 @@ log=${basedir}/log ...@@ -3,4 +3,4 @@ log=${basedir}/log
xsl=${basedir}/xsl xsl=${basedir}/xsl
in=${basedir}/input in=${basedir}/input
out=${basedir}/output out=${basedir}/output
tmp=${basedir}/tmp tmp=${basedir}/tmp
\ No newline at end of file
...@@ -37,7 +37,7 @@ ...@@ -37,7 +37,7 @@
</for> </for>
<!-- Clean--> <!-- Clean-->
<delete dir="${tmp}" failonerror="false"/> <!-- <delete dir="${tmp}" failonerror="false"/> -->
</target> </target>
......
<map version="1.0.1">
<node ID="ID_1" TEXT="Framindmap To Canoprof">
<node ID="ID_5" POSITION="right" STYLE="fork" TEXT="#2 S&#233;ance 2">
<node ID="ID_6" POSITION="right" STYLE="fork" TEXT="#def D&#233;finition titre">
<node ID="ID_13" POSITION="right" STYLE="fork" TEXT="#p Definition contenu"/>
</node>
<node ID="ID_20" POSITION="right" STYLE="fork" TEXT="#ex Exemple titre">
<node ID="ID_27" POSITION="right" STYLE="fork" TEXT="#p Exemple contenu : En recherche du moyen de mettre tout les types de contenus similaires &#224; d&#233;finition dans le m&#234;me template"/>
</node>
</node>
<node ID="ID_4" POSITION="left" STYLE="fork" TEXT="#1 S&#233;ance 1">
<node ID="ID_29" POSITION="left" STYLE="fork" TEXT="#p Ici probl&#232;me, l'activit&#233; cr&#233;&#233;e devrait &#234;tre de type description courte"/>
</node>
</node>
</map>
\ No newline at end of file
i'm here to keep the output file
...@@ -29,4 +29,29 @@ In order to work properly, this module needs ...@@ -29,4 +29,29 @@ In order to work properly, this module needs
User Stories 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) 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
Step by step :
[`Step 1 : File transformation`]
- Put the files .scar you want to deal with in the folder [input](https://gitlab.utc.fr/crozatst/hdoc/tree/master/opale_to_basex/input)
- Run the transformation progam (Win : double click run.bat, Linux : execute run.sh)
- This transformation includes :
* Title, authors, keywords
* First Level section : title, type
[`Step 2 : Create data base in basex`]
- Download and install [BaseX](http://basex.org/products/download/all-downloads/)
- Run BasexGui
- In the Text Editor of BaseX, open the command script "createbd.bxs" in folder [`command`](https://gitlab.utc.fr/crozatst/hdoc/tree/master/opale_to_basex/basex/command).
Follow the instructions in the script, and then execute it.
[`Step 3 : Make XQuery request`]
- In the Text Editor of BaseX, you can open and execute xquery script "main.xq" in folder [`xquery`](https://gitlab.utc.fr/crozatst/hdoc/tree/master/opale_to_basex/basex/xquery).
It's in this main module that we call predefined functions and execute script
- .xqm files are library modules where we have defined functions, we can go to these files for more detailed using instructions
Available library modules :
* searchDocByAuthor.xqm
* searchDocByTitle.xqm
* searchSectionByTitle.xqm
\ No newline at end of file
libdir=${basedir}/lib libdir=${basedir}/lib
rngdir=${basedir}/rng
xsldir=${basedir}/xsl xsldir=${basedir}/xsl
srcdir=${basedir}/in inputPath=${basedir}/input
outdir=${basedir}/out outputPath=${basedir}/output
InputPath=${basedir}/input inputOpaleToHdoc=../opale_to_hdoc/input
OutputPath=${basedir}/output outputOpaleToHdoc=../opale_to_hdoc/output
inputHdocToBasex=../hdoc_to_basex/input
outputHdocToBasex=../hdoc_to_basex/output
\ No newline at end of file
<project name="opale_to_basex"> <project name="opale_to_basex" default="clean">
<property file="build.properties"/> <property file="build.properties"/>
<echo message="To be implemented..."/> <echo message="To be implemented..."/>
<target name="AllFiles">
<delete>
<fileset dir="${outputPath}" />
</delete>
</project>
\ No newline at end of file <copy todir="${inputOpaleToHdoc}">
<fileset dir="${inputPath}"/>
</copy>
<ant antfile="../opale_to_hdoc/opale_to_hdoc.ant" inheritAll="false"/>
<copy todir="${inputHdocToBasex}">
<fileset dir="${outputOpaleToHdoc}"/>
</copy>
<ant antfile="../hdoc_to_basex/hdoc_to_basex.ant" inheritAll="false"/>
<copy todir="${outputPath}" >
<fileset dir="${outputHdocToBasex}"/>
</copy>
</target>
<target name="clean" depends="AllFiles">
<!-- -->
<delete includeemptydirs="true" verbose="true">
<fileset dir="${inputOpaleToHdoc}">
<include name="*.scar"/>
</fileset>
</delete>
<delete includeemptydirs="true" verbose="true">
<fileset dir="${outputOpaleToHdoc}">
<include name="*.hdoc"/>
</fileset>
</delete>
<delete includeemptydirs="true" verbose="true">
<fileset dir="${inputHdocToBasex}">
<include name="*.hdoc"/>
</fileset>
</delete>
<delete includeemptydirs="true" verbose="true">
<fileset dir="${outputHdocToBasex}"/>
</delete>
</target>
</project>
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