Skip to content

Commit

Permalink
#120 Fix documentation (#123)
Browse files Browse the repository at this point in the history
Change-Id: I9c9f56aabfa4fbbe4319f6b46621a21b2f4fd2d7
Signed-off-by: Philippe DUL <philippe.dul@thalesgroup.com>
  • Loading branch information
pdulth committed Jan 22, 2021
1 parent 09a14e5 commit 1452a01
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,8 @@ <h2>Label and content configuration</h2>
</p>
<img src="../../images/requirements_configuration_wizard_menu.png" alt="Menu Item for Requirements Configuration Wizard" title="Menu Item for Requirements Configuration Wizard" />
<p>
By default, there are two predefined AQL expressions for each label and content of requirements.
The default length for displaying label and content of each requirement in diagrams are <b>80 characters</b>.
If the result is longer than the preferred length, it will be trimmed and followed by <b>"..."</b>.
Users have their own rights to define the AQL expressions and the lengths that fulfill their operational needs. However, if the AQL expression is invalid, in other words, could not be interpreted, the result will be displayed as <b>&lt;undefined&gt;</b>.
By default, there are two predefined AQL expressions for both label and content of requirements. The displayed texts are truncated and followed by <b>"..."</b> if they are longer than the defined lengths.
It is possible to change AQL expressions and the lengths to fulfill operational needs. However, if the AQL expression is invalid, in other words, could not be interpreted, the result will be displayed as <b>&lt;undefined&gt;</b>.
</p>
<img src="../../images/requirements_diagram_example_special_case.png" alt="Special case of displaying requirements in diagrams" title="Special case of displaying requirements in diagrams" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ <h1>Requirements Viewpoint for Capella</h1>
<h2>Contents</h2>
<ul>
<li><a href="1_gettingstarted/1_gettingstarted.html">Getting Started</a></li>
<li><a href="2_programmerguide/2_programmerguide.html">Programmer's Guide</a></li>
<li><a href="3_userguide/3_userguide.html">User's Guide</a></li>
<li><a href="4_knownissues/4_limitations_knownissues.html">Limitations / Known Issues</a></li>
<li><a href="2_programmerguide/2_programmerguide.html">Programmer's Guide</a></li>
</ul>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@
<topic href="html/1_gettingstarted/1_gettingstarted.html" label="Getting Started">
<anchor id="gettingstarted"/>
</topic>
<topic href="html/2_programmerguide/2_programmerguide.html" label="Programmer's Guide">
<anchor id="programmerguide"/>
</topic>
<topic href="html/3_userguide/3_userguide.html" label="User's Guide">
<anchor id="userguide"/>
</topic>
<topic href="html/4_knownissues/4_limitations_knownissues.html" label="Limitations / Known Issues">
<anchor id="knownissues"/>
</topic>
<topic href="html/2_programmerguide/2_programmerguide.html" label="Programmer's Guide">
<anchor id="programmerguide"/>
</topic>
<anchor id="requirementsviewpointforcapella"/>
</toc>

0 comments on commit 1452a01

Please sign in to comment.