diff --git a/Readme.md b/Readme.md index 922aee25f0c35ccd2fd0c824dbe017054fd9e633..073d63b335352b2282e24538e49057765f6c754e 100644 --- a/Readme.md +++ b/Readme.md @@ -8,7 +8,9 @@ More info at [TDL website](https://tdl.etsi.org) The TDL tools are available as a set of Eclipse plug-ins. You need to first be able to run Eclipse. The [Eclipse Modeling Tools](https://www.eclipse.org/downloads/packages/release/2021-06/r/eclipse-modeling-tools) distribution contains most of the necessary prerequisites for the TDL tools. -Once Eclipse is up and running, you need to add the [update site](https://tdl.etsi.org/eclipse/latest/) for the TDL tools: +Once Eclipse is up and running, the easiest way to install the TOP tools is from the Eclipse Marketplace - simply search for TDL in the Eclipse Marketplace client within Eclipse, or go to the [TOP Marketplace Listing](https://marketplace.eclipse.org/content/top-tdl-open-source-project) and drag the install button into the Eclipse window. + +Alternatively, can install the plug-ins manually from an update site. In this case, you need to add the [update site](https://tdl.etsi.org/eclipse/latest/) for the TDL tools: https://tdl.etsi.org/eclipse/latest/ @@ -48,6 +50,12 @@ The same steps can be applied to create a new TDL model by means of the brace-ba More information on using the plugins is available at [Usage wiki](https://labs.etsi.org/rep/top/ide/-/wikis/Usage). +## Textual Syntax Specifications + +The complete specification for the standardised textual syntax ([ES 203 119-8 v1.1.1 (to be published in March 2022)](https://tdl.etsi.org/index.php/downloads)) as well as the corresponding extensions for Structured Testo Objective Specifications ([ES 203 119-4 v1.5.1, clause 8 (to be published in March 2022)](https://tdl.etsi.org/index.php/downloads)) Extended Test Configurations ([ES 203 119-7 v1.3.1, clause 8 (to be published in March 2022)](https://tdl.etsi.org/index.php/downloads)) is available in [TDLtx.xtext](plugins/org.etsi.mts.tdl.tx/src/org/etsi/mts/tdl/TDLtx.xtext). It uses the [Xtext Grammar Language](https://www.eclipse.org/Xtext/documentation/301_grammarlanguage.html) which also allows the specification of the bindings between the textual syntax elements and the meta-model elements. By default, brace-based delimiters are used (i.e. the "brace-based variant"). Instead, the [TDLtxi.xtext](plugins/org.etsi.mts.tdl.txi/src/org/etsi/mts/tdl/TDLtxi.xtext) specifies the necessary overrides for the indentation-based delimiters (i.e. the "indentation-based variant"). + +From end-user's perspective this translates to two file extensions - `.tdltx` for the brace-based variant and `.tdltxi` for the indentation-based variant. The TOP plug-ins provide a function (from the menu "TDL->Translate TDL modeling") to convert between the available formats, including the standardised exchange format ([ES 203 119-3 v1.5.1 (to be published in March 2022)](https://tdl.etsi.org/index.php/downloads)). The available formats depend on the installed plug-ins. + ## Setting up a local environment for development and testing * Download and install Eclipse Modeling Tools package @@ -93,9 +101,11 @@ Part of the implementation was developed as a lab project with contributions fro The generation of data types based on ASN.1 specifications is based on the [BeanIt ASN1Bean](https://github.com/beanit/asn1bean) (formerly known as jASN). The implementation currently supports: - * Importing of data definitions within the module (imports from other modules are currently not resolved). + * Importing of data definitions within the module (imports from other modules) are currently not resolved. * Application of annotations or data constraints (e.g. for `CHOICE` data types or other modifiers). +Note that the upstream components provided by the ASN1Bean may not be able to process all ASN.1 specifications as they do not provide 100% coverage of the ASN.1 syntax. In this case, the outcome may be incomplete. + ### Implementation of the transformation of Structured Test Objectives to TDL Test Descriptions The transformation of Structured Test Objectives into TDL Test Descriptions currently supports: * Transforming of inline data descriptions within `EventOccurrences` into corresponding data types.