Documentation for the doc2tosca tool (a3fe4f09) · Commits · CTI Tools / tosca2doc

src/templates/doc2tosca-details.html

+33 −4

Changes for src/templates/doc2tosca-details.html: 33 added lines, 4 removed lines.
Original line number	Original line	Diff line number	Diff line
	@@ -25,16 +25,45 @@

	<center>		<center>
	<h1>doc2tosca details</h1>		<h1>doc2tosca details</h1>
			<a href="/">Home</a>
	<h5 style="margin-bottom: 50px">v {{ VERSION }}</h5>		<h5 style="margin-bottom: 50px">v {{ VERSION }}</h5>
	<p>		</center>
	The tools available on this page are provided with NO GUARANTEES and shall be used ONLY for validation of ETSI Specifications.
	<br/>		<h4>Overview
	For any inquiry, contact <a href="mailto:cti_support@etsi.org">ETSI CTI</a></p>		</h4>

			<p>The tool works as follows:</p>

			<p>Step 1: In the uploaded Document it searches for headings equal to:</p>

			<ul>
			<li><code>6 VNFD TOSCA model</code></li>
			<li><code>7 NSD TOSCA model</code></li>
			<li><code>8 PNFD TOSCA model</code>,</li>
			</ul>

			<p>Step 2: For each of the section after the heading (and until the next heading is found), the tool searches for tables with the following properties:</p>

			<ul>
			<li>It contains only one cell (i.e. one row and one column) and</li>
			<li>the content matches the regular expression <code>^tosca\.[a-zA-Z\.:0-9\s]*$</code>, i.e. the text starts with <code>tosca.</code> and contains letters, numbers, <code>:</code> or white space.</li>
			</ul>

			<p>Step 3: The three sets of generated definitions are written to files named:</p>

			<ul>
			<li><code>generated_etsi_nfv_sol001_vnfd_types.yaml</code></li>
			<li><code>generated_etsi_nfv_sol001_nsd_types.yaml</code></li>
			<li><code>generated_etsi_nfv_sol001_pnfd_types.yaml</code></li>
			</ul>

			<p>Step 4: The files are archived in a zip file named <code>tosca_defs.zip</code> which is served as a response.</p>

	<center>		<center>
			<p>
			The tools available on this page are provided with NO GUARANTEES and shall be used ONLY for validation of ETSI Specifications.
			<br/>
			For any inquiry, contact <a href="mailto:cti_support@etsi.org">ETSI CTI</a></p>
	<small>Copyright © ETSI 2019. All rights reserved.</small>		<small>Copyright © ETSI 2019. All rights reserved.</small>
	</center>		</center>
	</body>		</body>

src/templates/doc2tosca-details.md

0 → 100644

+21 −0

Changes for src/templates/doc2tosca-details.md: 21 added lines, 0 removed lines.
Original line number	Original line	Diff line number	Diff line
			The tool works as follows:

			Step 1: In the uploaded Document it searches for headings equal to:

			* `6\tVNFD TOSCA model`
			* `7\tNSD TOSCA model`
			* `8\tPNFD TOSCA model`,

			Step 2: For each of the section after the heading (and until the next heading is found), the tool searches for tables with the following properties:

			* It contains only one cell (i.e. one row and one column) and
			* the content matches the regular expression `^tosca\.[a-zA-Z\.:0-9\s]*$`, i.e. the text starts with `tosca.` and contains letters, numbers, `:` or white space.

			Step 3: The three sets of generated definitions are written to files named:

			* `generated_etsi_nfv_sol001_vnfd_types.yaml`
			* `generated_etsi_nfv_sol001_nsd_types.yaml`
			* `generated_etsi_nfv_sol001_pnfd_types.yaml`

			Step 4: The files are archived in a zip file named `tosca_defs.zip` which is served as a response.

src/templates/home.html

+4 −1

Changes for src/templates/home.html: 4 added lines, 1 removed line.
Original line number	Original line	Diff line number	Diff line
	@@ -29,7 +29,10 @@
	<p>		<p>
	The tools available on this page are provided with NO GUARANTEES and shall be used ONLY for validation of ETSI Specifications.		The tools available on this page are provided with NO GUARANTEES and shall be used ONLY for validation of ETSI Specifications.
	<br/>		<br/>
	For any inquiry, contact <a href="mailto:cti_support@etsi.org">ETSI CTI</a></p>		<br/>
			To report bugs, questions or feature request, please use the <a href="https://forge.etsi.org/bugzilla/enter_bug.cgi?product=Forge">the issue tracker at ETSI Forge</a> and select "TOSCA tools" as component.
			<br/>
			For any other inquiry, contact <a href="mailto:cti_support@etsi.org">ETSI CTI</a></p>
	</center>		</center>
	<div class="row">		<div class="row">
	<div class="col-sm" >		<div class="col-sm" >