Merge branch 'main' into MLAB-6185

Author: sahehb

README.md

@@ -1,16 +1,14 @@
-# MeVisLab Examples
-
-This is the repository for the MeVisLab Examples GitHub pages.
-
-Please follow [Examples Pages](https://mevislab.github.io/examples/)
+# MeVisLab Tutorials and Examples
 
+This is the repository for the [MeVisLab Tutorials and Examples GitHub pages](https://mevislab.github.io/examples/).
 
 ## Configuration
 
 ### Local Deployment
-* Checkout code
+* Checkout the code
 * Install _extended_ hugo from the [Hugo Website](https://gohugo.io/)
 * Install npm e.g. from [npmjs Website](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
-* Change to mevislab.github.io folder and run `npm install`
-* Stay in this folder and run `hugo server -d public --baseURL //localhost/examples/` (The `/examples/` path is locally not absolute necessary but it helps to find problems that might appear on the production website.)
-* Open in your favorite browser the given URL
+* Change to the *mevislab.github.io* folder and run `npm install`
+* Stay in this folder and run `hugo server -d public --baseURL //localhost/examples/` (the `/examples/` path is not needed, 
+  but it helps to find problems that might appear on the published website)
+* Open the given URL in your favorite browser 

mevislab.github.io/content/about/about.md

@@ -6,7 +6,7 @@ status: "OK"
 tags: ["Symbols", "Glossary", "Overview"]
 ---
 ## Symbols
-We embedded three symbols, referencing additional info, tasks and warnings:
+We embedded three symbols, referencing additional info, tasks, and warnings:
 {{<alert class="info" caption="Info">}}
 Provides additional links or info on the current topic.
 {{</alert>}}
@@ -21,6 +21,6 @@ Hints common mistakes or steps you should consider beforehand.
 Keyboard shortcuts are incorporated like this:  {{< keyboard "CTRL" "ALT" "2" >}}.
 
 ## Networks
-The networks shown and used in the tutorials can be found in the [Examples](/examples) section of this page. 
+The networks shown and used in the tutorials can be found in the [Examples](examples) section of this page. 
 They are usually embedded like this:
 {{< networkfile "examples/data_objects/contours/example1/ContourExample1.mlab" >}}

mevislab.github.io/content/contact.md

@@ -3,12 +3,12 @@ title: "Contact"
 date: 2022-06-15T08:54:53+02:00
 draft: false
 ---
-### Feedback is valuable and always appreciated! 
+### Feedback is Valuable and Always Appreciated! 
 
 #### MeVisLab Licensing
 Having any questions on MeVisLab Licensing? Please contact the [MeVisLab Sales Team](mailto://sales@mevislab.de)
 
-#### MeVisLab forum
+#### MeVisLab Forum
 Searching for a forum to ask your specific MeVisLab questions? Having trouble with functionalities? Ask [here](https://forum.mevislab.de)! Someone else might know the answer. If not - one of our developers will help you out!
 
 #### General Questions

mevislab.github.io/content/examples/basic_mechanisms/contour_filter/index.md

@@ -9,11 +9,11 @@ This example shows how to create a contour filter.
 
 # Summary
 Images are loaded via `ImageLoad` module and visualized unchanged in a `View2D` module *View2D1*.
-Additionally the images are modified by a local macro module `Filter` and shown in another `View2D` viewer *View2D*.
+Additionally, the images are modified by a local macro module `Filter` and shown in another `View2D` viewer *View2D*.
 
 In order to display the same slice (unchanged and changed), the module `SyncFloat` is used to synchronize the field value *startSlice* in both viewers. The `SyncFloat` module duplicates the value *Float1* to the field *Float2*.
 
-![Screenshot](/examples/basic_mechanisms/contour_filter/image.png)
+![Screenshot](examples/basic_mechanisms/contour_filter/image.png)
 
 # Download
-You can download the example network [here](/examples/basic_mechanisms/contour_filter/ContourFilter.zip)
+You can download the example network [here](examples/basic_mechanisms/contour_filter/ContourFilter.zip)

mevislab.github.io/content/examples/basic_mechanisms/macro_modules_and_module_interaction/example1/index.md

@@ -4,19 +4,19 @@ title: "Panel for the contour filter"
 category: "basic_mechanisms"
 ---
 
-# Example 1: Panel for the contour filter
+# Example 1: Panel for the Contour Filter
 This example contains a whole package structure. Inside you can find the example contour filter for which a panel was created.
 
 ## Summary
-A new macro module `Filter` has been created. Initially macro modules do not provide an own panel containing user interface elements such as buttons. The *Automatic Panel* is shown on double-clicking the module providing the name of the module.
+A new macro module `Filter` has been created. Initially, macro modules do not provide an own panel containing user interface elements such as buttons. The *Automatic Panel* is shown on double-clicking the module providing the name of the module.
 
-In this example we update the *\*.script* file of the `Filter` module to display the kernel selection field of the `Convolution` module within its network. 
+In this example we update the *.script* file of the `Filter` module to display the kernel selection field of the `Convolution` module within its network. 
 
 {{<alert class="info" caption="Info">}}
 Changes applied to fields in the macro module's panel are applied to their internal network as well.
 {{</alert>}}
 
-![Screenshot](/examples/basic_mechanisms/macro_modules_and_module_interaction/example1/image.png)
+![Screenshot](examples/basic_mechanisms/macro_modules_and_module_interaction/example1/image.png)
 
 # Download
-You can download the example network [here](/examples/basic_mechanisms/macro_modules_and_module_interaction/example1/FilterExample.zip)
+You can download the example network [here](examples/basic_mechanisms/macro_modules_and_module_interaction/example1/FilterExample.zip)

mevislab.github.io/content/examples/basic_mechanisms/macro_modules_and_module_interaction/example2/index.md

@@ -4,17 +4,17 @@ title: "Python scripting"
 category: "basic_mechanisms"
 ---
 
-# Example 2: Python scripting
+# Example 2: Python Scripting
 This example shows how to create module interactions via Python scripting.
 
 ## Summary
 A new macro module `IsoCSOs` is created providing two viewers in its internal network, `View2D` and `SoExaminerViewer`. Both viewers are included in the panel of the module.
 
-To showcase how Python functions can be implemented in MeVisLab and called from within a module, additional buttons to browse directories and create contours via the `CSOIsoGenerator` are added. Lastly a field listener is implemented reacting to field changes by colorizing contours when the user hovers over them with the mouse. 
+To showcase how Python functions can be implemented in MeVisLab and called from within a module, additional buttons to browse directories and create contours via the `CSOIsoGenerator` are added. Lastly, a field listener is implemented reacting to field changes by colorizing contours when the user hovers over them with the mouse. 
 
-![Screenshot](/examples/basic_mechanisms/macro_modules_and_module_interaction/example2/image2.png)
+![Screenshot](examples/basic_mechanisms/macro_modules_and_module_interaction/example2/image2.png)
 
-![Screenshot](/examples/basic_mechanisms/macro_modules_and_module_interaction/example2/image.png)
+![Screenshot](examples/basic_mechanisms/macro_modules_and_module_interaction/example2/image.png)
 
 # Download
-The files need to be added to a package. You can download the example network [here](/examples/basic_mechanisms/macro_modules_and_module_interaction/example2/ScriptingExample2.zip)
+The files need to be added to a package. You can download the example network [here](examples/basic_mechanisms/macro_modules_and_module_interaction/example2/ScriptingExample2.zip)

mevislab.github.io/content/examples/basic_mechanisms/viewer_application/index.md

@@ -4,10 +4,10 @@ title: "Creating a simple application"
 category: "basic_mechanisms"
 ---
 
-# Example 3: Creating a simple application
+# Example 3: Creating a Simple Application
 In this example, you will learn how to create a simple prototype application in MeVisLab including a user interface (UI) with 2D and 3D viewers.
 
-![Screenshot](/examples/basic_mechanisms/viewer_application/image.png)
+![Screenshot](examples/basic_mechanisms/viewer_application/image.png)
 
 # Download
-You can download the example network [here](/examples/basic_mechanisms/viewer_application/viewerexample.mlab)
+You can download the example network [here](examples/basic_mechanisms/viewer_application/viewerexample.mlab)

mevislab.github.io/content/examples/data_objects/contours/example1/index.md

@@ -4,12 +4,12 @@ title: "Creation of Contours"
 category: "data_objects"
 ---
 
-# Contour Example 1: Creation of contours
-Contours are stored as Contour Segmented Objects (CSOs) in MeVisLab.
+# Contour Example 1: Creation of Contours
+Contours are stored as Contour Segmentation Objects (CSOs) in MeVisLab.
 This example highlights ways of creating CSOs using modules of the `SoCSOEditor` group.
 
 {{<alert class="info" caption="Info">}}
-You may want to look at the glossary entry on [*CSOs*](/glossary/#contour-segmented-objects).
+You may want to look at the glossary entry on [*CSOs*](glossary/#contour-segmented-objects).
 {{</alert>}}
 
 The `SoCSOEditor` module group contains several modules, some of which are listed right below:
@@ -27,17 +27,17 @@ The `SoCSOEditor` module group contains several modules, some of which are liste
 * `SoCSOLiveWireEditor`
 
 {{<alert class="info" caption="Info">}}
-Whenever Contour Segmented Objects are created, they are temporarily stored by and can be managed with the `CSOManager`. 
+Whenever Contour Segmentation Objects are created, they are temporarily stored by and can be managed with the `CSOManager`. 
 {{</alert>}}
 
 In this example, contours are created and colors and styles of these CSOs are customized by using the `SoCSOVisualizationSettings` module.
 
-![Screenshot](/examples/data_objects/contours/example1/image.png)
+![Screenshot](examples/data_objects/contours/example1/image.png)
 
 ## Summary
-+ Contours are stored as their own abstract data type called Contour Segmented Objects (often abbreviated to *CSO*).
-+ The `SoEditor` module group contains several useful modules to create, interact with or modify CSOs.
++ Contours are stored as their own abstract data type called Contour Segmentation Objects (often abbreviated to *CSO*).
++ The `SoCSO\*Editor` module group contains several useful modules to create, interact with or modify CSOs.
 + Created CSOs are temporarily stored and can be managed using the `CSOManager`.
 
 # Download
-The example network can be downloaded [here](/examples/data_objects/contours/example1/ContourExample1.mlab)
+The example network can be downloaded [here](examples/data_objects/contours/example1/ContourExample1.mlab)

mevislab.github.io/content/examples/data_objects/contours/example2/index.md

@@ -4,15 +4,15 @@ title: "Contour interpolation"
 category: "data_objects"
 ---
 
-# Contour Example 2: Contour interpolation
+# Contour Example 2: Contour Interpolation
 This example shows how to interpolate CSOs across slices.
 
 ## Summary
-In this example, semi-automatic countours are created using the `SoCSOLiveWireEditor` module and their depiction is modified using the `SoCSOVisualizationSettings` module.
+In this example, semi-automatic countours are created using the `SoCSOLiveWireEditor` module and their visualization is modified using the `SoCSOVisualizationSettings` module.
 
 Additional contours between the manually created ones are generated by the `CSOSliceInterpolator` and added to the `CSOManager`. Different groups of contours are created for the left and right lobe of the lung and colored respectively.
 
-![Screenshot](/examples/data_objects/contours/example2/image.png)
+![Screenshot](examples/data_objects/contours/example2/image.png)
 
 # Download
-You can download the example network [here](/examples/data_objects/contours/example2/ContourExample2.mlab)
+You can download the example network [here](examples/data_objects/contours/example2/ContourExample2.mlab)

mevislab.github.io/content/examples/data_objects/contours/example3/index.md

@@ -4,17 +4,17 @@ title: "2D and 3D visualization of contours"
 category: "data_objects"
 ---
 
-# Contour Example 3: 2D and 3D visualization of contours
+# Contour Example 3: 2D and 3D Visualization of Contours
 This example shows how to display CSOs in 2D as an overlay and additionally how the CSOs are displayed in 3D.
 
 ## Summary
-Images are loaded by using a `LocalImage` module and displayed in a 2D viewer. A `SoCSOLiveWireEditor` is added to draw contours on the images. The `CSOSliceInterpolator` generates additional contours between the manual CSOs by using linear interpolation.
+Images are loaded by using a `LocalImage` module and displayed in a 2D viewer. A `SoCSOLiveWireEditor` is added to draw contours on the images. The `CSOSliceInterpolator` generates additional contours between the manually created CSOs by using linear interpolation.
 
-The module `VoxelizeCSO` is used to create a three-dimensional voxel mask of the contours which can be used as an overlay on the images in a `View2D` panel. The `SoView2DOverlay` module defines the color and opacity of the overlay.
+The module `VoxelizeCSO` is used to create a three-dimensional voxel mask of the contours that can be used as an overlay on the images in a `View2D` panel. The `SoView2DOverlay` module defines the color and opacity of the overlay.
 
-Lastly the panel of the `View3D` module is used to visualize the voxel mask in 3D.
+Lastly, the panel of the `View3D` module is used to visualize the voxel mask in 3D.
 
-![Screenshot](/examples/data_objects/contours/example3/image.png)
+![Screenshot](examples/data_objects/contours/example3/image.png)
 
 # Download
-You can download the example network [here](/examples/data_objects/contours/example3/ContourExample3.mlab)
+You can download the example network [here](examples/data_objects/contours/example3/ContourExample3.mlab)