Changes after review (#133)

* Windows Explorer mentioned
* Professional and Standard SDK mentioned
* SBOM file missing
* ASSERT is always used, no explanation for EXPECT was given.

Author: sahehb

mevislab.github.io/content/tutorials/dataobjects/curves.md

@@ -19,5 +19,3 @@ menu:
 Curves can be used in MeVisLab to print the results of a function as two-dimensional mathematical curves into a diagram.
 
 ![Curves in MeVisLab](images/tutorials/dataobjects/curves/Curves.png "Curves in MeVisLab")
-
-In the given example, only modules available in commercial **MeVisLab Professional SDK** have been used. The non-commercial **MeVisLab Standard SDK** provides more modules for curves.

mevislab.github.io/content/tutorials/dataobjects/surfaces/surfaceexample3.md

@@ -18,28 +18,32 @@ menu:
 {{< youtube "YDOEqCOmUFw">}}
 
 ## Introduction
-In these examples, we are showing two different possibilities to interact with a WEM:
-* Scale, rotate, and move a WEM in a scene
+In these examples, we are showing two different possibilities to interact with the visualization of the WEM:
+* Scale, rotate, and move a WEM's visualization in a scene
 * Modify a WEM in a scene
 
 ### Scale, Rotate, and Move a WEM in a Scene
-We are using a `SoTransformerDragger` module to apply transformations on a 3D WEM object via mouse interactions.
+We are using a `SoTransformerDragger` module to apply transformations to the visualization of a 3D WEM object via mouse interactions.
 
 Add a `SoCube` and a `SoBackground` module and connect both to a `SoExaminerViewer`. For a better understanding, you should also add a `SoCoordinateSystem` module and connect it to the viewer. Change the *User Transform Mode* to *User Transform Instead Of Input* and set *User Scale* to 2 for *x*, *y*, and *z*.
 
 ![Initial Network](images/tutorials/dataobjects/surfaces/WEMExample3_1.png "Initial Network")
 
-The `SoExaminerViewer` shows your cube and the world coordinate system. You can interact with the camera (rotate, zoom, and pan), the cube itself does not change and remains in the center of the coordinate system.
+The `SoExaminerViewer` shows your cube and the world coordinate system. You can interact with the camera (rotate, zoom, and pan), the visualization of the cube itself does not change. It remains in the center of the coordinate system.
 
 ![Initial Cube](images/tutorials/dataobjects/surfaces/WEMExample3_2.png "Initial Cube")
 
-Scaling, rotating, and translating the cube itself can be done by using the module `SoTransformerDragger`. Additionally, add a `SoTransform` module to your network. Add all modules except the `SoCoordinateSystem` to a `SoSeparator`, so that transformations are not applied to the coordinate system.
+Scaling, rotating, and translating the visualization of the cube can be done by using the module `SoTransformerDragger`.
+
+Additionally, add a `SoTransform` module to your network. Add all modules except the `SoCoordinateSystem` to a `SoSeparator`, so that transformations are not applied to the coordinate system.
 
 ![SoTransformerDragger and SoTransform](images/tutorials/dataobjects/surfaces/WEMExample3_3.png "SoTransformerDragger and SoTransform")
 
 Draw parameter connections from *Translation*, *Scale Factor*, and *Rotation* of the `SoTransformerDragger` to the same fields of the `SoTransform` module.
 
-Opening your SoExaminerViewer now allows you to use handles of the `SoTransformerDragger` to scale, rotate, and move the cube. You can additionally interact with the camera as already done before.
+Opening your SoExaminerViewer now allows you to use handles of the `SoTransformerDragger` to scale, rotate, and move the visualization of the cube. The cube itself remains unchanged in memory, a matrix for translation is applied to the original 3D object's visualization.
+
+You can additionally interact with the camera as already done before.
 
 {{<alert class="info" caption="Info">}}
 You need to change the active tool on the right side of the `SoExaminerViewer`. Use the *Pick Mode* for applying transformations and the *View Mode* for adjusting the camera.
@@ -52,6 +56,8 @@ You can also try the other `So*Dragger` modules in MeVisLab for variations of th
 {{< networkfile "examples/data_objects/surface_objects/example3/SurfaceExample3.mlab" >}}
 
 ### Interactively Modify WEMs
+The big difference to the previously described scenario, where we modified the visualization of the WEM, is that this example modifies the WEM itself.
+
 We are using the `WEMBulgeEditor` module to interactively modify the WEM via mouse interactions.
 
 Add the modules `WEMInitialize`, `SoWEMRenderer`, and `SoBackground` to your workspace and connect them to a `SoExaminerViewer` as seen below. Select model *Icosahedron* for the `WEMInitialize` module.

mevislab.github.io/content/tutorials/summary/summary2.md

@@ -45,7 +45,7 @@ Select your *.mlab* file from [Step 1](tutorials/summary/summary1/) and check *A
 
 ![Macro module wizard](images/tutorials/summary/Example2_4.png "Macro module wizard")
 
-You do not have to define fields of your macro module now, we will do that later. Click *Create*. The Windows Explorer opens showing the directory of your macro module. It should be the same directory you selected for your Package.
+You do not have to define fields of your macro module now, we will do that later. Click *Create*. The file explorer opens showing the directory of your macro module. It should be the same directory you selected for your Package.
 
 ### Directory Structure of a Macro Module
 The directory structure for a macro module is as follows:

mevislab.github.io/content/tutorials/summary/summary4.md

@@ -64,6 +64,14 @@ MATE automatically opens the Python file of your test case and it appears in MeV
 
 ### Write Test Functions in Python
 
+{{<alert class="info" caption="Info">}}
+In this example, we are using the **ASSERT*** functionalities, becase they throw an exception in case the expected value does not match the actual value. Your test execution stops in this case.
+
+You can also use **EXPECT*** functions. They return *true* or *false* and you can decide yourself ho your test continues.
+
+For details, see {{< docuLinks "/Resources/Documentation/Publish/SDK/TestCenterReference/namespaceTestSupport_1_1Macros.html" "TestCenter Reference" >}}
+{{</alert>}}
+
 #### Preparations
 Before writing a test case, we need some helper functions in Python, which we will use in our test cases. The first thing we need is a function to load images.
 

mevislab.github.io/content/tutorials/summary/summary5.md

@@ -77,7 +77,7 @@ The directory contains the following files (and some more maybe):
 * Installer (*.exe*) file
 * MeVisLab Install (*.mlinstall*) file
 * Shell (*.sh*) script
-* Third-party list (*.csv*)
+* Software Bill of Materials [SBOM] (*_sbom.json*)
 
 #### Batch File
 The batch file allows you to generate the executable again via a Windows batch file. You do not need the Project Wizard anymore now.
@@ -93,8 +93,8 @@ The file is initially generated by the Project Wizard. Having a valid file alrea
 #### Shell Skript
 The shell skript allows you to generate the executable again via a Unix shell like bash. You do not need the Project Wizard anymore now.
 
-#### Third-party File
-The third-party file contains all third-party software tools MeVisLab integrated into your installer from dependency analysis. The file contains the tool name, version, license, and general information about the tool.
+#### Software Bill of Materials [SBOM]
+The SBOM file includes a list of all third-party components, libraries, and dependencies included into your installer by MeVisLab. We use the standard format *CycloneDX* that allows to import this file to standard evaluation tools like [Dependency-Track](https://dependencytrack.org).
 
 ### Install Your Executable
 You can now execute the installer of your application.

mevislab.github.io/content/tutorials/testing/testingexample1.md

@@ -20,6 +20,20 @@ menu:
 ## Introduction
 In this example you will learn how to write an automated test for a simple network using the `DicomImport`, `MinMaxScan`, and `View3D` modules. Afterward, you will be able to write test cases for any other module and network yourself.
 
+MeVisLab provides two options to compare a test result with an expected result:
+#### ASSERT
+Multiple **ASSERT_*** functions to compare expected and actual result are available, for example **ASSERT_EQ()** (check if two values are equal) or **ASSERT_GT()** (check if value is greater than another value).
+
+In case an assertion fails, an exception is thrown and the test execution stops.
+#### EXPECT
+The same comparisons can be done by using **EXPECT_***. The functions return *true* or *false* and depending on the result you can decide how to proceed.
+
+Make sure to use the right comparison methods depending on your needs.
+
+{{<alert class="info" caption="Info">}}
+Additional information can be found in {{< docuLinks "/Resources/Documentation/Publish/SDK/TestCenterReference/namespaceTestSupport_1_1Macros.html" "TestCenter Reference" >}}
+{{</alert>}}
+
 ## Steps to Do
 
 ### Creating the Network to be Used for Testing
@@ -87,6 +101,8 @@ When *ready* is true, the test touches the *selectNextItem* trigger, so that the
 
 The value of our `DicomImport`s *progress* field is saved as the *currentValue* variable and compared to the *expectedValue* variable by calling *ASSERT_FLOAT_EQ(expectedValue,currentValue)* to determine if the DICOM import has finished (*currentValue* and *expectedValue* are equal) or not. 
 
+You can play around with the differences between **ASSERT_FLOAT_EQ()** and **EXPECT_FLOAT_EQ()** and le your test fail to see the differences.
+
 ### Run Your Test Case
 Open the TestCase Manager und run your test by selecting your test case and clicking on the *Play* button in the bottom right corner.
 
@@ -126,5 +142,7 @@ Create a global macro module and implement the following test objectives for bot
 * MeVisLab provides a TestCenter for writing automated tests in Python.
 * Tests can be executed on networks and macro modules.
 * The test results are shown in a ReportViewer.
+* **ASSERT*** functions throw an exception if the expected result differs from the actual result. The test run is aborted in such a case.
+* **EXPECT*** functions return *true* or *false*. You can decide yoursel how to continue your test.
 
 {{< networkfile "examples/testing/example1/TestCases.zip" >}}

mevislab.github.io/content/tutorials/testing/testingexample3.md

@@ -85,7 +85,11 @@ def testPatient(path, windowCenter):
 4. The final test functions *ASSERT_EQ* evaluate if the given values are equal.
 
 {{<alert class="info" caption="Info">}}
-You can use many other *ASSERT** possibilities, just try using the MATE autocompletion and play around with them.
+You can use many other **ASSERT*** possibilities, just try using the MATE autocompletion and play around with them. **ASSERT*** functions throw an exception in case expected and actul values do not fit. Your test execution stops in this case.
+
+You can also use **EXPECT*** functions. They return *true* or *false* and you can decide yourself ho your test continues.
+
+For details, see {{< docuLinks "/Resources/Documentation/Publish/SDK/TestCenterReference/namespaceTestSupport_1_1Macros.html" "TestCenter Reference" >}}
 {{</alert>}}
 
 ### Run Your Iterative Test