diff --git a/docs/manuals/studio/config/elements.md b/docs/manuals/studio/config/elements.md index b691238ee..a364f8f41 100644 --- a/docs/manuals/studio/config/elements.md +++ b/docs/manuals/studio/config/elements.md @@ -1,246 +1,207 @@ Configuration elements defined in a configuration file are grouped by type; each element type has a specific section in the -"Taipy Configs" panel. +**Taipy Configs** panel. -# Data Nodes configuration +## Data Nodes configuration -The "Data Nodes" section list all the Data Node configuration defined in the selected +The **Data Nodes** section list all the Data Node configuration defined in the selected configuration file. -## Creating a new Data Node configuration +### Creating a new Data Node configuration -Press the '+' sign that appears when you hover the title of the Data Nodes section of -the "Taipy Configs" panel.
+Press the '+' sign that appears when you hover the title of the **Data Nodes** section of +the **Taipy Configs** panel.
Taipy Studio will prompt you for an identifier for this new Data Node configuration element.
Note that you cannot set the identifier of a new Data Node element to one already used by another. Default values are provided for the essential properties of the new Data Node configuration -element: *storage_type* is set to "pickle" and *scope* is set to "SCENARIO:SCOPE".
+element: *storage_type* is set to "pickle", and *scope* is set to "SCENARIO:SCOPE".
The properties for the new element are displayed in the DETAILS section of the -"Taipy Configs" panel. +**Taipy Configs** panel. -## Renaming a Data Node configuration +### Renaming a Data Node configuration -Right-click a Data Node identifier in the Data Node section and select the -"Rename node" option.
-Note that you cannot set the new identifier of a Data Node element to one -that is already used by another Data Node element. +Right-click a Data Node identifier in the **Data Nodes** section and select the "Rename" +option.
+Note that you cannot set the new identifier of a Data Node element to one that is already used by +another Data Node element. -The new name of a Data Node element is propagated to the Task configurations -that reference it. +The new name of a Data Node element is propagated to the Task configurations that reference it. -## Deleting a Data Node configuration +### Deleting a Data Node configuration Right-click a Data Node identifier in the Data Node section and select the -"Delete node from configuration" option.
+"Delete from configuration" option.
Taipy Studio will prompt you to confirm you really want to remove that element from the configuration file. -## Locate in the Graph View +### Locate in the Graph View -If a [Graph View](graphview.md) is active, +If a [Graph View](graphview.md) is active and showing a Scenario configuration, you add a specific Data Node configuration element to that view by selecting the "Add/Show in active View" menu option that pops when you right-click the relevant element identifier. If that Data Node configuration element is already present in the Graph View, -then the view is panned so you can spot it easily. +the view is panned so you can spot it easily. -## Properties +### Properties -The "Details" section will let you: +The **Details** section will let you: - Change the Data Node configuration identifier. - Specify the storage type property. - Specify the scope property. - Add Data Node-specific properties and values that Taipy Core can use. -# Tasks configuration +## Tasks configuration -The "Tasks" section list all the Task configuration elements defined in the selected +The **Tasks** section lists all the Task configuration elements defined in the selected configuration file. -## Creating a new Task configuration +### Creating a new Task configuration -Press the '+' sign that appears when you hover the title of the Tasks section of the -"Taipy Configs" panel.
+Press the '+' sign that appears when you hover the title of the **Tasks** section of the +**Taipy Configs** panel.
Taipy Studio will prompt you for an identifier for this new Task configuration element.
Note that you cannot set the identifier of a new Task element to one already used by another. Default values are provided for the essential properties of the new Task configuration -element: *inputs* and *outputs* are set to an empty list and *skippable* is set to +element: *inputs* and *outputs* are set to an empty list, and *skippable* is set to "False:bool".
The properties for the new element are displayed in the DETAILS section of the "Taipy Configs" panel. -## Renaming a Task configuration +### Renaming a Task configuration -Right-click a Task identifier in the Tasks section and select the -"Rename node" option.
-Note that you cannot set the new identifier of a Task element to one -that is already used by another Task element. +Right-click a Task identifier in the **Tasks** section and select the "Rename" option.
+Note that you cannot set the new identifier of a Task element to one that is already used by +another Task element. -The new name of a Task element is propagated to the Pipeline configurations -that reference it. +The new name of a Task element is propagated to the Scenario configurations that reference it. -## Deleting a Task configuration +### Deleting a Task configuration -Right-click a Task identifier in the Tasks section and select the -"Delete node from configuration" option.
+Right-click a Task element identifier in the **Tasks** section and select the +"Delete from configuration" option.
Taipy Studio will prompt you to confirm you really want to remove that element from the configuration file. -## Locate in the Graph View +### Locate in the Graph View -If a [Graph View](graphview.md) is active, +If a [Graph View](graphview.md) is active and showing a Scenario configuration, you add a specific Task configuration element to that view by selecting the "Add/Show in active View" menu option that pops when you right-click the relevant element identifier.
Note that adding the Task configuration element to the Graph View also -adds the dependent Data Node configuration elements that it depends on. - -If the Graph View represents a Pipeline configuration, then the Task -configuration is added to that Pipeline configuration. +adds the dependent Data Node configuration elements it depends on. If that Task configuration element is already present in the Graph View, -then the view is panned so you can spot it easily. +then the view is panned so you can spot the Task element easily. -## Properties +### Properties -The "Details" section will let you: +The **Details** section will let you: - Change the Task configuration identifier. - Change the input and output Data Nodes used by this Task configuration.
You can pick the Data Node configurations from the list of configured Data Nodes in the selected configuration file. - Specify the function used by this Task configuration.
- You will select the module to locate the function, then the function + You will select the module to locate the function, then the name of the function itself.
- Note that if you right-click the function name in the Details section, + If you right-click the function name in the **Details** section, you can select the "Show Source" menu option. This opens an editor showing the source code at the location where the function is defined. - Specify whether this Task configuration is *skippable* or not. -# Pipelines configuration +## Scenarios configuration -The "Pipelines" section list all the Pipeline configuration elements defined in the selected +The **Scenarios** section lists all the Scenario configuration elements defined in the selected configuration file. -## Creating a new Pipeline configuration +If a Scenario configuration element contains one or more sequences, its node can be expanded to +reveal the Sequence elements the Scenario configuration defines. + +### Creating a new Scenario configuration -Press the '+' sign that appears when you hover the title of the Pipelines section of the -"Taipy Configs" panel.
-Taipy Studio will prompt you for an identifier for this new Pipeline configuration +Press the '+' sign that appears when you hover the title of the **Scenarios** section of +the **Taipy Configs** panel.
+Taipy Studio will prompt you for an identifier for this new Scenario configuration element.
-Note that you cannot set the identifier of a new Pipeline element to one +Note that you cannot set the identifier of a new Scenario element to one already used by another. -Default values are provided for the essential properties of the new Pipeline configuration -element: *tasks* is set to an empty list.
+Default values are provided for the essential properties of the new Scenario configuration +element: *sequences* is set to an empty list.
The properties for the new element are displayed in the DETAILS section of the "Taipy Configs" panel. -## Renaming a Pipeline configuration +### Renaming a Scenario configuration -Right-click a Pipeline identifier in the Pipelines section and select the +Right-click a Scenario identifier in the **Scenarios** section and select the "Rename node" option.
-Note that you cannot set the new identifier of a Pipeline element to one +Note that you cannot set the new identifier of a Scenario element to one already used by another. -The new name of a Pipeline element is propagated to the Scenario configurations -that reference it. - -## Deleting a Pipeline configuration +### Deleting a Scenario configuration -Right-click a Pipeline identifier in the Pipelines section and select the -"Delete node from configuration" option.
+Right-click a Scenario identifier in the **Scenarios** section and select the +"Delete from configuration" option.
Taipy Studio will prompt you to confirm you really want to remove that element from the configuration file. -## Showing in a Graph View +### Showing in a Graph View -Right-click a Pipeline identifier in the Pipelines section and select the +Right-click a Scenario identifier in the **Scenarios** section and select the "Show View" option.
-Taipy Studio will create a [Graph View](graphview.md) that represents -the Pipeline configuration element you selected. - -## Locate in the Graph View - -If a [Graph View](graphview.md) is active, -you add a specific Pipeline configuration element to that view by selecting -the "Add/Show in active View" menu option that pops when you right-click the -relevant element identifier. - -If the Graph View represents a Scenario configuration, then the Pipeline -configuration is added to that Scenario configuration. - -If that Pipeline configuration element is already present in the Graph View, -then the view is panned so you can spot it easily. +Taipy Studio will create a [Graph View](graphview.md) representing the selected Scenario +configuration element. -## Properties +The Graph View will represent all the configuration elements referenced by this Scenario +configuration (all the dependent Task and Data Node configuration elements). -The "Details" section will let you: +### Adding a sequence -- Change the Pipeline configuration identifier. -- Change the Tasks used by this Pipeline configuration.
- You can pick the Task configurations from the list of configured - Tasks in the selected configuration file. - -# Scenarios configuration - -The "Scenarios" section list all the Scenario configuration elements defined in the selected -configuration file. - -## Creating a new Scenario configuration - -Press the '+' sign that appears when you hover the title of the Scenarios section of -the "Taipy Configs" panel.
-Taipy Studio will prompt you for an identifier for this new Scenario configuration +Press the '+' sign that appears next to a **Scenario** configuration name in the **Scenarios** +section of the **Taipy Configs** panel.
+Taipy Studio will prompt you for an identifier for a new sequence in this Scenario configuration element.
-Note that you cannot set the identifier of a new Scenario element to one -already used by another. +Note that you cannot set the identifier of a sequence to one already used in this Scenario +configuration element. -Default values are provided for the essential properties of the new Scenario configuration -element: *pipelines* is set to an empty list.
-The properties for the new element are displayed in the DETAILS section of the -"Taipy Configs" panel. +### Renaming a sequence -## Renaming a Scenario configuration - -Right-click a Scenario identifier in the Scenarios section and select the -"Rename node" option.
-Note that you cannot set the new identifier of a Scenario element to one -already used by another. +Right-click a Sequence identifier in the list of child nodes of a Scenario element in the +**Scenarios** section and select the "Rename" option.
+Note that you cannot set the new identifier of a sequence to one that is already used by the +selected Scenario configuration element. -## Deleting a Scenario configuration +### Deleting a sequence -Right-click a Scenario identifier in the Scenarios section and select the -"Delete node from configuration" option.
+Right-click a Sequence identifier in the list of child nodes of a Scenario element in the +**Scenarios** section and select the "Delete from configuration" option.
Taipy Studio will prompt you to confirm you really want to remove that element from the configuration file. -## Showing in a Graph View +### Properties -Right-click a Scenario identifier in the Scenarios section and select the -"Show View" option.
-Taipy Studio will create a [Graph View](graphview.md) that represents -the Scenario configuration element you selected. +If a Scenario configuration element is selected in the **Scenarios** section, the **Details** +section displays the details of that Scenario element and lets you: + +- Change the identifier of the Scenario configuration element. +- Change the Tasks used by this Scenario configuration.
+ Selecting the value of the *tasks* field will prompt you to select the Tasks configuration + elements you want to reference from the Scenario configuration element. -The Graph View will represent all the Pipeline configuration elements -referenced by this Scenario configuration and all the dependent -Task and Data Node configuration elements. +If a sequence of a Scenario configuration element is selected in the **Scenarios** section, the +**Details** section displays the details of that sequence and lets you: -## Properties +- Change the sequence identifier. +- Change the Tasks used by this sequence. -The "Details" section will let you: -- Change the Scenario configuration identifier. -- Change the Pipelines used by this Scenario configuration.
- You can pick the Pipeline configurations from the list of - configured Pipelines in the selected configuration file. -- Specify the frequency used by this Scenario configuration. -- Specify comparator functions used by this Scenario configuration. diff --git a/docs/manuals/studio/config/files.md b/docs/manuals/studio/config/files.md index 55add542b..b8395c432 100644 --- a/docs/manuals/studio/config/files.md +++ b/docs/manuals/studio/config/files.md @@ -1,11 +1,11 @@ -The "Config Files" section holds the list of configuration files (`*.toml`) in your +The **Config Files** section holds the list of configuration files (`*.toml`) in your project. You will select the one you want to edit from that list.
This list shows the base names of all the configuration files. If two configuration files have the same name (but are located in two different directories), the path to the directory where these files belong will be displayed next to the base file name to avoid confusion. -Because the "Config Files" list is synchronized with the files included in your project, +Because the **Config Files** list is synchronized with the files included in your project, adding a configuration file is simply a matter of creating it from the Visual Studio Code Explorer panel: @@ -13,15 +13,17 @@ Code Explorer panel:

-Similarly, if you remove or rename a configuration file from the Explorer panel of Visual +This animation demonstrates how to open the **Taipy Configs** pane, if necessary. + +Similarly, if you remove or rename a configuration file from the **Explorer** panel of Visual Studio Code, the change is immediately reflected in the Config Files section of the Taipy Configs panel. Note that if you right-click a configuration file, Taipy Studio displays a menu that -let you choose one of two options: +lets you choose one of two options: - "Reveal file in explorer view": Visual Studio Code will select and focus on the file - item in the project's files in the Explorer pane. + item in the project's files in the **Explorer** pane. - "Show view": creates a view from the configuration file that represents all the configuration elements as a [global graph](graphview.md), so you can see - all the elements and how they relate to each other. + all the configuration elements and how they relate to each other. diff --git a/docs/manuals/studio/config/graphview.md b/docs/manuals/studio/config/graphview.md index cd3be77f0..be33b9017 100644 --- a/docs/manuals/studio/config/graphview.md +++ b/docs/manuals/studio/config/graphview.md @@ -6,44 +6,39 @@ There are two types of elements displayed in these views: - Nodes:
These are rectangular boxes that represent specific configuration elements. All - elements have an "In" and an "Out" port that let you connect elements one to - another. + elements have an "In" and an "Out" port that connect elements one to another. - Links:
- These a lines that represent the relation between two elements. All links - go from the "Out" port of an element to the "In" port of another
+ These are lines that represent the relation between two elements. All links + go from the "Out" port of an element to the "In" port of another:
- A link from a Data Node element to a Task element indicates that the Data Node element is one of the input Data Nodes of the Task element. - A link from a Task element to a Data Node element indicates that the Data Node element is one of the output Data Nodes of the Task element. - - A link from a Pipeline element to a Task element indicates that - the Task element is one of the tasks of the Pipeline element. - - A link from a Scenario element to a Pipeline element indicates that - the Pipeline element is one of the tasks of the Scenario element. + - A link from a Scenario element to a Task element indicates that + the Task element is one of the tasks of the Scenario element. -# Opening a Graph View +## Opening a Graph View A Graph View can be created in three situations: - To display the entire content of a configuration file.
- Right-click a configuration file item in the CONFIG FILES section of - the Taipy Configs pane, and select "Show View". -- To display a Pipeline configuration element.
- Right-click a Pipeline configuration element in the PIPELINES section of - the Taipy Configs pane, and select "Show View". + Right-click a configuration file item in the **Config Files** section of + the **Taipy Configs** pane, and select "Show View". - To display a Scenario configuration element.
- Right-click a Scenario configuration element in the SCENARIOS section of - the Taipy Configs pane, and select "Show View". + Right-click a Scenario configuration element in the **Scenarios** section of + the **Taipy Configs** pane, and select "Show View". -# The Graph View actions +## The Graph View actions -At the top of a Graph View, there is a row of icons that can be clicked -to trigger actions. +At the top of a Graph View, you can see the identifier of the focused configuration element. -This row is split into three sections: +Below that top row, there is a row of icons that can be clicked to trigger actions. + +This row is split into two sections: - Left section: General tools - - ![Rerun Layout](../images/config-icon-relayout.png)
- Rearrange the elements, so they look better in the view. + - ![Re-layout](../images/config-icon-relayout.png)
+ Rearrange the elements so they look better in the view. - ![Refresh](../images/config-icon-refresh.png)
Reload the configuration file in case a desynchronization occurs. - ![Unsaved](../images/config-icon-modified.png)
@@ -51,39 +46,32 @@ This row is split into three sections: if the file needs saving.
This icon is not present when the Graph View represents a whole configuration file since this information is already in the tab title. - - ![Generate image](../images/config-icon-saveimage.png)
- Save the Graph View as an image. - - ![Fit to contents](../images/config-icon-zoomfit.png):
+ - ![Save as PNG](../images/config-icon-saveimage.png)
+ Save the Graph View in a PNG image file. + - ![Zoom to fit](../images/config-icon-zoomfit.png):
Adjust the panning and zoom factor of the Graph View so the entire graph can be represented. -- Center section: Configuration element name and type.
- This section is empty when the Graph View represents a complete configuration file.
- If the Graph View represents a pipeline configuration element, this section displays the - label *PIPELINE.<name>* where *<name>* is the name of the element.
- If the Graph View represents a scenario configuration element, this section displays the - label *SCENARIO.<name>* where *<name>* is the name of the element.
- Right section: Configuration element creation tools. - - ![Add Data Node](../images/config-icon-add-datanode.png)
- Adds a new Data Node configuration element in the configuration file as well as in the Graph View. - - ![Add Task](../images/config-icon-add-task.png)
- Adds a new Task configuration element in the configuration file as well as in the Graph View. - - ![Add Pipeline](../images/config-icon-add-pipeline.png)
- Adds a new Task configuration element in the configuration file as well as in the Graph View.
- This icon appears **only** when the Graph View represents a Scenario configuration element or a configuration file. - ![Add Scenario](../images/config-icon-add-scenario.png)
- Adds a new Scenario configuration element in the configuration file as well as in the Graph View.
+ Adds a new Scenario configuration element in the configuration file as well as in the Graph + View.
This icon appears **only** when the Graph View represents a full configuration file. + - ![Add Task](../images/config-icon-add-task.png)
+ Adds a new Task configuration element in the configuration file as well as in the Graph + View. + - ![Add Data Node](../images/config-icon-add-datanode.png)
+ Adds a new Data Node configuration element in the configuration file as well as in the Graph + View. - -# Editing in a Graph View +## Editing in a Graph View To demonstrate the capabilities of the Graph View, we will create the configuration described in the [Python code configuration](../../core/config/advanced-config.md#python-code-configuration) example, using the interactive features that Taipy Studio provides.
Note that for the sake of conciseness, we will create a Scenario configuration that -holds only one Pipeline configuration. When you understand the process, you will -see that creating the second Pipeline configuration of the example is straightforward. +holds only one sequence. When you understand the process, you will see that creating other +sequences is straightforward. We are starting from a project where only the Python code was developed: @@ -94,22 +82,21 @@ We are starting from a project where only the Python code was developed: - `main.py` loads the configuration file and submits a scenario - `functions.py` defines the functions used by the Task configuration elements. -Note that there is no code for defining the `Config^` object in these source files. +Note that there is no Python code for defining the `Config^` object in these source files. We also start with an empty `config.toml` file, where the configuration elements will be defined. -You can see the 'T' sign next to the `main.py` file in the EXPLORER pane. This indicates -that this Python file is considered as the *main* Python module for the application. This -is used when you need to assign a function to be executed in a Task configuration -element.
+You can see the 'T' sign next to the `main.py` file in the **Explorer** pane. This indicates +that this Python file is considered the *main* Python module for the application. This +is used when assigning a function to be executed in a Task configuration element.
To set another source file as the *main* Python module file, simply right-click on the file -in the EXPLORER pane and select "Taipy: Set as main module". +in the **Explorer** pane and select "Taipy: Set as main module". -## Creating the first configuration elements +### Creating the first configuration elements -We will start by opening a Graph View representing the entire configuration file -then we will create the Data Node and Task configuration elements using the +We will start by opening a Graph View representing the entire configuration file. +Then, we will create the Data Node and Task configuration elements using the [Graph View action buttons](#the-graph-view-actions).

@@ -119,41 +106,32 @@ then we will create the Data Node and Task configuration elements using the After the Task configuration and all three Data Node configurations are created, we connect the Out ports to the appropriate In ports by dragging links. -## Creating the Pipeline configuration - -The Pipeline configuration element is created similarly. Once the element -appears in the Graph View, we connect its Out port to the In port of the Task -element to indicate that the "planning" task element is part of the -"production" pipeline: +Note how the Details section reflects the selected configuration element. -

- -

- -## Creating the Scenario configuration +### Creating the Scenario configuration -Similarly, we create the Scenario configuration element and connect its Out port -to the In port of the "production" pipeline to indicate that this Pipeline -configuration element is part of the "scenario_configuration" scenario: +Similarly, we create the Scenario configuration element and connect its Out port to the In port of +the "planning" task to indicate that this Task configuration element is part of the +"my_scenario" scenario:

- +

-## Setting the configuration elements parameters +### Setting the configuration elements parameters You can select a configuration element from the Graph View and use the Details -section of the Taipy Configs pane.
+section of the **Taipy Configs** pane.
From there, you can set the properties of the selected element. -Here is how we can set the function used in the Task configuration we have created above. -Note that Taipy Studio can locate the functions module and name, so it is easy to spot the -one you want to use.
+Here is how we can set the function used in the Task configuration we have created above. Taipy +Studio can locate the functions module and name, so it is easy to spot the one you want to +use.
In our example, we want our Task configuration to use the function called `plan` from the `functions` module (the `functions.py` source file):

- +

After this final step, the configuration file can be saved from the Graph View @@ -172,14 +150,14 @@ if __name__ == "__main__": tp.Core().run() # Retrieve the scenario configuration from the Config - scenario_cfg = Config.scenarios["scenario_configuration"] + scenario_cfg = Config.scenarios["my_scenario"] # Create a scenario entity scenario = tp.create_scenario(scenario_cfg) # Submit the scenario tp.submit(scenario) ``` -## Changing the links +### Changing the links - To add a control point on a link, click the link where you want to create the control point, then drag the point where you want it. Release the diff --git a/docs/manuals/studio/config/index.md b/docs/manuals/studio/config/index.md index a335470b2..406143820 100644 --- a/docs/manuals/studio/config/index.md +++ b/docs/manuals/studio/config/index.md @@ -1,5 +1,3 @@ -# Building configurations - Applications that rely on [Taipy Core](../../core/index.md) need to define a [Configuration](../../core/config/index.md) where the data flow is described.
@@ -10,7 +8,7 @@ section). Taipy Studio provides ways to design graphically Taipy application configurations. Within the Visual Studio Code environment, you can create configuration elements (for -Data Nodes, Tasks, Pipelines, and Scenarios), specify the properties for those elements, +Data Nodes, Tasks, and Scenarios), specify the properties for those elements, and use a visual representation of those configuration elements as a graph.

@@ -23,43 +21,45 @@ runtime by Taipy applications as described in the ## Introduction -Taipy Studio has a dedicated panel called "Taipy Configs", where mostly everything +Taipy Studio has a dedicated panel called **Taipy Configs**, where almost everything happens. To open this panel, use the "View > Open View..." menu option and search for the view called "Taipy Configs". The view appears like this:

- +

This panel is split into several sections that let the user access all the configuration elements: -- Config Files: holds a list of configuration files (`*.toml`) that exist in the +- **Config Files**: holds a list of configuration files (`*.toml`) that exist in the project.
The user can select a configuration file in this list to populate the other sections of the Taipy Configs view. -- Data Nodes: holds the list of +- **Data Nodes**: holds the list of [Data Node configurations](../../core/config/data-node-config.md) defined in the selected configuration file.
The user can select a Data Node configuration in this list to access all its properties in the Details section (see below). -- Tasks: holds the list of +- **Tasks**: holds the list of [Task configurations](../../core/config/task-config.md) defined in the selected configuration file.
The user can select a Task configuration in this list to access all its properties in the Details section (see below). -- Scenarios: holds the list of +- **Scenarios**: holds the list of [Scenario configurations](../../core/config/scenario-config.md) defined in the selected configuration file.
+ Each Scenario configuration element may contain sequences that appear as child nodes of the + scenario element.
The user can select a Scenario configuration in this list to access all its properties in the Details section (see below). -- Details: When a configuration element is selected, the Details section displays +- **Details**: When a configuration element is selected, the Details section displays all the properties of this configuration element and allows the user to modify these properties. -Using these different sections, you can add, rename or remove configuration +Using these different sections, you can add, rename, or remove configuration elements, as well as change their properties in the "Details" section. All your actions impact the selected configuration file; diff --git a/docs/manuals/studio/config/textedition.md b/docs/manuals/studio/config/textedition.md index e600b4b95..564307ad6 100644 --- a/docs/manuals/studio/config/textedition.md +++ b/docs/manuals/studio/config/textedition.md @@ -3,10 +3,10 @@ Code lets you edit it manually, as any other text file.
Taipy Studio provides some support for identifying problems in configuration files and accelerating typing thanks to auto-completion features. -# Auto-completion +## Auto-completion If you are entering text in a configuration section ([DATA_NODE.*id*], [TASK.*id*], etc.), -you can press the `Ctrl-` key combination, then Taipy Studio will suggest relevant +you can press the `Ctrl-` key combination: Taipy Studio will then suggest relevant fragments that would prevent you from typing them entirely. Those suggestions include property names and values, as demonstrated in the following animation, @@ -20,11 +20,11 @@ showing how we could create a new Data Node configuration in the body of a confi You will also get support for auto-completion in other contexts, such as a reference to another configuration element. -# Spotting problems +## Spotting problems Taipy Studio helps point out potential problems in your configuration files that are -indicated in the body of the file content, in the Problems pane, and in the "Details" -section of the "Taipy Configs" pane. +indicated in the body of the file content, in the Problems pane, and in the **Details** +section of the **Taipy Configs** pane.

@@ -34,12 +34,10 @@ Here are the problems that Taipy Studio identifies: - General TOML syntax errors from the "Even Better TOML" extension. - "No reference to element 'XXX'." (Warning)
- The configuration element (Data Node, Task, or Pipeline) is not referenced - by any other element. + The configuration element (Data Node or Task) is not referenced by any other element. - "Element 'XXX' does not exist." (Error)
A configuration element identifier that does not exist is referenced by this - configuration element (Data Node, Task, Pipeline, or Scenario). + configuration element (Data Node, Task, or Scenario). - "Cannot find Python function: 'XXX'." (Error)
This Task configuration element uses a function name that does not exist.
A Quick Fix can create that function for you. - diff --git a/docs/manuals/studio/images/config-icon-add-pipeline.png b/docs/manuals/studio/images/config-icon-add-pipeline.png deleted file mode 100644 index dbb970ed8..000000000 Binary files a/docs/manuals/studio/images/config-icon-add-pipeline.png and /dev/null differ diff --git a/docs/manuals/studio/images/config_graphview_1.gif b/docs/manuals/studio/images/config_graphview_1.gif index 11f32c190..483fd2c03 100644 Binary files a/docs/manuals/studio/images/config_graphview_1.gif and b/docs/manuals/studio/images/config_graphview_1.gif differ diff --git a/docs/manuals/studio/images/config_graphview_2.gif b/docs/manuals/studio/images/config_graphview_2.gif index 01894cafc..4d9a65042 100644 Binary files a/docs/manuals/studio/images/config_graphview_2.gif and b/docs/manuals/studio/images/config_graphview_2.gif differ diff --git a/docs/manuals/studio/images/config_graphview_3.gif b/docs/manuals/studio/images/config_graphview_3.gif index 9c6dfc707..48d00f7bd 100644 Binary files a/docs/manuals/studio/images/config_graphview_3.gif and b/docs/manuals/studio/images/config_graphview_3.gif differ diff --git a/docs/manuals/studio/images/config_graphview_4.gif b/docs/manuals/studio/images/config_graphview_4.gif deleted file mode 100644 index eb91bf1f9..000000000 Binary files a/docs/manuals/studio/images/config_graphview_4.gif and /dev/null differ diff --git a/docs/manuals/studio/images/config_init.gif b/docs/manuals/studio/images/config_init.gif index af1b72049..7c891fbd8 100644 Binary files a/docs/manuals/studio/images/config_init.gif and b/docs/manuals/studio/images/config_init.gif differ diff --git a/docs/manuals/studio/images/config_overview.png b/docs/manuals/studio/images/config_overview.png index 31a2d7baf..111562ed0 100644 Binary files a/docs/manuals/studio/images/config_overview.png and b/docs/manuals/studio/images/config_overview.png differ diff --git a/docs/manuals/studio/images/config_panel.png b/docs/manuals/studio/images/config_panel.png index 90ca1c55d..f92430168 100644 Binary files a/docs/manuals/studio/images/config_panel.png and b/docs/manuals/studio/images/config_panel.png differ diff --git a/docs/manuals/studio/index.md b/docs/manuals/studio/index.md index 97cdaaad4..65e22a167 100644 --- a/docs/manuals/studio/index.md +++ b/docs/manuals/studio/index.md @@ -1,5 +1,3 @@ -# Taipy Studio - Taipy Studio is an extension to [Visual Studio Code](https://code.visualstudio.com/) that significantly accelerates the development of Taipy applications. @@ -13,7 +11,7 @@ This tool addresses two major areas: which depend on configuration elements. Taipy Studio provides a graphical editor where you can create and configure - the elements of your configurations stored in toml files that your Taipy + the elements of your configurations stored in TOML files that your Taipy application can load at runtime. The editor can represent sequences and scenarios as graphs, where nodes are DataNodes or Tasks. @@ -33,7 +31,7 @@ This tool addresses two major areas: text fragments. It is also tricky to locate typos and errors in the Markdown text. - Taipy Studio will spot these problems for you and report them in the + Taipy Studio will spot these problems and report them in the *Problems* view. It can often provide a *Quick Fix* action that can solve your syntactic problem in no time. diff --git a/mkdocs.yml_template b/mkdocs.yml_template index bc823d0ee..04d577dfc 100644 --- a/mkdocs.yml_template +++ b/mkdocs.yml_template @@ -184,9 +184,9 @@ nav: - "On Databricks": - "Deploying on Databricks": manuals/run-deploy/deploy/databricks/index.md - "Taipy Studio": - - manuals/studio/index.md + - "Taipy Studio": manuals/studio/index.md - "Building configurations": - - manuals/studio/config/index.md + - "Building configurations": manuals/studio/config/index.md - "Managing configuration files": manuals/studio/config/files.md - "Configuring elements": manuals/studio/config/elements.md - "Graph views": manuals/studio/config/graphview.md