From 607e7a1739b09733a472ec418841d4706d3e206b Mon Sep 17 00:00:00 2001 From: guerler Date: Mon, 4 Nov 2024 17:02:29 +0300 Subject: [PATCH] Update xml wrapper related docs --- docs/content/xml-datasources.md | 4 +- docs/content/xml-inputs.md | 85 ++++++++++++++++++++++++++++----- docs/content/xml-sections.md | 9 ++-- 3 files changed, 82 insertions(+), 16 deletions(-) diff --git a/docs/content/xml-datasources.md b/docs/content/xml-datasources.md index 79c6735..9543005 100644 --- a/docs/content/xml-datasources.md +++ b/docs/content/xml-datasources.md @@ -2,9 +2,9 @@ outline: deep --- -# Data Sources +## Data Sources -A data source section is required in the Visualization XML in order to let Galaxy know which datatypes are compatible with your visualization. +The Data Sources section is required in the Visualization XML to inform Galaxy of the compatible data types for your visualization. ```xml diff --git a/docs/content/xml-inputs.md b/docs/content/xml-inputs.md index 3cfe2aa..0620968 100644 --- a/docs/content/xml-inputs.md +++ b/docs/content/xml-inputs.md @@ -1,8 +1,8 @@ -# Inputs +## Inputs -You may specify `input` elements in the `settings` and `tracks` sections. This will allow users to parameterize and customize their visualization. Currently, Galaxy Charts supports the following input types: `boolean`, `color`, `float`, `integer`, `select`, and `text` input fields. +You can specify input elements within the settings and tracks sections, allowing users to parameterize and customize their visualization. Galaxy Charts currently supports the following input types: `boolean`, `color`, `data`, `float`, `integer`, `select`, and `text`. -Here is a generic `input` element template, specifying `label`, `help`, `name`, `type` attributes in addition to an optional `data` array used for `select` inputs: +Below is a template for a generic input element. It includes attributes such as `label`, `help`, `name`, and `type`, along with an optional `data` array used for `select` inputs: ```md @@ -20,7 +20,6 @@ Here is a generic `input` element template, specifying `label`, `help`, `name`, ``` - ## Boolean Input Boolean inputs are useful to display yes/no options to the user e.g. @@ -59,6 +58,7 @@ Users may also select colors, this can be particular useful to distinguish data color ``` + Translates to: @@ -75,6 +75,32 @@ Translates to: `my_color_name` = {{ colorInput }} +## Data Input + +Using a `data` input field you can allow users to select a dataset from Galaxy: + +```md + + + My Data Help + my_data_name + data + +``` + +Translates to: + + +
+
My Data Label
+
My Data Help
+ +
+
+ +`my_data_name` + = {{ dataInput }} + ## Float Input ```md @@ -133,21 +159,34 @@ Translates to: My Select Help my_select_name select - my_option_1 + my_option_a - - my_option_1 + + my_option_a - - my_option_2 + + my_option_b ... ``` +Translates to: + + +
+
My Select Label
+
My Select Help
+ +
+
+ +`my_select_name` + = {{ selectInput }} + ## Text Input Last but not least, `text` inputs can be declared. @@ -176,10 +215,34 @@ Translates to: \ No newline at end of file diff --git a/docs/content/xml-sections.md b/docs/content/xml-sections.md index 6e0a6bd..160ac8e 100644 --- a/docs/content/xml-sections.md +++ b/docs/content/xml-sections.md @@ -2,7 +2,8 @@ ## Settings Section -The `settings` section contains an `array` of `input` elements enabling users to customize the visualization. These customization options also become available when embedding the visualization in Galaxy workflow reports. Here is an example of a `settings` section with a single `text` input element: +The `settings` section includes an `array` of `input` elements that allow users to customize the visualization. These customization options are also available when embedding the visualization in Galaxy workflow reports. Below is an example of a `settings` section with a single `text` input element: + ```md @@ -16,7 +17,8 @@ The `settings` section contains an `array` of `input` elements enabling users to ## Specs Section -The `specs` section contains an `array` of static `key/value` pairs for arbitrary use e.g. +The `specs` section includes an `array` of static `key-value` pairs for general use, such as: + ```md my_value @@ -26,7 +28,8 @@ The `specs` section contains an `array` of static `key/value` pairs for arbitrar ## Tracks Section -The `tracks` section contains an `array` of `input` elements enabling users to configure individual data tracks e.g. +The `tracks` section includes an `array` of `input` elements that allow users to configure individual data tracks, for example: + ```md