Skip to content

Commit

Permalink
[CI] Publish Documentation for 4459d49
Browse files Browse the repository at this point in the history
  • Loading branch information
NPJ-OP-LUX committed Dec 11, 2024
1 parent cd6cbd1 commit 268e68e
Show file tree
Hide file tree
Showing 26 changed files with 7,281 additions and 6,766 deletions.
4 changes: 2 additions & 2 deletions ODS/latest/mapping/reusing.html
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,7 @@ <h2 id="_initial_phase"><a class="anchor" href="#_initial_phase"></a>Initial Pha
/transformation/resources additional resources possibly needed by the transformation rules;
The content of this folder should be automatically generated by the a mapping package processor, based on the "Resources" sheet of the conceptual_mappings.xlsx

MPORTANT!!! In these rules the source XML is always referring to data/source.xml, which corresponds to the ../../data/source.xml file that will be copied (and renamed) from the test_data folder at the time of the execution of the mapping.
IMPORTANT!!! In these rules the source XML is always referring to data/source.xml, which corresponds to the ../../data/source.xml file that will be copied (and renamed) from the test_data folder at the time of the execution of the mapping.

/test_data manually and carefully selected test data possibly grouped in suborders, e.g. /test_data/batch-D1/*.xml

Expand Down Expand Up @@ -574,7 +574,7 @@ <h2 id="_mapping_suite_package_description_for_the_semantic_engineers_after_the_
&lt;notice_file3&gt;.xml
*.xml

/output/&lt;notice_file1&gt; for each example file a folder is creatated that contains all the generated artefacts for that sample file
/output/&lt;notice_file1&gt; for each example file a folder is created that contains all the generated artefacts for that sample file

/output/test_suite_report validation reports summarising all individual reports

Expand Down
2 changes: 1 addition & 1 deletion ODS/latest/mapping/toolchain.html
Original file line number Diff line number Diff line change
Expand Up @@ -524,7 +524,7 @@ <h3 id="_metadata_generator_metadata_generator"><a class="anchor" href="#_metada
<div class="sect2">
<h3 id="_yarrrml_to_rml_converter_yarrrml2rml_converter"><a class="anchor" href="#_yarrrml_to_rml_converter_yarrrml2rml_converter"></a>YARRRML to RML Converter (yarrrml2rml_converter)</h3>
<div class="paragraph">
<p>This command line tool allows the conversion of a mapping expressed in the more user-friendly YARRRML syntax to RML. This is a very useful tool, especially at initial phases of the mapping development, or for newcomers, as it is easier and faster to write YARRRML rules than RML rules. This tool is not used anymore in the current development process as, due to technical reasons, the mappings are developed directly in RML, not in YARRRML.</p>
<p>This command line tool allows the conversion of a mapping expressed in the more user-friendly YARRRML syntax to RML. This is a very useful tool, especially at initial phases of the mapping development, or for newcomers, as it is easier and faster to write YARRRML rules than RML rules. This tool is not used any more in the current development process as, due to technical reasons, the mappings are developed directly in RML, not in YARRRML.</p>
</div>
</div>
<div class="sect2">
Expand Down
2 changes: 1 addition & 1 deletion ODS/latest/mapping_eforms/glossary.html
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,7 @@ <h2 id="_glossary"><a class="anchor" href="#_glossary"></a>Glossary</h2>
relational database management systems (RDBMS).</p>
</div>
<div class="paragraph">
<p><strong>OWL</strong> Web Ontology Language - A declarative computer data modeling language
<p><strong>OWL</strong> Web Ontology Language - A declarative computer data modelling language
specifically designed for creating and expressing ontologies, built on top of
the RDF-Schema knowledge representation standard. It provides a richer
<em>vocabulary</em> and more powerful logical constructs for defining complex
Expand Down
8 changes: 4 additions & 4 deletions ODS/latest/mapping_eforms/methodology.html
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,7 @@ <h3 id="_mapping_groups"><a class="anchor" href="#_mapping_groups"></a>Mapping G
<div class="sect2">
<h3 id="_modular_rml_mappings"><a class="anchor" href="#_modular_rml_mappings"></a>Modular RML Mappings</h3>
<div class="paragraph">
<p>Given the large number of mappings that are necessry for the conversion of a certain eForms Notice (the CM contains around 500 entries for various fields and nodes that belong to a type of notice), a mapping package ends up containing 200+ RML TriplesMaps with 500+ predicateObjectMap, resulting in more than 11,000 lines of RML code. To be able to efficiently and properly manage this amount of information, we split it up into multiple RML files that are organized following a certain logic.</p>
<p>Given the large number of mappings that are necessary for the conversion of a certain eForms Notice (the CM contains around 500 entries for various fields and nodes that belong to a type of notice), a mapping package ends up containing 200+ RML TriplesMaps with 500+ predicateObjectMap, resulting in more than 11,000 lines of RML code. To be able to efficiently and properly manage this amount of information, we split it up into multiple RML files that are organized following a certain logic.</p>
</div>
<div class="paragraph">
<p>The structure of the RML files (we call them <em>modules</em> because they are modular
Expand Down Expand Up @@ -494,7 +494,7 @@ <h3 id="_modular_rml_mappings"><a class="anchor" href="#_modular_rml_mappings"><
</div>
</div>
<div class="paragraph">
<p>Looking at the above example we can observe that, on one hand, a node <code>ND-LotsGroup</code> can have children fields that provide information for the generation of multiple insctances, e.g. an <code>epo:LotGroup</code> instance from <code>tedm:MG-{LotGroup}_ND-{LotsGroup}</code>, and an <code>adms:Identifier</code> instance from <code>tedm:MG-{Identifier}-{identifier}-{LotGroup}_ND-{LotsGroup}</code>. On the other hand, the full definition of the same EPO instance, can achieved by combining information provided in fields that are organized under different nodes, e.g. the MonetaryValue that represents the hasLaunchFrameworkAgreementMaximumValue property of a LotGroup can come both from fields that are chidren of the <code>ND-LotsGroupValueEstimateExtension</code> node and those that are children of the <code>ND-LotsGroupFA</code> node:</p>
<p>Looking at the above example we can observe that, on one hand, a node <code>ND-LotsGroup</code> can have children fields that provide information for the generation of multiple instances, e.g. an <code>epo:LotGroup</code> instance from <code>tedm:MG-{LotGroup}_ND-{LotsGroup}</code>, and an <code>adms:Identifier</code> instance from <code>tedm:MG-{Identifier}-{identifier}-{LotGroup}_ND-{LotsGroup}</code>. On the other hand, the full definition of the same EPO instance, can achieved by combining information provided in fields that are organized under different nodes, e.g. the MonetaryValue that represents the hasLaunchFrameworkAgreementMaximumValue property of a LotGroup can come both from fields that are children of the <code>ND-LotsGroupValueEstimateExtension</code> node and those that are children of the <code>ND-LotsGroupFA</code> node:</p>
</div>
<div class="listingblock">
<div class="content">
Expand All @@ -515,7 +515,7 @@ <h3 id="_modular_rml_mappings"><a class="anchor" href="#_modular_rml_mappings"><
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-BASH hljs" data-lang="BASH">Lot.rml.ttl # mappings valid accross all SDK versions
<pre class="highlightjs highlight"><code class="language-BASH hljs" data-lang="BASH">Lot.rml.ttl # mappings valid across all SDK versions
Lot_v1.3-1.8.rml.ttl # mappings valid up to SDK version 1.8 (inclusive)
Lot_v1.4+.rml.ttl # mappings valid for all SDK versions starting with v1.4
Lot_v1.7+.rml.ttl # mappings valid for all SDK versions starting with v1.7
Expand All @@ -527,7 +527,7 @@ <h3 id="_modular_rml_mappings"><a class="anchor" href="#_modular_rml_mappings"><
</div>
<div class="paragraph">
<p><strong>Important Note: </strong>
The TriplesMaps in the various RML modules, especially those that represent version specific mappings, can spread accross multiple files. For example, a TriplesMap can have it logical source/iterator, its subject map, and its various predicat-object maps in several files, depending on what aspect is specified in a given SDK version and/or belongs to a given module. However, this information needs to be provided and organized in such a manner that when they are combined together in a package, the RML mappings should be valid, complete, correct and non-conflicting. E.g. every TriplesMap, after the modules are combined, should have one and only one logical source and subject map, and the subject map and all predicate-obect maps should work with the logical source that they are conbined with.</p>
The TriplesMaps in the various RML modules, especially those that represent version specific mappings, can spread across multiple files. For example, a TriplesMap can have it logical source/iterator, its subject map, and its various predicate-object maps in several files, depending on what aspect is specified in a given SDK version and/or belongs to a given module. However, this information needs to be provided and organized in such a manner that when they are combined together in a package, the RML mappings should be valid, complete, correct and non-conflicting. E.g. every TriplesMap, after the modules are combined, should have one and only one logical source and subject map, and the subject map and all predicate-object maps should work with the logical source that they are combined with.</p>
</div>
</div>
<div class="sect2">
Expand Down
2 changes: 1 addition & 1 deletion ODS/latest/mapping_eforms/package_structure.html
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,7 @@ <h1 class="page">eForms Mapping Suite Structure</h1>
<h2 id="_the_eforms_metadata_sheet"><a class="anchor" href="#_the_eforms_metadata_sheet"></a>The eForms Metadata sheet</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The content of the "Metadata" sheet of an eForms Conceptual Mapping (which is slighly different from the <a href="https://docs.ted.europa.eu/SWS/mapping_suite/methodology.html#_the_metadata_sheet">Metadata sheet</a> of a Standard Forms CM) looks like this:</p>
<p>The content of the "Metadata" sheet of an eForms Conceptual Mapping (which is slightly different from the <a href="https://docs.ted.europa.eu/SWS/mapping_suite/methodology.html#_the_metadata_sheet">Metadata sheet</a> of a Standard Forms CM) looks like this:</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="_images/metadata_sheet.png" alt="metadata sheet"></span></p>
Expand Down
30 changes: 4 additions & 26 deletions api/3.0/authenticate.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Authentication API :: TED Developer Documentation</title>
<title>Untitled :: TED Developer Documentation</title>
<meta name="generator" content="Antora 3.1.2">
<link rel="stylesheet" href="../../_/css/site.css">
<link rel="stylesheet" href="../../_/css/custom.css">
Expand Down Expand Up @@ -84,8 +84,8 @@ <h3 class="title"><a href="index.html">TED API</a></h3>
<li class="nav-item" data-depth="1">
<span class="nav-text"><span class="separated"><strong>Available APIs</strong></span></span>
</li>
<li class="nav-item is-current-page" data-depth="1">
<a class="nav-link" href="authenticate.html">Authentication API</a>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="developer%20operations.html">Developer Operations API</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="convert.html">Conversion API</a>
Expand Down Expand Up @@ -231,10 +231,6 @@ <h3 class="title"><a href="index.html">TED API</a></h3>
<button class="nav-toggle"></button>
<a href="../../home/index.html" class="home-link"></a>
<nav class="breadcrumbs" aria-label="breadcrumbs">
<ul>
<li><a href="index.html">TED API</a></li>
<li><a href="authenticate.html">Authentication API</a></li>
</ul>
</nav>
<div class="page-versions">
<button class="version-menu-toggle" title="Show other versions of page">3.0-rc.1</button>
Expand All @@ -249,25 +245,7 @@ <h3 class="title"><a href="index.html">TED API</a></h3>
<div class="toc-menu"></div>
</aside>
<article class="doc">
<h1 class="page">Authentication API</h1>
<div class="paragraph">
<p>Authentication API provides operation:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-none hljs">POST /v3/api-keys/{token}/renew</code></pre>
</div>
</div>
<div class="ulist">
<ul>
<li>
<p>This operation extends the validity of an expiring <a href="https://docs.ted.europa.eu/api/index.html#_api_key_lifetime">API key</a>.</p>
</li>
<li>
<p>Parameter <code>token</code> is mandatory and it can be found in the hyperlink in the sent email with subject <em>[Ted Developer Portal] Your API key will soon expire, please renew it</em>.</p>
</li>
</ul>
</div>

</article>
<div id="widgetContainer">
<article class="widget">
Expand Down
2 changes: 1 addition & 1 deletion api/3.0/convert.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ <h3 class="title"><a href="index.html">TED API</a></h3>
<span class="nav-text"><span class="separated"><strong>Available APIs</strong></span></span>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="authenticate.html">Authentication API</a>
<a class="nav-link" href="developer%20operations.html">Developer Operations API</a>
</li>
<li class="nav-item is-current-page" data-depth="1">
<a class="nav-link" href="convert.html">Conversion API</a>
Expand Down
Loading

0 comments on commit 268e68e

Please sign in to comment.