Commit 005fff1b authored by Decorde Jeffrey's avatar Decorde Jeffrey

New README

parent 178904bf
......@@ -23,7 +23,7 @@ Credits
Presentation
---
"Hdoc to Opale" is an hdoc converted to Opale files. It's a set of ANT scripts and XSL files
"Hdoc to Opale" is an hdoc converter to Opale files. It's a set of ANT scripts and XSL files
Dependencies
---
......@@ -41,14 +41,14 @@ User Documentation
### How it works
Before, the converted processed all files in the same time. Now, it processes each files one by one. That will allow some improvements in the future.
Before, the converter processed all files in the same time. Now, it processes each files one by one. That will allow some improvements in the future.
Unsupported
---
### Single file conversion with parameter
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.
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. To do this, I suggest to add an optional parameter in the run.bat and run.sh files which has the name of an input file as a value. Then, in the main ANT file, 'hdoc_to_opale.ant', you'll have to check the presence of the parameter and choose the processing according to it.
Known bugs
---
......@@ -70,7 +70,6 @@ Todo list
* Single file conversion with parameter :
* Solve bugs
* (Optional) Port to XSLT 2.0
Technical Notes
---
......@@ -80,10 +79,11 @@ Technical Notes
This converter is using standard NF29 conversion project structure : I use a main ANT file (hdoc_to_opale.ant), which handles routine tasks (zipping/unzipping archives, copying files), XSL-XSLT transformation or other ANT scripts calls.
This main ANT file is composed of several targets : we chose not to use their "depends" attributes in order to make the building process easier to understand (and, if needed, to correct).
Basically, the default target (named "convert") calls every other targets or ANT scripts in a precise order via the <antcall> (or <ant>) task.
The files in the input folder are processed one by one.
### Temporary files
During the conversion process, we use several temporary files : their content depends on hdoc's files (such as "container.xml", "content.xml" and ressource files). See details below.
During the conversion process, we use several temporary files : their content depends on hdoc's files (such as "container.xml", "content.xml" and ressource files). There is temporary folder for each file processed.
### What does the main ANT file do ?
......@@ -117,7 +117,8 @@ When moveRessourceFiles.xsl is applied on hdoc's content file (usually named "co
### Main XSL-XSLT transformation (transformation.xsl)
It consists in a simple ANT task : the main transformation file ("transformation2.xsl") matches hdoc markups and tries to convert them into opale markups.
For any further details (supported/unsupported markups and microdatas) I suggest you to read "transformation2.xsl"'s comments and Supported/Unsupported section (if needed, send me an-email).
Capitalization
---
The understanding of the conversion was a bit long and dfficult. Indeed, there are some transformations which creates other ANT files which are executed. But this project has streghtened my knowledge of ANT and XSLT.
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