From 49ff8f4e7e0b377bca706909b4b3e5b40fa4d277 Mon Sep 17 00:00:00 2001 From: Paul Donohoe Date: Wed, 30 Mar 2022 09:58:15 +0200 Subject: [PATCH] TEDXDC-112 Updates to the markdown files --- Installation.md | 16 +--------------- README.md | 13 ++++++++----- Usage-Information.md | 2 +- examples/ted-xml/.keep | 0 4 files changed, 10 insertions(+), 21 deletions(-) delete mode 100644 examples/ted-xml/.keep diff --git a/Installation.md b/Installation.md index 26f7f22..46b444f 100644 --- a/Installation.md +++ b/Installation.md @@ -14,11 +14,6 @@ These instructions are for installation in a Unix environment. ## Summary To run the converter requires the following : -* Java -* Saxon 9-HE (or later) -* This repository - - ### Java The user's system must have either a Java Virtual Machine, or a Java development environment. At least Java SE 8 (also known as JDK 1.8) must be available. Java must be available to run from the Unix terminal. Type "java -version" to confirm. @@ -37,6 +32,7 @@ Documentation on running XSL using Saxon9 is available here: https://saxonica.co Clone the TED XML Data Converter from https://citnet.tech.ec.europa.eu/CITnet/stash/projects/TEDXDC/repos/ted-xml-data-converter/browse. +
## Using the TED XML Data Converter @@ -50,17 +46,7 @@ To convert all the test TED XML files use: `find ted-xml -type f -name "*.xml" | while read -r file; do outfile=${file/ted-xml/eforms-xml}; java -Xms6291456 -cp [path to saxon folder]/saxon9he.jar net.sf.saxon.Transform -dtd:off -expand:off -strip:all -s:"$file" -xsl:xslt/ted-to-eforms.xslt -o:"$outfile"; done ` -
- -### Testing the XSLT - -The XSLT can be tested using the unit-testing [XSpec framework](https://github.com/xspec/xspec). Tests are written in XML, and reports are output in both XML and HTML. - -The Unix command to test the XSLT is: - -[path to XSpec folder]/bin/xspec.sh xslt/test-ted-to-eforms-xslt.xspec -XSpec compiles the given XSpec test file to XSLT, then executes it. The resulting report is available in XML and HTML format. All these files are placed in an `xspec` folder within the `xslt` folder. diff --git a/README.md b/README.md index c649e4c..399580c 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,8 @@ The TED XML Data Converter is designed to help with this process, by converting The code for the TED XML Data Converter is contained in this repository. Basic usage instructions for developers to run the code in their own system is available [here](Usage-Information.md). An API will be developed for the converter. A user will specify the TED notice number, and the API will retrieve the published TED notice XML, convert it to eForms XML and return it to the user. +# About the converter + ## XML output will be incomplete and invalid. The XML output from the TED XML Data Converter will not be complete, and will also contain some errors. It will not pass all the eForms Schematron checks. This is because: @@ -31,11 +33,12 @@ The TED XML Data Converter will report these issues as comments and application- The current version of the TED XML Data Converter will only convert a limited subset of published TED notices: -* TED Schema: Only TED schema R.2.0.9 is supported. Notices published under Directive 23 cannot be converted with this version of the Converter. -* TED Schema version: Only the latest version of the TED schema R.2.0.9 (S05) is supported. Notices published under earlier versions of the schema may be converted, but may contain more errors. -* Document Types: Only Contract Notices are currently supported: -** All elements in TED XML form F02 are supported -** Most elements in TED XML forms F05, F12 and the Contract Notice variants of forms F21, F22, F23 and F24 are supported +* TED Schema: only TED schema R.2.0.9 is supported. Notices published under Directive 23 cannot be converted with this version of the Converter. +* TED Schema version: only the latest version of the TED schema R.2.0.9 (S05) is supported. Notices published under earlier versions of the schema may be converted, but may contain more errors. +* Document Types: only Contract Notices are currently supported: + * All elements in TED XML form F02 are supported + * Most elements in TED XML forms F05, F12 and the Contract Notice variants of forms F21, F22, F23 and F24 are supported +* Languages: currently the converter only converts the main (original) language of each notice. Other languages which may be present in the TED XML are not included. ## HTML Comments in output eForms XML diff --git a/Usage-Information.md b/Usage-Information.md index a3c80d0..6a0dd70 100644 --- a/Usage-Information.md +++ b/Usage-Information.md @@ -8,7 +8,7 @@ The repository contains the following folders: | `xslt` | The xslt and data for the conversion | | `sample-files/ted-xml` | Sample source TED XML files. See [Files-Selected-for-Testing.md](sample-files/Files-Selected-for-Testing.md) | | `sample-files/eforms-xml` | The sample source TED XML files converted to eForms XML files. | -| `structure-files` | This folder should be removed. Files used for analysis | +| `structure-files` | Sample files for the structure of eForms XML. Only the notice-structure-CN.xml is complete. | | `examples` | Some files in this folder should be removed. Sample XML in TED schema XML and eForms XML format for testing the converter | ## XSLT files diff --git a/examples/ted-xml/.keep b/examples/ted-xml/.keep deleted file mode 100644 index e69de29..0000000