Skip to content
Snippets Groups Projects
Commit b158eb1f authored by Johannes Eder's avatar Johannes Eder
Browse files

removed description of features which have been removed

parent 84c9dae8
No related branches found
No related tags found
1 merge request!263947
......@@ -23,7 +23,7 @@ Examples of such checks are extremely diversified in AutoFOCUS:
<li>completeness of provided information (is a field not filled?)</li>
<li>type checking</li>
<li>syntactic error</li>
<li>...</li>
<li>causality checks</li>
</ul>
<h4><font color="#336699">Basics</font></h4>
......@@ -37,69 +37,26 @@ For some checks which are considered of less importance a yellow warning sign is
<img src="./pictures/warningConstraint.png">
<br><br>
<h4><font color="#336699">On-save checks vs Live checks <font color="#ff0000"><b>New in 2.11.0!</b></font></font></h4>
<h4><font color="#336699">On-save checks </font></h4>
Until 2.11, checks were done as follows:
Checks are done as follows:
<ul>
<li>checks were run on saving the project</li>
<li>all checks were re-run every time</li>
<li>checks are run when saving the project</li>
<li>all checks are re-run every time the project is saved</li>
</ul>
We call such checks "on-save checks".
On the other hand, "live checks" are a new experimental system which supports the following features:
<ul>
<li>checks are run as soon as a modification happens (no need to save)</li>
<li>only the checks which are relevant to the modified element are triggered</li>
</ul>
Due to their experimental status, <font color="#ff0000">all live checks are deactivated by default in 2.11.0.</font>.
To activate them, please refer to the next section.
<p>
As of 2.11, AutoFOCUS is in a transition period from the "on-save checks"
to the live checks, you will therefore encounter both kinds of checks, but, as a user,
there is usually no need to know which check is a live check or an on-save check.
On-save checks are permanently gathered in a summary called "Model Markers" which is normally on bottom left part of AF3.
<br>
You can filter out check results by type (failure, warning, information, etc.) by clicking the corresponding icon above the table.
However you cannot filter out results on a per-project basis: all errors of all projects are shown.
<p>
There are however subtle differences in terms of graphical interface:
<ul>
<li> live checks provide context-menu support, i.e., you can right-click a failing
element in the model navigator or in an editor in order to see immediately the reason for the error
as well as possible fixes if the context permits it:
<br><br>
<img src="./pictures/constraintContextMenu.png"></li>
<br><br>
<li> On-save checks do not provide context-menu support. However they are permanently gathered in a summary called "Model Markers":
<br><br>
<img src="./pictures/ModelMarkers1.png">
<br><br>
<br>
You can filter out check results by type (failure, warning, information, etc.) by clicking the corresponding icon above the table.
However you cannot filter out results on a per-project basis: all errors of all projects are shown.</li>
</ul>
In the long run, it is planned to replace entirely on-save checks by live checks.
Tables providing summaries of the issues should also be added for live checks.
<h4><font color="#336699">Check activation/deactivation</font></h4>
In case some checks are irrelevant for you or are simply annoying, you can deactivate them.
To do so, double-click on the root of your project:
<br><br>
<img src="./pictures/clickOnRoot.png">
<br><br>
This will open the check activation window which lists all the live checks and allows to activate or deactivate them simply by checking them:
<br><br>
<img src="./pictures/constraintActivation.png">
<br><br>
For instance, unchecking the "Ports values are within their bound" check in the example above immediately removes the error:
<br><br>
<img src="./pictures/noMoreError.png">
<br><br>
If you wish, you can create your own configurations gathering various checks.
In the future, this feature will be enhanced to provide proper process support.
</font>
</body>
</html>
\ No newline at end of file
org.fortiss.af3.rcp.help/html/pictures/constraintActivation.png

21.3 KiB

org.fortiss.af3.rcp.help/html/pictures/constraintContextMenu.png

10.2 KiB

org.fortiss.af3.rcp.help/html/pictures/noMoreError.png

3.28 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment