From 98ae4549c70978e631699740ad569aa3e4c902a3 Mon Sep 17 00:00:00 2001 From: Ludovic Apvrille <ludovic.apvrille@telecom-paristech.fr> Date: Tue, 12 Mar 2019 16:23:27 +0100 Subject: [PATCH] Adding extended help --- .../resources/help/communicationmapping.html | 25 +++++++++++++++++ .../resources/help/communicationmapping.md | 8 ++++++ src/main/resources/help/requirements.html | 27 +++++++++++++++++++ src/main/resources/help/requirements.md | 15 +++++++++++ 4 files changed, 75 insertions(+) create mode 100644 src/main/resources/help/communicationmapping.html create mode 100644 src/main/resources/help/communicationmapping.md create mode 100644 src/main/resources/help/requirements.html create mode 100644 src/main/resources/help/requirements.md diff --git a/src/main/resources/help/communicationmapping.html b/src/main/resources/help/communicationmapping.html new file mode 100644 index 0000000000..c28dc2c4ef --- /dev/null +++ b/src/main/resources/help/communicationmapping.html @@ -0,0 +1,25 @@ +<!DOCTYPE html> +<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang=""> +<head> + <meta charset="utf-8" /> + <meta name="generator" content="pandoc" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /> + <title>TTool help</title> + <style> + code{white-space: pre-wrap;} + span.smallcaps{font-variant: small-caps;} + span.underline{text-decoration: underline;} + div.column{display: inline-block; vertical-align: top; width: 50%;} + </style> + <!--[if lt IE 9]> + <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> + <![endif]--> +</head> +<body> +<h1 id="communication-mapping">Communication Mapping</h1> +<h2 id="definition">Definition</h2> +<p>Communication mapping consists in mapping data channel communications to buses and memories, thus building a physical communication path for functional-level channels.</p> +<h2 id="corner-cases">Corner cases</h2> +<p>If a channel is not mapped to a communication path, then TTool automatically generates a communication path among the possible ones. Similarly, if a communication channel is only partially mapped, TTool completes the communication path.</p> +</body> +</html> diff --git a/src/main/resources/help/communicationmapping.md b/src/main/resources/help/communicationmapping.md new file mode 100644 index 0000000000..08c7aff7c3 --- /dev/null +++ b/src/main/resources/help/communicationmapping.md @@ -0,0 +1,8 @@ +# Communication Mapping + +## Definition +Communication mapping consists in mapping data channel communications to buses and memories, thus building a physical communication path for functional-level channels. + +## Corner cases +If a channel is not mapped to a communication path, then TTool automatically generates a communication path among the possible ones. Similarly, if a communication channel is only partially mapped, TTool completes the communication path. + diff --git a/src/main/resources/help/requirements.html b/src/main/resources/help/requirements.html new file mode 100644 index 0000000000..90836be859 --- /dev/null +++ b/src/main/resources/help/requirements.html @@ -0,0 +1,27 @@ +<!DOCTYPE html> +<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang=""> +<head> + <meta charset="utf-8" /> + <meta name="generator" content="pandoc" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /> + <title>TTool help</title> + <style> + code{white-space: pre-wrap;} + span.smallcaps{font-variant: small-caps;} + span.underline{text-decoration: underline;} + div.column{display: inline-block; vertical-align: top; width: 50%;} + </style> + <!--[if lt IE 9]> + <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> + <![endif]--> +</head> +<body> +<h1 id="requirements">Requirements</h1> +<p>Requirements can be captured in SysML Requirement Diagrams.</p> +<h2 id="requirement-node">Requirement node</h2> +<h2 id="relations-between-requirements">Relations between requirements</h2> +<h3 id="composition">Composition</h3> +<h3 id="refine">Refine</h3> +<h3 id="derivereqt">DeriveReqt</h3> +</body> +</html> diff --git a/src/main/resources/help/requirements.md b/src/main/resources/help/requirements.md new file mode 100644 index 0000000000..ceb755c444 --- /dev/null +++ b/src/main/resources/help/requirements.md @@ -0,0 +1,15 @@ +# Requirements +Requirements can be captured in SysML Requirement Diagrams. + +## Requirement node + +## Relations between requirements + +### Composition + +### Refine + +### DeriveReqt + + + -- GitLab