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

canoprof_to_hdoc/README.md

 # Convertisseur Canoprof vers HDOC
 
+##Credits
+
+### Autumn 2016
+
+* NEVEUX Anaïs
+
+* BELLIER Pierre-Ulysse
+
 ## User story
 
 Un utilisateur a créé un cours de mathématiques à l'aide de l'outil Canoprof. Il souhaite, pour une raison quelconque, convertir son projet (et donc ses activités et programmations) dans un autre format. Pour cela il utilise notre convertisseur qui permet préalablement une conversion vers un format intermédiare (hdoc). Il fait donc un clic droit sur l'élément principal de son projet sous Canoprof et clique sur "exporter l'archive". Il laisse les options (Inclure le réseau descendant complet des items sélectionnés, et Préserver les espaces de l'atelier) par défaut. Il déplace ensuite le fichier .scar obtenu dans le dossier input du convertisseur puis exécute le fichier run.bat (ou run.sh sous un système UNIX). Une fois l'exécution terminée, il récupère son hdoc dans le dossier output.
@@ -16,4 +24,15 @@ Un utilisateur a cr
 - Information/Warning/Advice/ect...
 - Method and Remind fully functional.
 - Add QCU and QCM. Transclusion of them available too. Need to fix a schema validation error when putting a title to a question, without filling the question content.
--Add "Exercice redactionnel" and transclusion.
\ No newline at end of file
+- Add "Exercice redactionnel" and transclusion.
+
+## Known bugs
+- You can have an exercice with no question but a solution. We should add a if statement to handle this.
+- Something create a "keywrds" node inside the opale output, that make the schema invalid. Editing the title inside myScenari and just pressing enter is sufficient to fix that. But it will be better to fix that inside one of the xsl files.
+
+## TODO List
+- Allow user to convert scar files which contain a .programme file with a name different than "Test.programme".
+- Handle multiple files conversion
+- Add all other type of exercices
+- Handle other kind of paragraph
+- Handle resources (images for example)
\ No newline at end of file

canoprof_to_hdoc/xsl/programmation.xsl

@@ -343,7 +343,7 @@
             </header>
             <section>
                 <header><h1/></header>
-                <xsl:if test="sp:question/cp:flow/*">
+                <xsl:if test="sp:question/cp:flow/*[name() != 'sp:profInstruction']">
                     <div data-hdoc-type='openQuestion'>
                         <xsl:apply-templates select="sp:question/cp:flow/sp:txt/cp:txt//sc:para"/>
                     </div>
@@ -394,7 +394,7 @@
                 <h1><xsl:value-of select="cp:questionM/sp:title"/></h1>
             </header>
             <div data-hdoc-type = 'question'>
-                <xsl:apply-templates select='sc:question/cp:block'/>
+                <xsl:apply-templates select='sc:question/cp:block/sp:body'/>
             </div>
             <xsl:apply-templates select="sc:choices/sc:choice"/>
             <xsl:if test="$withoutExplanation = 'sp:question' and sc:globalExplanation/cp:block/sp:body/cp:flow/sp:txt">
@@ -411,7 +411,7 @@
                 <h1><xsl:value-of select="cp:questionM/sp:title"/></h1>
             </header>
             <div data-hdoc-type = 'question'>
-                <xsl:apply-templates select='sc:question/cp:block'/>
+                <xsl:apply-templates select='sc:question/cp:block/sp:body'/>
             </div>
             <xsl:apply-templates select="sc:choices/sc:choice"/>
             <xsl:if test="../name() = 'sp:question' and sc:globalExplanation/cp:block/sp:body/cp:flow/sp:txt">
@@ -429,7 +429,7 @@
                 <h1><xsl:value-of select="cp:questionM/sp:title"/></h1>
             </header>
             <div data-hdoc-type='singlechoicequestion'>
-                <xsl:apply-templates select="sc:question/cp:block"/>
+                <xsl:apply-templates select="sc:question/cp:block/sp:body"/>
             </div>
             <xsl:apply-templates select="sc:choices//sc:choice"/>
             <div data-hdoc-type='solution'><p><xsl:value-of select="sc:solution/@choice"/></p></div>
@@ -448,7 +448,7 @@
                 <h1><xsl:value-of select="cp:questionM/sp:title"/></h1>
             </header>
             <div data-hdoc-type='singlechoicequestion'>
-                <xsl:apply-templates select="sc:question/cp:block"/>
+                <xsl:apply-templates select="sc:question/cp:block/sp:body"/>
             </div>
             <xsl:apply-templates select="sc:choices//sc:choice"/>
             <div data-hdoc-type='solution'><p><xsl:value-of select="sc:solution/@choice"/></p></div>
@@ -464,12 +464,13 @@
     <xsl:template match="sc:choice">
         <div data-hdoc-type='choice'>
             <xsl:apply-templates select="sc:choiceLabel/cp:txt/sc:para"/>
+            
+            <xsl:if test="sc:choiceExplanation">
+                <div data-hdoc-type='explanation-choice-correct'>
+                    <xsl:apply-templates select="sc:choiceExplanation/cp:txt/sc:para"/>
+                </div>    
+            </xsl:if>
         </div>
-        <xsl:if test="sc:choiceExplanation">
-            <div data-hdoc-type='explanation-choice-correct'>
-                <xsl:apply-templates select="sc:choiceExplanation/cp:txt/sc:para"/>
-            </div>    
-        </xsl:if>
         
     </xsl:template>
     
@@ -478,19 +479,25 @@
             <xsl:when test="@solution = 'checked'">
                 <div data-hdoc-type='choice-correct'>
                     <xsl:apply-templates select="sc:choiceLabel/cp:txt/sc:para"/>
+                    <xsl:if test="sc:choiceExplanation">
+                        <div data-hdoc-type='explanation-choice-correct'>
+                            <xsl:apply-templates select="sc:choiceExplanation/cp:txt/sc:para"/>
+                        </div>    
+                    </xsl:if>
                 </div>
             </xsl:when>
             <xsl:otherwise>
                 <div data-hdoc-type='choice-incorrect'>
                     <xsl:apply-templates select="sc:choiceLabel/cp:txt/sc:para"/>
+                    <xsl:if test="sc:choiceExplanation">
+                        <div data-hdoc-type='explanation-choice-incorrect'>
+                            <xsl:apply-templates select="sc:choiceExplanation/cp:txt/sc:para"/>
+                        </div>    
+                    </xsl:if>
                 </div>
             </xsl:otherwise>
         </xsl:choose>
-        <xsl:if test="sc:choiceExplanation">
-            <div data-hdoc-type='explanation-choice-correct'>
-                <xsl:apply-templates select="sc:choiceExplanation/cp:txt/sc:para"/>
-            </div>    
-        </xsl:if>
+        
     </xsl:template>
     
     <xsl:template match="sp:question[@sc:refUri] | sp:exercice[@sc:refUri]">

canoprof_to_opale/README.md

 # Canoprof2Opale
 
+##Credits
+
+### Autumn 2016
+
+* NEVEUX Anaïs
+
+* BELLIER Pierre-Ulysse
+
 ## User story
 
 Un utilisateur a créé un cours de mathématiques à l'aide de l'outil Canoprof. Il souhaite, pour une raison quelconque, convertir son projet (et donc ses activités et programmations) au format Opale. Pour cela il utilise notre convertisseur qui va agir en deux étapes : une conversion dans un format intermédiaire (le format hdoc), puis conversion de ce hdoc dans le format Opale. Une fois son cours créé, il effectue un clic-droit sur l'élément racine de son projet, et choisit "exporter l'archive". Il laisse les options (Inclure le réseau descendant complet des items sélectionnés, et Préserver les espaces de l'atelier) par défaut. Il déplace ensuite le fichier .scar obtenu dans le dossier input du convertisseur puis exécute le fichier run.bat (ou run.sh sous un système UNIX). Il récupère ensuite un nouveau fichier .scar dans le dossier output, qu'il pourra importer dans Scenari.
 
 ## Getting started
 - Put the Canoprof .scar in the input folder. The scar should be the only one in this folder. The .programme should be into the root of your .scar and should be named Test.programme
-An .scar example is already in the input folder.
+A .scar example is already in the input folder.
 - Check if there's no .scar file in the input folder of canoprof_to_hdoc folder. If files exist, please remove them. Otherwise, the converter can take one of the .scar in this folder instead of the one you want to convert.
 - Use the run.bat file to launch conversion.
 - You will find your converted .scar in the output folder.
@@ -14,10 +22,19 @@ An .scar example is already in the input folder.
 ## What the converter handle
 - Sequence
 - Session
-- Activity created in the .programme, transclusion should be available soon.
+- Activity created in the .programme, transclusion available.
 - Information/Warning/Advice/ect...
 - Method and Remind fully functional
 - QCM and QCU working, even with transclusion. 
 - Add "Exercice redactionnel" and transclusion.
 
+## Known bugs
+- You can have an exercice with no question but a solution. We should add a if statement to handle this.
+- Something create a "keywrds" node inside the opale output, that make the schema invalid. Editing the title inside myScenari and just pressing enter is sufficient to fix that. But it will be better to fix that inside one of the xsl files.
 
+## TODO List
+- Allow user to convert scar files which contain a .programme file with a name different than "Test.programme".
+- Handle multiple files conversion
+- Add all other type of exercices
+- Handle other kind of paragraph
+- Handle resources (images for example)

hdoc_to_basex/README.md

@@ -42,7 +42,11 @@ Step by step :
 			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 scripts in folder [`basex/xquery`](https://gitlab.utc.fr/crozatst/hdoc/tree/master/hdoc_to_basex/basex/xquery).
-		- Available scripts :
-			* searchDocByAuthor.hq
-			* searchDocByTitle.hq
\ No newline at end of file
+		- In the Text Editor of BaseX, you can open and execute xquery script "main.xq" in folder [`basex/xquery`](https://gitlab.utc.fr/crozatst/hdoc/tree/master/hdoc_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
+			* searchDocByTitle.xqm
\ No newline at end of file

hdoc_to_basex/basex/xquery/main.xq

+(: this script with .xq as suffix is the main module :)
+(: all functions defined in .xqm files (library modules) can be called here :)
+
+import module namespace myNs = "https://gitlab.utc.fr/crozatst/hdoc/tree/master/hdoc_to_basex" at "searchSectionByTitle.xqm", "searchSectionByTitle.xqm", "searchDocByAuthor.xqm";
+
+(: myNs:searchDocByTitle('^NF29_HdocEtherpad$', //document ):)
+(: myNs:searchSectionByTitle('contenu', //document) :)
+(: myNs:searchDocByAuthor('montangé', //document) :)
+
+myNs:searchSectionByTitle('xml', myNs:searchDocByAuthor('montangé', //document))
\ No newline at end of file

hdoc_to_basex/basex/xquery/searchDocByAuthor.hq → hdoc_to_basex/basex/xquery/searchDocByAuthor.xqm

@@ -4,7 +4,9 @@
 (: For example, $name := 'Montangé', to search for documents whose author named Coutant:)
 (: Remark : case and accents in author's name have been taken care of :)
 
-declare function local:searchDocByAuthor($name as xs:string, $docs as node()*) as node()*
+module namespace myNs = "https://gitlab.utc.fr/crozatst/hdoc/tree/master/hdoc_to_basex";
+
+declare function myNs:searchDocByAuthor($name as xs:string, $docs as node()*) as node()*
 {
   let $name_noAcc := translate($name, 'áàâäéèêëíìîïóòôöúùûüABCDEFGHIJKLMNOPQRSTUVWXYZ','aaaaeeeeiiiioooouuuuabcdefghijklmnopqrstuvwxyz')
   for $doc in $docs
@@ -15,7 +17,4 @@ declare function local:searchDocByAuthor($name as xs:string, $docs as node()*) a
     where matches($author_noAcc, $name_noAcc)
     group by $titre (: Avoid duplications of documents by their titre:)
     return $doc
-};
-
-(: Example :)
-local:searchDocByAuthor('Montangé', //document)
\ No newline at end of file
+};
\ No newline at end of file

hdoc_to_basex/basex/xquery/searchDocByTitle.hq → hdoc_to_basex/basex/xquery/searchDocByTitle.xqm

@@ -3,12 +3,11 @@
 (: For example, $name := '^NF29_HdocEtherpad$', to search for an exact name:)
 (: For example, $name := 'NF29', to search for documents whose name contains 'NF29':)
 
-declare function local:searchDocByTitle($name as xs:string, $docs as node()*) as node()*
+module namespace myNs = "https://gitlab.utc.fr/crozatst/hdoc/tree/master/hdoc_to_basex";
+
+declare function myNs:searchDocByTitle($name as xs:string, $docs as node()*) as node()*
 {
   for $doc in $docs
   where matches($doc/titre, $name, "i")
   return $doc
-};
-
-(: Example :)
-local:searchDocByTitle('^NF29_HdocEtherpad$', //document)
\ No newline at end of file
+};
\ No newline at end of file

hdoc_to_basex/basex/xquery/searchSectionByTitle.hq → hdoc_to_basex/basex/xquery/searchSectionByTitle.xqm

@@ -4,7 +4,9 @@
 (: For example, $keyword := 'Syntax', to search for sections whose titles containing "Syntax" :)
 (: Remark : case and accents in the keyword have been taken care of  :)
 
-declare function local:searchSectionByTitle($keyword as xs:string, $docs as node()*) as node()*
+module namespace myNs = "https://gitlab.utc.fr/crozatst/hdoc/tree/master/hdoc_to_basex";
+
+declare function myNs:searchSectionByTitle($keyword as xs:string, $docs as node()*) as node()*
 {
   let $keyword_noAcc := translate($keyword, 'áàâäéèêëíìîïóòôöúùûüABCDEFGHIJKLMNOPQRSTUVWXYZ','aaaaeeeeiiiioooouuuuabcdefghijklmnopqrstuvwxyz')
   for $doc in $docs
@@ -13,7 +15,4 @@ declare function local:searchSectionByTitle($keyword as xs:string, $docs as node
     let $title_noAcc := translate($section/titresection, 'áàâäéèêëíìîïóòôöúùûüABCDEFGHIJKLMNOPQRSTUVWXYZ','aaaaeeeeiiiioooouuuuabcdefghijklmnopqrstuvwxyz')
     where matches($title_noAcc, $keyword_noAcc)
     return $section
-};
-
-(: Example :)
-local:searchSectionByTitle('contenu', //document)
\ No newline at end of file
+};
\ No newline at end of file

hdoc_to_elasticSearch/hdoc_to_elasticsearch.ant

 <project name="hdoc_to_elasticsearch" default="clean"> 
 	
+	<!-- Use contribant -->
+	<taskdef resource="net/sf/antcontrib/antcontrib.properties">
+	  <classpath>
+		<pathelement location="lib/ant-contrib-0.3.jar"/>
+	  </classpath>
+	</taskdef>
+
 	<property file="build.properties"/>     
 	
-	<target name="unzipSource">
+	<target name="jsonFiles"> 
 		<echo message="Conversion begin" />
-		<path id="hdocDirPath">
-			<fileset dir="${inputPath}" id="hdocFile">
-			<include name="*.hdoc"/>
-			</fileset>
-		</path>
-		<property name="hdocFile" refId="hdocDirPath"/> 		
-		<basename property="hdocFileName" file="${hdocFile}" suffix=".hdoc"/>
-		<echo>Entry file : ${hdocFileName}</echo>
+		<echo>Entry file : ${fileToParse}</echo>
 
 		<!-- create subdirectory for each file -->
-		<mkdir dir="${tmpHdoc}/${hdocFileName}"/>
-
-		<!--unzips the hdoc to be converted into the previously created directory--> 
-		<unzip dest="${tmpHdoc}/${hdocFileName}">
-			<fileset dir="${inputPath}" id="hdocFile"> 			
-				<include name="${hdocFileName}.hdoc"/> 			
+		<mkdir dir="${tmpHdoc}" />
+		<basename property="fileToParseName" file="${inputPath}/${fileToParse}" suffix=".hdoc" />
+		<mkdir dir="${tmpHdoc}/${fileToParseName}"/>
+		
+		<!--unzips the hdoc to be converted into the previously created directory --> 
+		<unzip dest="${tmpHdoc}/${fileToParseName}">
+			<fileset dir="${inputPath}"> 			
+				<include name="${fileToParseName}.hdoc"/> 			
 			</fileset> 		
 		</unzip> 		
 
-	</target> 		
-	
-	<target name="jsonFiles" depends="unzipSource"> 
 		<echo message="JSON File creation" /> 		
-		<xslt in="${tmpHdoc}/${hdocFileName}/content.xml" out="${outputPath}/${hdocFileName}.json" style="xsl/content_extractor.xsl"/>
+		<xslt in="${tmpHdoc}/${fileToParseName}/content.xml" out="${outputPath}/${fileToParseName}.json" style="xsl/content_extractor.xsl"/>
 	</target> 			
 	
+	<!-- Parcours la liste des fichiers pour les transformer -->
+	<target name="targetAllFiles">
+		<delete>
+		   <fileset dir="${outputPath}">
+			  <include name="*.json"/>
+		   </fileset>
+		</delete>
+		<foreach target="jsonFiles" param="fileToParse">
+			<fileset dir="${inputPath}">
+				<include name="*.hdoc"/>
+			</fileset>
+		</foreach>
+	</target> 
+	
+	
 	<!-- Clear tmp files --> 	
-	<target name="clean" depends="jsonFiles">         
+	<target name="clean" depends="targetAllFiles">         
 		<echo message="Clean files" />
 		<!-- -->
 		<delete includeemptydirs="true" verbose="true">

hdoc_to_opale/xsl/transformation2.xsl

@@ -758,7 +758,7 @@
   <xsl:template match="h:div[@data-hdoc-type = 'choice-correct']"> 
     <sc:choice solution="checked">
       <xsl:call-template name="choice" />
-    <sc:choiceExplanation>
+      <sc:choiceExplanation>
       <op:txt>
         <sc:para>
           <xsl:apply-templates select="./h:div[@data-hdoc-type = 'explanation-choice-correct']/h:p/text()"/>
@@ -784,6 +784,15 @@
   <xsl:template match="./h:div[@data-hdoc-type = 'choice']">
     <sc:choice>
       <xsl:call-template name="choice" />
+      <xsl:if test="h:div[@data-hdoc-type = 'explanation-choice-correct']">
+        <sc:choiceExplanation>
+          <op:txt>
+            <sc:para>
+              <xsl:apply-templates select="./h:div[@data-hdoc-type = 'explanation-choice-correct']/h:p/text()"/>
+            </sc:para>
+          </op:txt>
+        </sc:choiceExplanation>
+      </xsl:if>
     </sc:choice>
   </xsl:template>
 

opale_to_canoprof/README.md

+Liste des fonctions du convertisseur wikipedia_to_canoprof
+
+
+
+Une activité est composée de : 
+- Entete : 
+    titre 
+    Durée => Ne peut pas être renseignée à partir de wiki 
+    organisation => Faisable
+    résumé => Concrètement le 1e paragraphe du wiki
+    Compétences du socle/ Notions et compétences/ métadonnées d'indexation => Correspond à quoi concrétement ?  
+- (Section | element)*
+Les éléments sont : 
+     *Information
+     *Attention
+     *Complément
+     *Conseil
+     *Définition
+     *Exemple
+     *Hypothèse 
+     *Méthode
+     *Rappel
+    *Question avec corrigé masqué ou non 
+     => Pas forcément utile dans le cas où les articles wikipédia ne comportent pas de QCM
+
+   
+Les sections sont composées : section(titre,element*)
+*titre
+*element
+
+
+Chaque element est decoupé en : element(titre?,contenu)
+Contenu est de la forme : 
+    1.Texte multimédia (paragraphe)*
+        paragraphe :
+            possibilité de mise en page 
+                         <important/>
+                        <italique/>
+                        Citation (paragraphe)
+                        Indice
+                        Exposant
+           Liens Web (url,titre,description) -> Utilité de description ? 
+           Lien vers activité = sc:uLink role="activity" 
+           Lien vers média = sc:uLink role="media"
+           Illustration  = <sc:extBlock role="illustration" sc:refUri="/texte.activite"/>
+           Inline image 
+           Liste = puce ou ordonné
+           Tableau => A priori pas utile, parce qu'avec Wikipédia, ca sera texte + url + image c'est tout
+                        Les tableaux seront sous forme d'image 
+           
+   2.Texte vis-à-vis = pas utile pour la transfo
+   3.Zone de saisie élève , consigne élève, remarque professeur => pas utiles non plus 
+   
+Mise en relation hdoc // Canoprof
+
+   
\ No newline at end of file