Commit 8c6b7614 authored by Ivan D'halluin's avatar Ivan D'halluin

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

parents 5232ad43 cfc28ca4
# HDOC CONVERTER PROJECT
# Hdoc Converter Projet
License GPL3.0
http://www.gnu.org/licenses/gpl-3.0.txt
Credits : Université de Technologie de Compiègne, NF29 course students
## What is Hdoc ?
......@@ -10,4 +15,11 @@ Please refer to the [Hdoc converter project website](http://hdoc.crzt.fr/www/co/
## What is this repository ?
This repository gathers some of the Hdoc converters, if not all of them.
\ No newline at end of file
This repository gathers some of the Hdoc converters, if not all of them.
Project URL : https://gitlab.utc.fr/crozatst/hdoc.git
## How to use Hdoc Converters ?
In order to use a converter, choose the corresponding folder and consult README.md for instructions.
# antce
"antce" is not for use, it is just a base for autonomous multi-OS ANT launcher
......@@ -55,7 +55,7 @@
</target>
<target name="buildOutput" depends="unzipSource">
<xslt classpath="${libdir}/saxon9he.jar" style="${xsldir}/termToRef.xsl" basedir="${srcdir}" destdir="${OutputPath}" followsymlinks="false" extension=".ref">
<xslt classpath="${libdir}/saxon9he.jar" style="${xsldir}/termToRdf.xsl" basedir="${srcdir}" destdir="${OutputPath}" followsymlinks="false" extension=".rdf">
<include name="**/*.term"/>
</xslt>
<copy file="opale.wspmeta" tofile="${OutputPath}/.wspmeta"></copy>
......@@ -71,4 +71,4 @@
<delete dir="${outdir}" />
</target>
</project>
\ No newline at end of file
</project>
......@@ -4,11 +4,9 @@
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:ont="nf29ont"
xmlns:sp="http://www.utc.fr/ics/scenari/v3/primitive"
xmlns:sc="http://www.utc.fr/ics/scenari/v3/core"
xmlns:lx="scpf.org:lexicon"
xmlns:op="utc.fr:ics/opale3"
exclude-result-prefixes="xs"
exclude-result-prefixes="xs sp sc lx"
version="2.0">
<xsl:output method="xml" indent="yes" />
......
......@@ -198,6 +198,11 @@
<mkdir dir="${tmp}"/>
<delete dir="${out}" failonerror="false"/>
<mkdir dir="${out}"/>
<delete dir="${optim_to_hdoc_in}" failonerror="false"/>
<mkdir dir="${optim_to_hdoc_in}"/>
<delete dir="${hdoc_to_opale_in}" failonerror="false"/>
<mkdir dir="${hdoc_to_opale_in}"/>
</target>
</project>
\ No newline at end of file
Optim to Opale (optim_to_opale)
-------------------------------
Optim to Opale (`optim_to_opale`)
===============================
Last edit: January 4, 2016
Last edit: December 17, 2015
License
-------
This project is under [GPL 3.0 licence](http://www.gnu.org/licenses/gpl-3.0.txt).
# Purpose
Credits
-------
### Autumn 2015
`optim_to_opale` is an ANT script to convert a file from Optim format to Opale format.
* Ivan D'HALLUIN
* JEFFREY DECORDE
* Jean-Baptiste MARTIN
# Dependencies
Presentation
------------
`optim_to_opale` is an ANT script that converts a file from Optim format to Opale format. It simply calls `optim_to_hdoc`and `hdoc_to_opale`scripts.
Dependencies
------------
In order to work properly this script needs
1. `optim_to_hdoc` (Optim to HDoc conversion)
2. `hdoc_to_opale` (HDoc to Opale conversion)
1. [`optim_to_hdoc`](https://gitlab.utc.fr/crozatst/hdoc/tree/master/optim_to_hdoc) (Optim to HDoc conversion)
2. [`hdoc_to_opale`](https://gitlab.utc.fr/crozatst/hdoc/tree/master/hdoc_to_opale) (HDoc to Opale conversion)
# Running the script
User Documentation
------------------
### Running the script
1. Put the file you want to convert into the `input` directory
2. Run the `run.sh`file on a Unix system (Linux, Mac OS, etc.) or the `run.bat`on Windows
3. Your converted file is placed into the `output` directory (a log file is also placed into the `log`directory)
4. Enjoy!
# How is this script working
### How is this script working
1. The script first determines what OS you are using so it then can call the right scripts
2. It cleans the `log`, `tmp`and `output`directories
......@@ -32,3 +45,21 @@ In order to work properly this script needs
7. It copies the files that are inside the `output`directory of `hdoc_to_opale` to the `output` directory of `optim_to_opale`
During all the process it also prints some basic information both on screen and in the log file.
Unsupported
-----------
* The script currently doesn't support any paramater to specify the file to convert. If multiple files are in the `input`directory, the script will convert all these files.
Known bugs
----------
N/A for now.
Todo
----
Technical notes
---------------
Capitalization
--------------
<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
exclude-result-prefixes="xs"
version="2.0"
xmlns:saxon="http://saxon.sf.net/"
extension-element-prefixes="saxon"
>
<!-- This XSL create an ANT script that will download our ressources (images) using the GET TASK-->
<xsl:output method="xml" indent="yes" encoding="UTF-8"/>
<xsl:template match="/">
<xsl:param name="dest-rep">${hdocResultPath}/ressources</xsl:param>
<project name="getRessourcesFiles" basedir="." default="getRessourcesFiles">
<!-- Ccreation of the ressources folder -->
<mkdir dir="{$dest-rep}"/>
<target name="getRessourcesFiles">
<xsl:apply-templates select="//div[@class='thumb tleft' or @class='thumb tright']//img | //p//img | //center//img | //li//img"/>
<!-- If an image doesn't appear in final result you should add it to the apply-template above-->
</target>
</project>
</xsl:template>
<!-- What has been changed starts from here -->
<xsl:template match="img" priority="5">
<!-- Now the storage structure of the images will become :
ressources
image.jpeg (this is a folder)
image.jpeg
meta.xml
-->
<!-- The meta.xml contains the copyright file of the image -->
<!-- The meta.xml should respect the structure given to you in official-meta.xml (it's available in the same level as this file) )-->
<xsl:param name="dest-rep-image">${hdocResultPath}/ressources/<xsl:value-of select="translate(tokenize(@src, '/')[last()],'?%','_')"/></xsl:param>
<xsl:param name="dest-file">${hdocResultPath}/ressources/<xsl:value-of select="translate(tokenize(@src, '/')[last()],'?%','_')"/>/<xsl:value-of select="translate(tokenize(@src, '/')[last()],'?%','_')"/>
</xsl:param>
<xsl:param name="dest-file-meta">${hdocResultPath}/ressources/<xsl:value-of select="translate(tokenize(@src, '/')[last()],'?%','_')"/>/meta.xml</xsl:param>
<xsl:param name="copyright-link"><xsl:value-of select="following-sibling::a[1]/@href"/></xsl:param>
<mkdir dir="{$dest-rep-image}"/>
<get src="{@src}" dest="{$dest-file}" /><!-- Get The image -->
<!-- Get the copyright file of the image if it existt -->
<xsl:if test="$copyright-link !=''" >
<get src="{$copyright-link}" dest="{$dest-file-meta}" />
<!-- Here You should generate Your XSL transformation to extract the right information from the copyright file (final result should be similar as official-meta.xml)
Very Important, The title of the image is not present in the copyright file BUT We have prepared it already in the @alt attribute
-->
</xsl:if>
</xsl:template>
</xsl:stylesheet>
\ No newline at end of file
<?xml version="1.0" encoding="UTF-8"?>
<sfm:jpg_jpeg xmlns:op="utc.fr:ics/opale3" xmlns:sc="http://www.utc.fr/ics/scenari/v3/core" xmlns:sfm="http://www.utc.fr/ics/scenari/v3/filemeta">
<op:imgM xmlns:sp="http://www.utc.fr/ics/scenari/v3/primitive">
<sp:title>Principal title</sp:title>
<sp:info>
<op:infoBin>
<sp:cc>zero</sp:cc>
<sp:ccVersion>2.5</sp:ccVersion>
</op:infoBin>
</sp:info>
<sp:alt>
<sp:type>info</sp:type>
<sp:altTxt>remplacement text</sp:altTxt>
<sp:desc>
<op:sTxt>
<sc:para xml:space="preserve">Complete description</sc:para>
</op:sTxt>
</sp:desc>
</sp:alt>
</op:imgM>
</sfm:jpg_jpeg>
\ No newline at end of file
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