You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/pluggable-widgets/_index.md
+23-23Lines changed: 23 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -250,7 +250,7 @@ This section is represented by the `properties` tag in the widget XML file. It d
250
250
</properties>
251
251
```
252
252
253
-
### How to Enhance Your Pluggable Widget for Maia by Using `<prompt>`
253
+
### How to Enhance Your Pluggable Widget for Maia by Using `<prompt>` {#using-prompt-for-maia}
254
254
255
255
Maia can help developers and users work more effectively with pluggable widgets when it understands their purpose and configuration options. To enable this, you can enhance your widget definition XML file with prompt elements that describe your widget's functionality in natural language.
256
256
@@ -294,46 +294,46 @@ Well-written prompts help Maia provide accurate and helpful assistance to develo
294
294
295
295
#### Guidelines for Widget Prompts
296
296
297
-
-**Be concise and action-oriented**: Start with an action verb and keep the prompt under 20 words when possible
298
-
-**Focus on use cases**: Describe when and why someone would use this widget
299
-
-**Use plain language**: Avoid technical jargon
300
-
-**Be specific**: Instead of "displays data," write "displays tabular data with sorting and filtering capabilities"
297
+
***Be concise and action-oriented**: Start with an action verb and keep the prompt under 20 words when possible
298
+
***Focus on use cases**: Describe when and why someone would use this widget
299
+
***Use plain language**: Avoid technical jargon
300
+
***Be specific**: Instead of "displays data," write "displays tabular data with sorting and filtering capabilities"
301
301
302
302
**Good examples:**
303
303
304
-
-`"Add a data grid widget to display tabular data with sorting and pagination."`
305
-
-`"Create a progress bar to show task completion status."`
306
-
-`"Insert a chart widget to visualize numerical data as graphs."`
304
+
*`"Add a data grid widget to display tabular data with sorting and pagination."`
305
+
*`"Create a progress bar to show task completion status."`
306
+
*`"Insert a chart widget to visualize numerical data as graphs."`
307
307
308
308
**Poor examples:**
309
309
310
-
-`"Widget for data"` (too vague)
311
-
-`"Implements advanced data visualization paradigms using reactive patterns"` (too technical)
310
+
*`"Widget for data"` (too vague)
311
+
*`"Implements advanced data visualization paradigms using reactive patterns"` (too technical)
312
312
313
313
#### Guidelines for Property Prompts
314
314
315
-
-**Explain the impact**: Describe how the property affects the widget's behavior or appearance
316
-
-**Mention key values**: If the property has important values or ranges, include them
317
-
-**Use present tense**: Write as if describing current behavior, not future actions
318
-
-**Be specific about relationships**: If a property depends on others, mention that relationship
315
+
***Explain the impact**: Describe how the property affects the widget's behavior or appearance
316
+
***Mention key values**: If the property has important values or ranges, include them
317
+
***Use present tense**: Write as if describing current behavior, not future actions
318
+
***Be specific about relationships**: If a property depends on others, mention that relationship
319
319
320
320
**Good examples:**
321
321
322
-
-`"Determines whether users can select single or multiple rows in the table."`
323
-
-`"Sets the refresh interval in seconds; 0 disables automatic refresh."`
324
-
-`"Controls the color of the progress bar using CSS color values."`
322
+
*`"Determines whether users can select single or multiple rows in the table."`
323
+
*`"Sets the refresh interval in seconds; 0 disables automatic refresh."`
324
+
*`"Controls the color of the progress bar using CSS color values."`
325
325
326
326
**Poor examples:**
327
327
328
-
-`"Selection stuff"` (too vague)
329
-
-`"Will configure selection"` (wrong tense)
330
-
-`"Property for selection configuration management"` (too wordy)
328
+
*`"Selection stuff"` (too vague)
329
+
*`"Will configure selection"` (wrong tense)
330
+
*`"Property for selection configuration management"` (too wordy)
331
331
332
332
#### General Writing Guidelines
333
333
334
-
-**Use consistent terminology**: Match the language used in Mendix documentation and Studio Pro
335
-
-**Avoid redundancy**: Don't repeat information already clear from the caption
336
-
-**Keep it updated**: Update prompts when widget functionality changes
334
+
***Use consistent terminology**: Match the language used in Mendix documentation and Studio Pro
335
+
***Avoid redundancy**: Do not repeat information that is already clear from the caption
336
+
***Keep it updated**: Update prompts when widget functionality changes
337
337
338
338
By following these guidelines, you help Maia understand your widget's capabilities and provide better assistance to developers using your pluggable widget.
Copy file name to clipboardExpand all lines: content/en/docs/refguide/modeling/mendix-ai-assistance/maia-for-pages.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -96,6 +96,10 @@ The following widgets are supported if they have been installed:
96
96
*[Progress Bar](/appstore/widgets/progress-bar/) (Studio Pro 11.1 and above)
97
97
*[Progress Circle](/appstore/widgets/progress-circle/) (Studio Pro 11.1 and above)
98
98
99
+
{{% alert color="info" %}}
100
+
In Studio Pro 11.6 and above, Maia can understand customized pluggable widgets when you enhance your widget definition XML file with the `<prompt>` element. For more information, see the [How to Enhance Your Pluggable Widget for Maia by Using `<prompt>`](/apidocs-mxsdk/apidocs/pluggable-widgets/#using-prompt-for-maia) section in *Pluggable Widgets API*.
0 commit comments