Commit 18b80ee9 authored by Nicolas Sannier's avatar Nicolas Sannier
Browse files

ReadMe description (work in progress)

parent 75108294
Open ARMLET (Automated Retrieval of Metadata in Legal Texts) is the open source version of ARMLET, a framework aimed, in this version, at retrieving structural metadata, e.g., titles, chapters, articles, paragraphs, alineas as well as cross-references from legal texts, more specifically legislative acts.
The goal of the ARMLET project is to provide a configuratble framework for automated extraction of legal metadata from legal texts to support activities on legal texts such as open data, legal search, legal compliance checking legal data management and targets more particularly the conversion of legislative texts from doc(x) or PDF to XML for open and transparent legislative data
# Background
This project has been developed over the years at the Interdisciplinary Centre for Security, Reliability and Trust from the University of Luxembourg, in collaboration with the Central Legislative Service (Service central de législation) from the Ministry of State of Luxembourg.
In particular, ARMLET has been developed, tested and improved over several legislative acts, including codes, laws and regulations.
Some configuration examples provided in the projects are actual legislative acts published on the legilux portal (, the online official gazette of the Grand-Duchy of Luxembourg.
# Folder Organization
- Note that ARMLET is built upon the NLP framework Gate (, an open source framework developed and maintained by the University of Sheffield. (Gate 8.1 and Libs folders).
- The NLP framework leverages NLP scripts in the jape language, that can be bundled into applications and executed over the texts. In ARMLET, many of the scripts we use are aimed to be executed as-is ov the text (Jape folder), whereas some will be automatically generated or reused (CustomJape folder), depending of the configuration you bring in.
- Some configuration files can be found in the Test folder.
- Regarding the structure configuration, they are defined according to two files, a <name>_structure.json file and <name>_rules.json file. The first one is aimed at describing the structural hierarchy of the document, the second one is aimed at describing the detection rules for these structures. More details are provided in the documentation. These can be found in the Structure and CustomStructure folders. All apologies for the current mess in the folder. Note that the file location is quite irrelevant as long as both files are correctly referenced in the configuration file and that the naming convention is correct. From these two files, ARMLET will automatically generate jape scripts and Gate applications in the CustomJape and Apps folders for the detection of structural metadata.
# Installation and setup
ARMLET comes as a whole and is executed via calling the ArmletMain.jar with one argument, which is the path to a configuration file containing the necessary information for converting a document into xml.
More information can be found in the documentation folder.
Supports Markdown
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