docs: boneparams

Author: akelch

docs/.vitepress/cache/deps/_metadata.json

@@ -1,25 +1,25 @@
 {
-  "hash": "216e4a8e",
+  "hash": "711eafb8",
   "configHash": "b1d0d4c4",
-  "lockfileHash": "69cf18de",
-  "browserHash": "ece5baa6",
+  "lockfileHash": "a734c7a2",
+  "browserHash": "4e60e35d",
   "optimized": {
     "vue": {
       "src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
       "file": "vue.js",
-      "fileHash": "ddb93633",
+      "fileHash": "55771715",
       "needsInterop": false
     },
     "vitepress > @vue/devtools-api": {
       "src": "../../../../node_modules/vitepress/node_modules/@vue/devtools-api/dist/index.js",
       "file": "vitepress___@vue_devtools-api.js",
-      "fileHash": "20761289",
+      "fileHash": "95505add",
       "needsInterop": false
     },
     "vitepress > @vueuse/core": {
       "src": "../../../../node_modules/@vueuse/core/index.mjs",
       "file": "vitepress___@vueuse_core.js",
-      "fileHash": "01c5c635",
+      "fileHash": "ca0f2f1b",
       "needsInterop": false
     }
   },

docs/.vitepress/config.js

@@ -12,6 +12,7 @@ export default defineConfig({
     nav: [
       { text: "Home", link: "/" },
       { text: "AdminInfo", link: "/admininfo/" },
+      { text: "BoneParameters", link: "/bones/parameters" },
     ],
 
     /*sidebar: [
@@ -37,6 +38,15 @@ export default defineConfig({
           ],
         },
       ],
+      "/bones/": [
+        {
+          text: "Bones",
+          items: [
+            { text: "Overview", link: "/bones/" },
+            { text: "Parameters", link: "/bones/parameters" },
+          ],
+        },
+      ],
     },
     aside: false,
 

docs/bones/index.md

@@ -0,0 +1,27 @@
+---
+title: Bones
+---
+
+# Bones
+
+Here is your optimized **IT Business English** translation suitable for documentation on an open-source platform like GitHub:
+
+---
+
+The various *bones* defined by the ViUR Core are represented in the admin interface through corresponding widgets. These widgets are encapsulated by three different wrapper types:
+
+* **Multiple**: Extends the widget with a drag-and-drop handle and a remove button.
+* **Language**: Wraps the widget in a tabbed navigation interface, where each language is represented by its own tab.
+* **Nested**: `usingSkel` and `recordBone` instances are wrapped in a nested wrapper that provides its own dedicated `viforms` instance.
+
+In addition to these standard wrappers, which apply to all bones, some bones support specialized widgets that can be selected via the `type_suffix` option.
+
+---
+
+
+| BoneTyp | type_suffix | Description |
+| --- | --- | --- |
+| boolean | choose | uses radio buttons |
+| boolean | select | uses a Dropdown |
+| relational | select | uses a Dropdown |
+| select | choose | uses radio buttons or checkboxes(multiple) |

docs/bones/parameters.md

@@ -0,0 +1,20 @@
+---
+title: Bone Parameters
+---
+
+# Bone Parameters
+Bone parameters are used to pass instructions to the corresponding widgets and *viforms* instances.
+Not all parameters are supported by every widget.
+
+| Parameter | Value | Description |
+| --- | --- | --- |
+| **tooltip**             | `"Test Tooltip"`                  | Displays additional contextual information on the label, such as input guidance or helper text.                                   |
+| **category**            | `"Contact"`                       | Groups bones under the specified category name.                                                                                   |
+| **actions**             | `["describe_image", "translate"]` | Enables AI-powered actions, such as generating descriptions for *ImageBones* or translating multilingual *String* or *TextBones*. |
+| **categoryDefaultName** | `"$(rel.name)"`                   | Sets the default category name for *Relational* and *RecordBones*. Format strings are supported.                                  |
+| **collapsedCategories** | `["Contact"]`                     | Defines a list of categories that should be collapsed when the form is opened. `"*"` collapses all categories.                    |
+| **evaluate**            | *Logics*                          | A Logics rule used to compute a value based on user input.                                                                        |
+| **visibleIf**           | *Logics*                          | A Logics rule that hides the widget when the rule evaluates to `false`.                                                           |
+| **requiredIf**          | *Logics*                          | A Logics rule that overrides the bone’s `required` flag.                                                                          |
+| **readonlyIf**          | *Logics*                          | A Logics rule that overrides the bone’s `readonly` flag.                                                                          |
+

docs/index.md

@@ -13,9 +13,9 @@ hero:
     - theme: brand
       text: Admininfo
       link: /admininfo/
-    #- theme: alt
-    #  text: API Examples
-    #  link: /api-examples
+    - theme: alt
+      text: Bone Parameters
+      link: /bones/parameters
 
 #features:
 #  - title: Feature A