Merge pull request #32 from ZEISS/20240814-fix-links

20240814 fix links

.github/workflows/linkcheck.yml

@@ -1,6 +1,5 @@
 name: Links
 on:
-  repository_dispatch:
   workflow_dispatch:
 jobs:
   linkChecker:
@@ -11,10 +10,10 @@ jobs:
         id: lychee
         uses: lycheeverse/lychee-action@v1
 
-#      - name: Create Issue From File
-#        if: env.lychee_exit_code != 0
-#        uses: peter-evans/create-issue-from-file@v4
-#        with:
-#          title: Link Checker Report
-#         content-filepath: ./lychee/out.md
-#          labels: report, automated issue
+      - name: Create Issue From File
+        if: env.lychee_exit_code != 0
+        uses: peter-evans/create-issue-from-file@v4
+        with:
+          title: Link Checker Report
+          content-filepath: ./lychee/out.md
+          labels: report, automated issue

.github/workflows/update_overview.yaml

@@ -36,7 +36,6 @@ jobs:
           python-version: '3.10'
       - name: Check out the repository
         uses: actions/checkout@v4
-
       - name: Git config
         run: |
           git config --global user.email "action@github.com"

AppExamples/dialog_widgets/DropdownWidget/doc/Documentation.md

@@ -18,4 +18,4 @@ DIALOG.list.items = ['yes', 'we', 'can']
 
 ## Related
 
-* How-to: [User-defined Dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.md)
+* How-to: [User-defined Dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html)

AppExamples/dialog_widgets/ExplorerSelectedElementsInDialog/doc/Documentation.md

@@ -31,6 +31,6 @@ gom.script.explorer.apply_selection (selection=example_selection)
 
 ## Related
 
-* How-to: [Python API Introduction](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/python_api_introduction.md)
-* How-to: [User-defined Dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.md)
-* How-to: [Selecting elements in scripts](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/selecting_elements.md)
+* How-to: [Python API Introduction](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/python_api_introduction.html)
+* How-to: [User-defined Dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html)
+* How-to: [Selecting elements in scripts](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/selecting_elements.html)

AppExamples/dialog_widgets/UnitDialogEventHandler/doc/Documentation.md

@@ -33,4 +33,4 @@ This usage of the `DIALOG.handler` function mimics the user-interaction of chang
 
 ## Related
 
-* How-to: [User-defined Dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.md)
+* How-to: [User-defined Dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html)

AppExamples/dialog_widgets/WidgetVisibility/doc/Documentation.md

@@ -21,4 +21,4 @@ def dialog_event_handler (widget):
 
 ## Related
 
-* How-to: [User-defined Dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.md)
+* How-to: [User-defined Dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html)

AppExamples/misc/DialogReopenExample/doc/Documentation.md

@@ -40,4 +40,4 @@ def dialog_event_handler (widget):
 
 ## Related
 
-* How-to: [User-defined Dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.md)
+* How-to: [User-defined Dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html)

AppExamples/misc/SQLExample/doc/Documentation.md

@@ -269,4 +269,4 @@ result, err = execute_query(CONNECTION, query, values)
 
 ## Related
 
-* How-to: [User-defined Dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.md)
+* How-to: [User-defined Dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html)

AppExamples/misc/ServiceExample/doc/Documentation.md

@@ -93,5 +93,5 @@ srv.start()
 
 ## Related
 
-* How-to: [Using services](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/using_services/using_services.md)
+* How-to: [Using services](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/using_services/using_services.html)
 * [gom.api.services](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/python_api.html#gom-api-services)

AppExamples/misc/ServiceExample/doc/README.md

@@ -1,9 +1,9 @@
 ## ServiceExample
 
-This App is part of the [ZEISS INSPECT Python API App Examples](https://github.com/ZEISS/zeiss-inspect-app-examples/tree/dev/AppExamples).
+This App is part of the [ZEISS INSPECT Python API App Examples](https://github.com/ZEISS/zeiss-inspect-app-examples/tree/main/AppExamples).
 
 See [App documentation](Documentation.md) for details.
 
 You can [download this App](https://software-store.zeiss.com/products/apps/ServiceExample) from the [ZEISS Quality Software Store](https://software-store.zeiss.com).
 
-The ZEISS INSPECT App develomment documentation can be found on [ZEISS IQS GitHub](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/index.html).
+The ZEISS INSPECT App develomment documentation can be found on [ZEISS IQS GitHub](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/index.html).

AppExamples/misc/TemplateUnittestCoverage/doc/Documentation.md

@@ -24,4 +24,4 @@ Based on `unitest` (https://docs.python.org/3/library/unittest.html) and `Covera
 
 ## See also
 
-See https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/testing_addons/testing_addons.html for more information.
+See https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/testing_apps/testing_apps.html for more information.

AppExamples/script_icons/ScriptIcon/doc/Documentation.md

@@ -24,4 +24,4 @@ If you use this approach, and follow our [icon guidelines](https://zeissiqs.gith
 
 ## Related
 
-* How-to: [Adding workspaces to packages](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/adding_workspaces_to_apps/adding_workspaces_to_apps.md)
+* How-to: [Adding workspaces to packages](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/adding_workspaces_to_apps/adding_workspaces_to_apps.html)

AppExamples/script_resources/ScriptResources/doc/Documentation.md

@@ -33,5 +33,5 @@ For details on how to read and write resource data, see the related documentatio
 
 ## Related
 
-* [How to: Using script resources](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/using_script_resources.md)
-* [`gom.Resource` API Definition](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/resource_api.md)
+* [How to: Using script resources](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/using_script_resources.html)
+* [`gom.Resource` API Definition](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/resource_api.html)

AppExamples/scripted_actuals/ScriptedActualCircle/doc/Documentation.md

@@ -5,7 +5,7 @@
 This is an example for a scripted 'circle' element.
 
 > [!NOTE]
-> Please see [ScriptedActualPoint](https://github.com/ZEISS/zeiss-inspect-app-examples/blob/dev/AppExamples/scripted_actuals/ScriptedActualPoint/doc/Documentation.md) for a complete scripted elements example with detailed description.
+> Please see [ScriptedActualPoint](https://github.com/ZEISS/zeiss-inspect-app-examples/blob/main/AppExamples/scripted_actuals/ScriptedActualPoint/doc/Documentation.md) for a complete scripted elements example with detailed description.
 
 ## Source code excerpt
 
@@ -35,5 +35,5 @@ def calculation(context, params):
 
 ## Related
 
-* [Scripted actuals - Circle](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.md#circle)
-* [How-to: User-defined dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.md)
+* [Scripted actuals - Circle](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#circle)
+* [How-to: User-defined dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html)

AppExamples/scripted_actuals/ScriptedActualCircle/doc/README.md

@@ -2,6 +2,8 @@
 
 This App is part of the [ZEISS INSPECT Python API Examples](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_examples/index.html).
 
-See [ScriptedActualCircle](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_examples/scripted_actuals/scripted_actual_circle.html) on the [ZEISS IQS GitHub](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/index.html) for a detailed description.
+See [App documentation](Documentation.md) for details.
 
-You can [download this App](https://software-store.zeiss.com/products/apps/ScriptedActualCircle) from the [ZEISS Quality Software Store](https://software-store.zeiss.com).
+You can [download this App](https://software-store.zeiss.com/products/apps/ScriptedActualCircle) from the [ZEISS Quality Software Store](https://software-store.zeiss.com).
+
+The ZEISS INSPECT App develomment documentation can be found on [ZEISS IQS GitHub](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/index.html)

AppExamples/scripted_actuals/ScriptedActualCone/doc/Documentation.md

@@ -10,7 +10,7 @@ This is an example for a scripted 'cone' element.
 If you specify `radius1` > `radius2` in the creation parameters, [`point1`; `radius1`] and [`point2`; `radius2`] are swapped automatically.
 
 > [!NOTE]
-> Please see [ScriptedActualPoint](https://github.com/ZEISS/zeiss-inspect-app-examples/blob/dev/AppExamples/scripted_actuals/ScriptedActualPoint/doc/Documentation.md) for a complete scripted elements example with detailed description.
+> Please see [ScriptedActualPoint](https://github.com/ZEISS/zeiss-inspect-app-examples/blob/main/AppExamples/scripted_actuals/ScriptedActualPoint/doc/Documentation.md) for a complete scripted elements example with detailed description.
 
 ## Source code excerpt
 
@@ -40,5 +40,5 @@ def calculation(context, params):
 
 ## Related
 
-* [Scripted actuals - Cone](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.md#cone)
-* [How-to: User-defined dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.md)
+* [Scripted actuals - Cone](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#cone)
+* [How-to: User-defined dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html)

AppExamples/scripted_actuals/ScriptedActualCone/doc/README.md

@@ -2,6 +2,8 @@
 
 This App is part of the [ZEISS INSPECT Python API Examples](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_examples/index.html).
 
-See [ScriptedActualCircle](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_examples/scripted_actuals/scripted_actual_cone.html) on the [ZEISS IQS GitHub](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/index.html) for a detailed description.
+See [App documentation](Documentation.md) for details.
 
-You can [download this App](https://software-store.zeiss.com/products/apps/ScriptedActualCone) from the [ZEISS Quality Software Store](https://software-store.zeiss.com).
+You can [download this App](https://software-store.zeiss.com/products/apps/ScriptedActualCone) from the [ZEISS Quality Software Store](https://software-store.zeiss.com).
+
+The ZEISS INSPECT App develomment documentation can be found on [ZEISS IQS GitHub](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/index.html)

AppExamples/scripted_actuals/ScriptedActualCurve/doc/Documentation.md

@@ -5,7 +5,7 @@
 This is an example for a scripted 'curve' element. A parametric function is used to create a 3-dimensional curve - a helix - with a fixed number of points. `np.arange()` is used to iterate from `t_min` to `t_max` with a non-integer step size.
 
 > [!NOTE]
-> Please see [ScriptedActualPoint](https://github.com/ZEISS/zeiss-inspect-app-examples/blob/dev/AppExamples/scripted_actuals/ScriptedActualPoint/doc/Documentation.md) for a complete scripted elements example with detailed description.
+> Please see [ScriptedActualPoint](https://github.com/ZEISS/zeiss-inspect-app-examples/blob/main/AppExamples/scripted_actuals/ScriptedActualPoint/doc/Documentation.md) for a complete scripted elements example with detailed description.
 
 ## Source code excerpt
 
@@ -43,5 +43,5 @@ def calculation(context, params):
 
 ## Related
 
-* [Scripted actuals - Curve](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.md#curve)
-* [How-to: User-defined dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.md)
+* [Scripted actuals - Curve](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#curve)
+* [How-to: User-defined dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html)

AppExamples/scripted_actuals/ScriptedActualCurve/doc/README.md

@@ -2,6 +2,8 @@
 
 This App is part of the [ZEISS INSPECT Python API Examples](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_examples/index.html).
 
-See [ScriptedActualCurve](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_examples/scripted_actuals/scripted_actual_curve.html) on the [ZEISS IQS GitHub](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/index.html) for a detailed description.
+See [App documentation](Documentation.md) for details.
 
-You can [download this App](https://software-store.zeiss.com/products/apps/ScriptedActualCurve) from the [ZEISS Quality Software Store](https://software-store.zeiss.com).
+You can [download this App](https://software-store.zeiss.com/products/apps/ScriptedActualCurve) from the [ZEISS Quality Software Store](https://software-store.zeiss.com).
+
+The ZEISS INSPECT App develomment documentation can be found on [ZEISS IQS GitHub](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/index.html)

AppExamples/scripted_actuals/ScriptedActualCylinder/doc/Documentation.md

@@ -5,7 +5,7 @@
 This is an example for a scripted 'cylinder' element.
 
 > [!NOTE]
-> Please see [ScriptedActualPoint](https://github.com/ZEISS/zeiss-inspect-app-examples/blob/dev/AppExamples/scripted_actuals/ScriptedActualPoint/doc/Documentation.md) for a complete scripted elements example with detailed description.
+> Please see [ScriptedActualPoint](https://github.com/ZEISS/zeiss-inspect-app-examples/blob/main/AppExamples/scripted_actuals/ScriptedActualPoint/doc/Documentation.md) for a complete scripted elements example with detailed description.
 
 ## Source code excerpt
 
@@ -37,5 +37,5 @@ def calculation(context, params):
 
 ## Related
 
-* [Scripted actuals - Cylinder](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.md#cylinder)
-* [How-to: User-defined dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.md)
+* [Scripted actuals - Cylinder](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#cylinder)
+* [How-to: User-defined dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html)

AppExamples/scripted_actuals/ScriptedActualCylinder/doc/README.md

@@ -2,6 +2,8 @@
 
 This App is part of the [ZEISS INSPECT Python API Examples](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_examples/index.html).
 
-See [ScriptedActualCylinder](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_examples/scripted_actuals/scripted_actual_cylinder.html) on the [ZEISS IQS GitHub](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/index.html) for a detailed description.
+See [App documentation](Documentation.md) for details.
 
-You can [download this App](https://software-store.zeiss.com/products/apps/ScriptedActualCylinder) from the [ZEISS Quality Software Store](https://software-store.zeiss.com).
+You can [download this App](https://software-store.zeiss.com/products/apps/ScriptedActualCylinder) from the [ZEISS Quality Software Store](https://software-store.zeiss.com).
+
+The ZEISS INSPECT App develomment documentation can be found on [ZEISS IQS GitHub](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/index.html)

AppExamples/scripted_actuals/ScriptedActualDistance/doc/Documentation.md

@@ -5,7 +5,7 @@
 This is an example for a scripted 'distance' element.
 
 > [!NOTE]
-> Please see [ScriptedActualPoint](https://github.com/ZEISS/zeiss-inspect-app-examples/blob/dev/AppExamples/scripted_actuals/ScriptedActualPoint/doc/Documentation.md) for a complete scripted elements example with detailed description.
+> Please see [ScriptedActualPoint](https://github.com/ZEISS/zeiss-inspect-app-examples/blob/main/AppExamples/scripted_actuals/ScriptedActualPoint/doc/Documentation.md) for a complete scripted elements example with detailed description.
 
 ## Source code excerpt
 
@@ -35,5 +35,5 @@ def calculation(context, params):
 
 ## Related
 
-* [Scripted actuals - Distance](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.md#distance)
-* [How-to: User-defined dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.md)
+* [Scripted actuals - Distance](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#distance)
+* [How-to: User-defined dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html)

AppExamples/scripted_actuals/ScriptedActualDistance/doc/README.md

@@ -1,7 +1,9 @@
-## ScriptedActualPoint
+## ScriptedActualDistance
 
 This App is part of the [ZEISS INSPECT Python API Examples](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_examples/index.html).
 
-See [offset_point_simple](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_examples/scripted_actuals/offset_point_simple.html) and [offset_point_v2](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_examples/scripted_actuals/offset_point_v2.html) on the [ZEISS IQS GitHub](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/index.html) for a detailed description.
+See [App documentation](Documentation.md) for details.
 
-You can [download this App](https://software-store.zeiss.com/products/apps/ScriptedActualPoint) from the [ZEISS Quality Software Store](https://software-store.zeiss.com).
+You can [download this App](https://software-store.zeiss.com/products/apps/ScriptedActualPoint) from the [ZEISS Quality Software Store](https://software-store.zeiss.com).
+
+The ZEISS INSPECT App develomment documentation can be found on [ZEISS IQS GitHub](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/index.html)

AppExamples/scripted_actuals/ScriptedActualPoint/doc/Documentation.md

@@ -125,4 +125,4 @@ Output:
 ## Related
 
 * [Scripted actuals - Point](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#point)
-* [How-to: User-defined dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.md)
+* [How-to: User-defined dialogs](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html)