Added tags, references and example-projects

ZEISS · Jul 11, 2024 · 7276661 · 7276661
1 parent 29b563b
commit 7276661
Show file tree

Hide file tree

Showing 26 changed files with 109 additions and 8 deletions.
diff --git a/AppExamples/dialog_widgets/DropdownWidget/metainfo.json b/AppExamples/dialog_widgets/DropdownWidget/metainfo.json
@@ -6,6 +6,9 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html#selection-list-widget"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
     "tags": [],

diff --git a/AppExamples/dialog_widgets/ExplorerSelectedElementsInDialog/metainfo.json b/AppExamples/dialog_widgets/ExplorerSelectedElementsInDialog/metainfo.json
@@ -2,11 +2,15 @@
     "author": "Carl Zeiss GOM Metrology GmbH",
     "description": "This example shows how to get a list of elements selected in the element explorer and use it in a script dialog. ",
     "environment": "ZeissInspectExampleProjects",
+    "example-projects": ["zeiss_part_test_project"],
     "labels": [],
     "licensing": {
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html#selection-element-widget"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
     "tags": [],

diff --git a/AppExamples/dialog_widgets/UnitDialogEventHandler/metainfo.json b/AppExamples/dialog_widgets/UnitDialogEventHandler/metainfo.json
@@ -6,6 +6,9 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html#unit-widget"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
     "tags": [],

diff --git a/AppExamples/dialog_widgets/WidgetVisibility/metainfo.json b/AppExamples/dialog_widgets/WidgetVisibility/metainfo.json
@@ -6,6 +6,9 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
     "tags": [],

diff --git a/AppExamples/misc/CSVExample/metainfo.json b/AppExamples/misc/CSVExample/metainfo.json
@@ -1,6 +1,7 @@
 {
     "author": "Carl Zeiss GOM Metrology GmbH",
     "description": "This example demonstrates how to read and write CSV files (comma separated values) from an App.",
+    "example-projects": ["zeiss_part_test_project"],
     "labels": [],
     "licensing": {
         "licenses": [],

diff --git a/AppExamples/misc/DialogReopenExample/metainfo.json b/AppExamples/misc/DialogReopenExample/metainfo.json
@@ -6,6 +6,9 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", " https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html#executing-dialogs"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
     "tags": [],

diff --git a/AppExamples/misc/PointPixelTransformations/metainfo.json b/AppExamples/misc/PointPixelTransformations/metainfo.json
@@ -2,11 +2,15 @@
     "author": "Carl Zeiss GOM Metrology GmbH",
     "description": "This example demonstrates how to find the 2D pixel coordinates of a 3D point coordinate and vice versa.",
     "environment": "ZeissInspectExampleProjects",
+    "example-projects": ["zeiss_part_test_measurement"],
     "labels": [],
     "licensing": {
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/python_api.html#gom-api-imaging"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
     "tags": [],

diff --git a/AppExamples/script_resources/ScriptResources/metainfo.json b/AppExamples/script_resources/ScriptResources/metainfo.json
@@ -6,6 +6,10 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/using_script_resources.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/resource_api.html"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
     "tags": [],

diff --git a/AppExamples/scripted_actuals/ScriptedActualCircle/metainfo.json b/AppExamples/scripted_actuals/ScriptedActualCircle/metainfo.json
@@ -6,6 +6,10 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#circle"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
     "tags": [],

diff --git a/AppExamples/scripted_actuals/ScriptedActualCone/metainfo.json b/AppExamples/scripted_actuals/ScriptedActualCone/metainfo.json
@@ -6,6 +6,10 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#cone"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
     "tags": [],

diff --git a/AppExamples/scripted_actuals/ScriptedActualCurve/metainfo.json b/AppExamples/scripted_actuals/ScriptedActualCurve/metainfo.json
@@ -6,6 +6,10 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#curve"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
     "tags": [],

diff --git a/AppExamples/scripted_actuals/ScriptedActualCylinder/metainfo.json b/AppExamples/scripted_actuals/ScriptedActualCylinder/metainfo.json
@@ -6,6 +6,10 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#cylinder"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
     "tags": [],

diff --git a/AppExamples/scripted_actuals/ScriptedActualDistance/metainfo.json b/AppExamples/scripted_actuals/ScriptedActualDistance/metainfo.json
@@ -6,6 +6,10 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#distance"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
     "tags": [],

diff --git a/AppExamples/scripted_actuals/ScriptedActualPoint/metainfo.json b/AppExamples/scripted_actuals/ScriptedActualPoint/metainfo.json
@@ -7,6 +7,10 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#point"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
     "tags": [],

diff --git a/AppExamples/scripted_actuals/ScriptedActualPointCloud/metainfo.json b/AppExamples/scripted_actuals/ScriptedActualPointCloud/metainfo.json
@@ -6,6 +6,10 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#point-cloud"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
     "tags": [],

diff --git a/AppExamples/scripted_actuals/ScriptedActualSection/metainfo.json b/AppExamples/scripted_actuals/ScriptedActualSection/metainfo.json
@@ -7,6 +7,10 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#section"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
     "tags": [],

diff --git a/AppExamples/scripted_actuals/ScriptedActualSurface/metainfo.json b/AppExamples/scripted_actuals/ScriptedActualSurface/metainfo.json
@@ -6,6 +6,10 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#surface"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
     "tags": [],

diff --git a/AppExamples/scripted_actuals/ScriptedActualSurfaceCurve/metainfo.json b/AppExamples/scripted_actuals/ScriptedActualSurfaceCurve/metainfo.json
@@ -6,6 +6,10 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#surface-curve"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
     "tags": [],

diff --git a/AppExamples/scripted_actuals/ScriptedActualVolume/metainfo.json b/AppExamples/scripted_actuals/ScriptedActualVolume/metainfo.json
@@ -6,9 +6,13 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#volume"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
-    "tags": [],
+    "tags": ["xray"],
     "title": "ScriptedActualVolume",
     "uuid": "a5a38b5b-5f22-442e-98a4-65782b24fe39",
     "version": "1.0.0"

diff --git a/AppExamples/scripted_actuals/ScriptedActualVolumeDefects/metainfo.json b/AppExamples/scripted_actuals/ScriptedActualVolumeDefects/metainfo.json
@@ -6,9 +6,13 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#volume-defects"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
-    "tags": [],
+    "tags": ["xray"],
     "title": "ScriptedActualVolumeDefects",
     "uuid": "4b9bc4ad-b369-4f2f-8b18-e90f2405c5a0",
     "version": "1.0.0"

diff --git a/AppExamples/scripted_actuals/ScriptedActualVolumeRegion/metainfo.json b/AppExamples/scripted_actuals/ScriptedActualVolumeRegion/metainfo.json
@@ -7,9 +7,13 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#volume-region"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
-    "tags": [],
+    "tags": ["xray"],
     "title": "ScriptedActualVolumeRegion",
     "uuid": "1b3d4fe5-67d9-41a6-b950-6533fcddd099",
     "version": "1.0.0"

diff --git a/AppExamples/scripted_actuals/ScriptedActualVolumeSection/metainfo.json b/AppExamples/scripted_actuals/ScriptedActualVolumeSection/metainfo.json
@@ -6,9 +6,13 @@
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#volume-section"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
-    "tags": [],
+    "tags": ["xray"],
     "title": "ScriptedActualVolumeSection",
     "uuid": "bb1a18a6-82b6-48d4-b352-462758ece8b1",
     "version": "1.0.1"

diff --git a/AppExamples/scripted_actuals/TrimeshDeformMesh/metainfo.json b/AppExamples/scripted_actuals/TrimeshDeformMesh/metainfo.json
@@ -1,14 +1,19 @@
 {
     "author": "Carl Zeiss GOM Metrology GmbH",
     "description": "This example demonstrates how to generate a custom surface element using a scripted element. The example script accesses mesh information from an existing mesh in the project and adds a random deformation to each point.",
+    "example-projects": ["zeiss_part_test_project"],
     "labels": [],
     "licensing": {
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#surface"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
-    "tags": [],
+    "tags": ["surface", "scripted-actual"],
     "title": "TrimeshDeformMesh",
     "uuid": "3ace1cee-6873-40ac-bb3c-ce4fa1f2f56c",
     "version": "1.0.0"

diff --git a/AppExamples/scripted_checks/ScriptedCurveCheck/metainfo.json b/AppExamples/scripted_checks/ScriptedCurveCheck/metainfo.json
@@ -1,14 +1,19 @@
 {
     "author": "Carl Zeiss GOM Metrology GmbH",
     "description": "This example demonstrates how to create a scalar curve check by a script. Also, the usage of custom coordinate systems in scripted checks is shown.",
+    "example-projects": ["zeiss_part_test_project"],
     "labels": [],
     "licensing": {
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_checks.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#scalar-curve"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
-    "tags": [],
+    "tags": ["scripted-check", "curve"],
     "title": "ScriptedCurveCheck",
     "uuid": "9839d24c-2728-46c5-9468-fa65e38389bd",
     "version": "1.0.0"

diff --git a/AppExamples/scripted_checks/ScriptedScalarCheck/metainfo.json b/AppExamples/scripted_checks/ScriptedScalarCheck/metainfo.json
@@ -2,14 +2,19 @@
     "author": "Carl Zeiss GOM Metrology GmbH",
     "description": "This example shows how to create a scalar check by script. A scalar check is the most basic check, as it assigns a scalar value to an element. Nearly all elements you can find in the software can be checked like this.",
     "environment": "ZeissInspectExampleProjects",
+    "example-projects": ["zeiss_part_test_project"],
     "labels": [],
     "licensing": {
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_checks.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#scalar"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
-    "tags": [],
+    "tags": ["scripted-check", "scalar"],
     "title": "ScriptedScalarCheck",
     "uuid": "1212cf39-9f41-4ae2-bb8f-f7f76b072d91",
     "version": "1.0.2"

diff --git a/AppExamples/scripted_checks/ScriptedSurfaceCheck/metainfo.json b/AppExamples/scripted_checks/ScriptedSurfaceCheck/metainfo.json
@@ -1,14 +1,19 @@
 {
     "author": "Carl Zeiss GOM Metrology GmbH",
     "description": "This example demonstrates how to create a scalar surface check by a script. Also, the usage of custom coordinate systems and element preview in scripted checks is shown.",
+    "example-projects": ["zeiss_part_test_project"],
     "labels": [],
     "licensing": {
         "licenses": [],
         "product-codes": []
     },
+    "references": [
+        ["HowTo", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_checks.html"], 
+        ["API", "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#scalar-surface"]
+    ],
     "software-revision": "0000",
     "software-version": "ZEISS INSPECT 2025",
-    "tags": [],
+    "tags": ["scripted-check", "surface"],
     "title": "ScriptedSurfaceCheck",
     "uuid": "81ff67e8-7701-4179-869f-e187d62b945a",
     "version": "1.0.0"