From 590c95020b995ceae6fbaafa4a9578b8ca6a01ee Mon Sep 17 00:00:00 2001 From: digitalfrost Date: Fri, 12 Aug 2022 08:51:06 +0200 Subject: setting_properties.md: correct grammar Correct the grammar used in the description of default_value --- docs/profiles/setting_properties.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/profiles/setting_properties.md b/docs/profiles/setting_properties.md index 84fb458c63..8138bd77ff 100644 --- a/docs/profiles/setting_properties.md +++ b/docs/profiles/setting_properties.md @@ -4,7 +4,7 @@ Each setting in Cura has a number of properties. It's not just a key and a value * `key` (string): The identifier by which the setting is referenced. This is not a human-readable name, but just a reference string, such as `layer_height_0`. Typically these are named with the most significant category first, in order to sort them better, such as `material_print_temperature`. This is not actually a real property but just an identifier; it can't be changed. * `value` (optional): The current value of the setting. This can be a function, an arbitrary Python expression that depends on the values of other settings. If it's not present, the `default_value` is used. -* `default_value`: A default value for the setting if `value` is undefined. This property is required however. It can't be a Python expression, but it can be any JSON type. This is made separate so that CuraEngine can read it out as well for its debugging mode via the command line, without needing a complete Python interpreter. +* `default_value`: A default value for the setting if `value` is undefined. This property is required. It can't be a Python expression, but it can be any JSON type. This is made separate so that CuraEngine can read it out for its debugging mode via the command line, without needing a complete Python interpreter. * `label` (string): The human-readable name for the setting. This label is translated. * `description` (string): A longer description of what the setting does when you change it. This description is translated as well. * `type` (string): The type of value that this setting contains. Allowed types are: `bool`, `str`, `float`, `int`, `enum`, `category`, `[int]`, `vec3`, `polygon` and `polygons`. @@ -30,4 +30,4 @@ Each setting in Cura has a number of properties. It's not just a key and a value * `is_uuid` (optional boolean): Whether or not this setting indicates a UUID-4. If it is, the setting will indicate an error if it's not in the correct format. Only applies to string-type settings. * `regex_blacklist_pattern` (optional string): A regular expression, where if the setting value matches with this regular expression, it gets an error state. Only applies to string-type settings. * `error_value` (optional): If the setting value is equal to this value, it will show a setting error. This is used to display errors for non-numerical settings such as checkboxes. -* `warning_value` (optional): If the setting value is equal to this value, it will show a setting warning. This is used to display warnings for non-numerical settings such as checkboxes. \ No newline at end of file +* `warning_value` (optional): If the setting value is equal to this value, it will show a setting warning. This is used to display warnings for non-numerical settings such as checkboxes. -- cgit v1.2.3 From 22867d6984fdedde813c9f22b53a7d70b189df9d Mon Sep 17 00:00:00 2001 From: digitalfrost Date: Fri, 12 Aug 2022 09:20:10 +0200 Subject: settings_properties.md: reformat text Reformat text to make it easier to read. Breakup setting descriptions into separate lines. --- docs/profiles/setting_properties.md | 101 ++++++++++++++++++++++++++---------- 1 file changed, 73 insertions(+), 28 deletions(-) diff --git a/docs/profiles/setting_properties.md b/docs/profiles/setting_properties.md index 8138bd77ff..99eb814721 100644 --- a/docs/profiles/setting_properties.md +++ b/docs/profiles/setting_properties.md @@ -2,32 +2,77 @@ Setting Properties ==== Each setting in Cura has a number of properties. It's not just a key and a value. This page lists the properties that a setting can define. -* `key` (string): The identifier by which the setting is referenced. This is not a human-readable name, but just a reference string, such as `layer_height_0`. Typically these are named with the most significant category first, in order to sort them better, such as `material_print_temperature`. This is not actually a real property but just an identifier; it can't be changed. -* `value` (optional): The current value of the setting. This can be a function, an arbitrary Python expression that depends on the values of other settings. If it's not present, the `default_value` is used. -* `default_value`: A default value for the setting if `value` is undefined. This property is required. It can't be a Python expression, but it can be any JSON type. This is made separate so that CuraEngine can read it out for its debugging mode via the command line, without needing a complete Python interpreter. -* `label` (string): The human-readable name for the setting. This label is translated. -* `description` (string): A longer description of what the setting does when you change it. This description is translated as well. -* `type` (string): The type of value that this setting contains. Allowed types are: `bool`, `str`, `float`, `int`, `enum`, `category`, `[int]`, `vec3`, `polygon` and `polygons`. +* `key` (string): The identifier by which the setting is referenced. + This is not a human-readable name, but just a reference string, such as `layer_height_0`. + Typically these are named with the most significant category first, in order to sort them better, such as `material_print_temperature`. + This is not actually a real property but just an identifier; it can't be changed. +* `value` (optional): The current value of the setting. + This can be a function (an arbitrary Python expression) that depends on the values of other settings. + If it's not present, the `default_value` is used. +* `default_value`: A default value for the setting if `value` is undefined. + This property is required. + It can't be a Python expression, but it can be any JSON type. + This is made separate so that CuraEngine can read it out for its debugging mode via the command line, without needing a complete Python interpreter. +* `label` (string): The human-readable name for the setting. + This label is translated. +* `description` (string): A longer description of what the setting does when you change it. + This description is translated as well. +* `type` (string): The type of value that this setting contains. + Allowed types are: `bool`, `str`, `float`, `int`, `enum`, `category`, `[int]`, `vec3`, `polygon` and `polygons`. * `unit` (optional string): A unit that is displayed at the right-hand side of the text field where the user enters the setting value. -* `resolve` (optional string): A Python expression that resolves disagreements for global settings if multiple per-extruder profiles define different values for a setting. Typically this takes the values for the setting from all stacks and computes one final value for it that will be used for the global setting. For instance, the `resolve` function for the build plate temperature is `max(extruderValues('material_bed_temperature')`, meaning that it will use the hottest bed temperature of all materials of the extruders in use. -* `limit_to_extruder` (optional): A Python expression that indicates which extruder a setting will be obtained from. This is used for settings that may be extruder-specific but the extruder is not necessarily the current extruder. For instance, support settings need to be evaluated for the support extruder. Infill settings need to be evaluated for the infill extruder if the infill extruder is changed. -* `enabled` (optional string or boolean): Whether the setting can currently be made visible for the user. This can be a simple true/false, or a Python expression that depends on other settings. Typically used for settings that don't apply when another setting is disabled, such as to hide the support settings if support is disabled. -* `minimum_value` (optional): The lowest acceptable value for this setting. If it's any lower, Cura will not allow the user to slice. By convention this is used to prevent setting values that are technically or physically impossible, such as a layer height of 0mm. This property only applies to numerical settings. -* `maximum_value` (optional): The highest acceptable value for this setting. If it's any higher, Cura will not allow the user to slice. By convention this is used to prevent setting values that are technically or physically impossible, such as a support overhang angle of more than 90 degrees. This property only applies to numerical settings. -* `minimum_value_warning` (optional): The threshold under which a warning is displayed to the user. By convention this is used to indicate that it will probably not print very nicely with such a low setting value. This property only applies to numerical settings. -* `maximum_value_warning` (optional): The threshold above which a warning is displayed to the user. By convention this is used to indicate that it will probably not print very nicely with such a high setting value. This property only applies to numerical settings. -* `settable_globally` (optional boolean): Whether the setting can be changed globally. For some mesh-type settings such as `support_mesh` this doesn't make sense, so those can't be changed globally. They are not displayed in the main settings list then. -* `settable_per_meshgroup` (optional boolean): Whether a setting can be changed per group of meshes. Currently unused in Cura. -* `settable_per_extruder` (optional boolean): Whether a setting can be changed per extruder. Some settings, like the build plate temperature, can't be adjusted separately for each extruder. An icon is shown in the interface to indicate this. If the user changes these settings they are stored in the global stack. -* `settable_per_mesh` (optional boolean): Whether a setting can be changed per mesh. The settings that can be changed per mesh are shown in the list of available settings in the per-object settings tool. -* `children` (optional list): A list of child settings. These are displayed with an indentation. If all child settings are overridden by the user, the parent setting gets greyed out to indicate that the parent setting has no effect any more. This is not strictly always the case though, because that would depend on the inheritance functions in the `value`. -* `icon` (optional string): A path to an icon to be displayed. Only applies to setting categories. -* `allow_empty` (optional bool): Whether the setting is allowed to be empty. If it's not, this will be treated as a setting error and Cura will not allow the user to slice. Only applies to string-type settings. -* `warning_description` (optional string): A warning message to display when the setting has a warning value. This is currently unused by Cura. -* `error_description` (optional string): An error message to display when the setting has an error value. This is currently unused by Cura. -* `options` (dictionary): A list of values that the user can choose from. The keys of this dictionary are keys that CuraEngine identifies the option with. The values are human-readable strings and will be translated. Only applies to (and only required for) enum-type settings. -* `comments` (optional string): Comments to other programmers about the setting. This is not used by Cura. -* `is_uuid` (optional boolean): Whether or not this setting indicates a UUID-4. If it is, the setting will indicate an error if it's not in the correct format. Only applies to string-type settings. -* `regex_blacklist_pattern` (optional string): A regular expression, where if the setting value matches with this regular expression, it gets an error state. Only applies to string-type settings. -* `error_value` (optional): If the setting value is equal to this value, it will show a setting error. This is used to display errors for non-numerical settings such as checkboxes. -* `warning_value` (optional): If the setting value is equal to this value, it will show a setting warning. This is used to display warnings for non-numerical settings such as checkboxes. +* `resolve` (optional string): A Python expression that resolves disagreements for global settings if multiple per-extruder profiles define different values for a setting. + Typically this takes the values for the setting from all stacks and computes one final value for it that will be used for the global setting. For instance, the `resolve` function for the build plate temperature is `max(extruderValues('material_bed_temperature')`, meaning that it will use the hottest bed temperature of all materials of the extruders in use. +* `limit_to_extruder` (optional): A Python expression that indicates which extruder a setting will be obtained from. + This is used for settings that may be extruder-specific but the extruder is not necessarily the current extruder. For instance, support settings need to be evaluated for the support extruder. Infill settings need to be evaluated for the infill extruder if the infill extruder is changed. +* `enabled` (optional string or boolean): Whether the setting can currently be made visible for the user. + This can be a simple true/false, or a Python expression that depends on other settings. + Typically used for settings that don't apply when another setting is disabled, such as to hide the support settings if support is disabled. +* `minimum_value` (optional): The lowest acceptable value for this setting. + If it's any lower, Cura will not allow the user to slice. + By convention this is used to prevent setting values that are technically or physically impossible, such as a layer height of 0mm. + This property only applies to numerical settings. +* `maximum_value` (optional): The highest acceptable value for this setting. + If it's any higher, Cura will not allow the user to slice. + By convention this is used to prevent setting values that are technically or physically impossible, such as a support overhang angle of more than 90 degrees. + This property only applies to numerical settings. +* `minimum_value_warning` (optional): The threshold under which a warning is displayed to the user. + By convention this is used to indicate that it will probably not print very nicely with such a low setting value. + This property only applies to numerical settings. +* `maximum_value_warning` (optional): The threshold above which a warning is displayed to the user. + By convention this is used to indicate that it will probably not print very nicely with such a high setting value. + This property only applies to numerical settings. +* `settable_globally` (optional boolean): Whether the setting can be changed globally. + For some mesh-type settings such as `support_mesh` this doesn't make sense, so those can't be changed globally. They are not displayed in the main settings list then. +* `settable_per_meshgroup` (optional boolean): Whether a setting can be changed per group of meshes. + Currently unused in Cura. +* `settable_per_extruder` (optional boolean): Whether a setting can be changed per extruder. + Some settings, like the build plate temperature, can't be adjusted separately for each extruder. An icon is shown in the interface to indicate this. + If the user changes these settings they are stored in the global stack. +* `settable_per_mesh` (optional boolean): Whether a setting can be changed per mesh. + The settings that can be changed per mesh are shown in the list of available settings in the per-object settings tool. +* `children` (optional list): A list of child settings. + These are displayed with an indentation. If all child settings are overridden by the user, the parent setting gets greyed out to indicate that the parent setting has no effect any more. This is not strictly always the case though, because that would depend on the inheritance functions in the `value`. +* `icon` (optional string): A path to an icon to be displayed. + Only applies to setting categories. +* `allow_empty` (optional bool): Whether the setting is allowed to be empty. + If it's not, this will be treated as a setting error and Cura will not allow the user to slice. + Only applies to string-type settings. +* `warning_description` (optional string): A warning message to display when the setting has a warning value. + This is currently unused by Cura. +* `error_description` (optional string): An error message to display when the setting has an error value. + This is currently unused by Cura. +* `options` (dictionary): A list of values that the user can choose from. + The keys of this dictionary are keys that CuraEngine identifies the option with. + The values are human-readable strings and will be translated. + Only applies to (and only required for) enum-type settings. +* `comments` (optional string): Comments to other programmers about the setting. + This is not used by Cura. +* `is_uuid` (optional boolean): Whether or not this setting indicates a UUID-4. + If it is, the setting will indicate an error if it's not in the correct format. + Only applies to string-type settings. +* `regex_blacklist_pattern` (optional string): A regular expression, where if the setting value matches with this regular expression, it gets an error state. + Only applies to string-type settings. +* `error_value` (optional): If the setting value is equal to this value, it will show a setting error. + This is used to display errors for non-numerical settings such as checkboxes. +* `warning_value` (optional): If the setting value is equal to this value, it will show a setting warning. + This is used to display warnings for non-numerical settings such as checkboxes. -- cgit v1.2.3 From f9f7aae908b0235eda48db529cf27d1a9c06b9b9 Mon Sep 17 00:00:00 2001 From: digitalfrost Date: Fri, 12 Aug 2022 09:27:17 +0200 Subject: Use italics for "unused by Cura" Use italics to emphasize "This is currently unused by Cura". --- docs/profiles/setting_properties.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/profiles/setting_properties.md b/docs/profiles/setting_properties.md index 99eb814721..71cbe69155 100644 --- a/docs/profiles/setting_properties.md +++ b/docs/profiles/setting_properties.md @@ -58,15 +58,15 @@ Each setting in Cura has a number of properties. It's not just a key and a value If it's not, this will be treated as a setting error and Cura will not allow the user to slice. Only applies to string-type settings. * `warning_description` (optional string): A warning message to display when the setting has a warning value. - This is currently unused by Cura. + *This is currently unused by Cura.* * `error_description` (optional string): An error message to display when the setting has an error value. - This is currently unused by Cura. + *This is currently unused by Cura.* * `options` (dictionary): A list of values that the user can choose from. The keys of this dictionary are keys that CuraEngine identifies the option with. The values are human-readable strings and will be translated. Only applies to (and only required for) enum-type settings. * `comments` (optional string): Comments to other programmers about the setting. - This is not used by Cura. + *This is not used by Cura.* * `is_uuid` (optional boolean): Whether or not this setting indicates a UUID-4. If it is, the setting will indicate an error if it's not in the correct format. Only applies to string-type settings. -- cgit v1.2.3 From 56f5d6b60df626c0d692e85a3ad95af8149540f4 Mon Sep 17 00:00:00 2001 From: digitalfrost Date: Fri, 12 Aug 2022 09:29:19 +0200 Subject: Improve stylistic consistency Always use "This is currently unused by Cura" so that the settings descriptions are more coherent. --- docs/profiles/setting_properties.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/profiles/setting_properties.md b/docs/profiles/setting_properties.md index 71cbe69155..1f5e004478 100644 --- a/docs/profiles/setting_properties.md +++ b/docs/profiles/setting_properties.md @@ -66,7 +66,7 @@ Each setting in Cura has a number of properties. It's not just a key and a value The values are human-readable strings and will be translated. Only applies to (and only required for) enum-type settings. * `comments` (optional string): Comments to other programmers about the setting. - *This is not used by Cura.* + *This is currently unused by Cura.* * `is_uuid` (optional boolean): Whether or not this setting indicates a UUID-4. If it is, the setting will indicate an error if it's not in the correct format. Only applies to string-type settings. -- cgit v1.2.3 From a40b0da63db14c5cf025cc2f89b3885f3dbc48cd Mon Sep 17 00:00:00 2001 From: digitalfrost Date: Fri, 12 Aug 2022 09:36:19 +0200 Subject: settings_properties.md: correct indentation Correct indentation and fix and inconsistent use of "unused by Cura" --- docs/profiles/setting_properties.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/profiles/setting_properties.md b/docs/profiles/setting_properties.md index 1f5e004478..3b3bbb38c2 100644 --- a/docs/profiles/setting_properties.md +++ b/docs/profiles/setting_properties.md @@ -11,7 +11,7 @@ Each setting in Cura has a number of properties. It's not just a key and a value If it's not present, the `default_value` is used. * `default_value`: A default value for the setting if `value` is undefined. This property is required. - It can't be a Python expression, but it can be any JSON type. + It can't be a Python expression, but it can be any JSON type. This is made separate so that CuraEngine can read it out for its debugging mode via the command line, without needing a complete Python interpreter. * `label` (string): The human-readable name for the setting. This label is translated. @@ -36,15 +36,15 @@ Each setting in Cura has a number of properties. It's not just a key and a value By convention this is used to prevent setting values that are technically or physically impossible, such as a support overhang angle of more than 90 degrees. This property only applies to numerical settings. * `minimum_value_warning` (optional): The threshold under which a warning is displayed to the user. - By convention this is used to indicate that it will probably not print very nicely with such a low setting value. + By convention this is used to indicate that it will probably not print very nicely with such a low setting value. This property only applies to numerical settings. * `maximum_value_warning` (optional): The threshold above which a warning is displayed to the user. By convention this is used to indicate that it will probably not print very nicely with such a high setting value. This property only applies to numerical settings. * `settable_globally` (optional boolean): Whether the setting can be changed globally. For some mesh-type settings such as `support_mesh` this doesn't make sense, so those can't be changed globally. They are not displayed in the main settings list then. -* `settable_per_meshgroup` (optional boolean): Whether a setting can be changed per group of meshes. - Currently unused in Cura. +* `settable_per_meshgroup` (optional boolean): Whether a setting can be changed per group of meshes. + *This is currently unused by Cura.* * `settable_per_extruder` (optional boolean): Whether a setting can be changed per extruder. Some settings, like the build plate temperature, can't be adjusted separately for each extruder. An icon is shown in the interface to indicate this. If the user changes these settings they are stored in the global stack. -- cgit v1.2.3 From 09a8a70739507560ffa73085208e33c835374212 Mon Sep 17 00:00:00 2001 From: digitalfrost Date: Tue, 23 Aug 2022 15:32:10 +0200 Subject: setting_properties.md: use indented bullet points Use indented bullet points for the text about the properties. --- docs/profiles/setting_properties.md | 92 ++++++++++++++++++------------------- 1 file changed, 46 insertions(+), 46 deletions(-) diff --git a/docs/profiles/setting_properties.md b/docs/profiles/setting_properties.md index 3b3bbb38c2..cd50fc1e2b 100644 --- a/docs/profiles/setting_properties.md +++ b/docs/profiles/setting_properties.md @@ -3,76 +3,76 @@ Setting Properties Each setting in Cura has a number of properties. It's not just a key and a value. This page lists the properties that a setting can define. * `key` (string): The identifier by which the setting is referenced. - This is not a human-readable name, but just a reference string, such as `layer_height_0`. - Typically these are named with the most significant category first, in order to sort them better, such as `material_print_temperature`. - This is not actually a real property but just an identifier; it can't be changed. + * This is not a human-readable name, but just a reference string, such as `layer_height_0`. + * This is not actually a real property but just an identifier; it can't be changed. + * Typically these are named with the most significant category first, in order to sort them better, such as `material_print_temperature`. * `value` (optional): The current value of the setting. - This can be a function (an arbitrary Python expression) that depends on the values of other settings. - If it's not present, the `default_value` is used. + * This can be a function (an arbitrary Python expression) that depends on the values of other settings. + * If it's not present, the `default_value` is used. * `default_value`: A default value for the setting if `value` is undefined. - This property is required. - It can't be a Python expression, but it can be any JSON type. - This is made separate so that CuraEngine can read it out for its debugging mode via the command line, without needing a complete Python interpreter. + * This property is required. + * It can't be a Python expression, but it can be any JSON type. + * This is made separate so that CuraEngine can read it out for its debugging mode via the command line, without needing a complete Python interpreter. * `label` (string): The human-readable name for the setting. - This label is translated. + * This label is translated. * `description` (string): A longer description of what the setting does when you change it. - This description is translated as well. + * This description is translated. * `type` (string): The type of value that this setting contains. - Allowed types are: `bool`, `str`, `float`, `int`, `enum`, `category`, `[int]`, `vec3`, `polygon` and `polygons`. + * Allowed types are: `bool`, `str`, `float`, `int`, `enum`, `category`, `[int]`, `vec3`, `polygon` and `polygons`. * `unit` (optional string): A unit that is displayed at the right-hand side of the text field where the user enters the setting value. * `resolve` (optional string): A Python expression that resolves disagreements for global settings if multiple per-extruder profiles define different values for a setting. - Typically this takes the values for the setting from all stacks and computes one final value for it that will be used for the global setting. For instance, the `resolve` function for the build plate temperature is `max(extruderValues('material_bed_temperature')`, meaning that it will use the hottest bed temperature of all materials of the extruders in use. + * Typically this takes the values for the setting from all stacks and computes one final value for it that will be used for the global setting. For instance, the `resolve` function for the build plate temperature is `max(extruderValues('material_bed_temperature')`, meaning that it will use the hottest bed temperature of all materials of the extruders in use. * `limit_to_extruder` (optional): A Python expression that indicates which extruder a setting will be obtained from. - This is used for settings that may be extruder-specific but the extruder is not necessarily the current extruder. For instance, support settings need to be evaluated for the support extruder. Infill settings need to be evaluated for the infill extruder if the infill extruder is changed. + * This is used for settings that may be extruder-specific but the extruder is not necessarily the current extruder. For instance, support settings need to be evaluated for the support extruder. Infill settings need to be evaluated for the infill extruder if the infill extruder is changed. * `enabled` (optional string or boolean): Whether the setting can currently be made visible for the user. - This can be a simple true/false, or a Python expression that depends on other settings. - Typically used for settings that don't apply when another setting is disabled, such as to hide the support settings if support is disabled. + * This can be a simple true/false, or a Python expression that depends on other settings. + * Typically used for settings that don't apply when another setting is disabled, such as to hide the support settings if support is disabled. * `minimum_value` (optional): The lowest acceptable value for this setting. - If it's any lower, Cura will not allow the user to slice. - By convention this is used to prevent setting values that are technically or physically impossible, such as a layer height of 0mm. - This property only applies to numerical settings. + * If it's any lower, Cura will not allow the user to slice. + * This property only applies to numerical settings. + * By convention this is used to prevent setting values that are technically or physically impossible, such as a layer height of 0mm. * `maximum_value` (optional): The highest acceptable value for this setting. - If it's any higher, Cura will not allow the user to slice. - By convention this is used to prevent setting values that are technically or physically impossible, such as a support overhang angle of more than 90 degrees. - This property only applies to numerical settings. + * If it's any higher, Cura will not allow the user to slice. + * This property only applies to numerical settings. + * By convention this is used to prevent setting values that are technically or physically impossible, such as a support overhang angle of more than 90 degrees. * `minimum_value_warning` (optional): The threshold under which a warning is displayed to the user. - By convention this is used to indicate that it will probably not print very nicely with such a low setting value. - This property only applies to numerical settings. -* `maximum_value_warning` (optional): The threshold above which a warning is displayed to the user. - By convention this is used to indicate that it will probably not print very nicely with such a high setting value. - This property only applies to numerical settings. + * This property only applies to numerical settings. + * By convention this is used to indicate that it will probably not print very nicely with such a low setting value. +* `maximum_value_warning` (optional): The threshold above which a warning is displayed to the user. + * This property only applies to numerical settings. + * By convention this is used to indicate that it will probably not print very nicely with such a high setting value. * `settable_globally` (optional boolean): Whether the setting can be changed globally. - For some mesh-type settings such as `support_mesh` this doesn't make sense, so those can't be changed globally. They are not displayed in the main settings list then. + * For some mesh-type settings such as `support_mesh` this doesn't make sense, so those can't be changed globally. They are not displayed in the main settings list then. * `settable_per_meshgroup` (optional boolean): Whether a setting can be changed per group of meshes. - *This is currently unused by Cura.* + * *This is currently unused by Cura.* * `settable_per_extruder` (optional boolean): Whether a setting can be changed per extruder. - Some settings, like the build plate temperature, can't be adjusted separately for each extruder. An icon is shown in the interface to indicate this. - If the user changes these settings they are stored in the global stack. + * Some settings, like the build plate temperature, can't be adjusted separately for each extruder. An icon is shown in the interface to indicate this. + * If the user changes these settings they are stored in the global stack. * `settable_per_mesh` (optional boolean): Whether a setting can be changed per mesh. - The settings that can be changed per mesh are shown in the list of available settings in the per-object settings tool. + * The settings that can be changed per mesh are shown in the list of available settings in the per-object settings tool. * `children` (optional list): A list of child settings. - These are displayed with an indentation. If all child settings are overridden by the user, the parent setting gets greyed out to indicate that the parent setting has no effect any more. This is not strictly always the case though, because that would depend on the inheritance functions in the `value`. + * These are displayed with an indentation. If all child settings are overridden by the user, the parent setting gets greyed out to indicate that the parent setting has no effect any more. This is not strictly always the case though, because that would depend on the inheritance functions in the `value`. * `icon` (optional string): A path to an icon to be displayed. - Only applies to setting categories. + * Only applies to setting categories. * `allow_empty` (optional bool): Whether the setting is allowed to be empty. - If it's not, this will be treated as a setting error and Cura will not allow the user to slice. - Only applies to string-type settings. + * If it's not, this will be treated as a setting error and Cura will not allow the user to slice. + * Only applies to string-type settings. * `warning_description` (optional string): A warning message to display when the setting has a warning value. - *This is currently unused by Cura.* + * *This is currently unused by Cura.* * `error_description` (optional string): An error message to display when the setting has an error value. - *This is currently unused by Cura.* + * *This is currently unused by Cura.* * `options` (dictionary): A list of values that the user can choose from. - The keys of this dictionary are keys that CuraEngine identifies the option with. - The values are human-readable strings and will be translated. - Only applies to (and only required for) enum-type settings. + * The keys of this dictionary are keys that CuraEngine identifies the option with. + * The values are human-readable strings and will be translated. + * Only applies to (and only required for) enum-type settings. * `comments` (optional string): Comments to other programmers about the setting. - *This is currently unused by Cura.* + * *This is currently unused by Cura.* * `is_uuid` (optional boolean): Whether or not this setting indicates a UUID-4. - If it is, the setting will indicate an error if it's not in the correct format. - Only applies to string-type settings. + * If it is, the setting will indicate an error if it's not in the correct format. + * Only applies to string-type settings. * `regex_blacklist_pattern` (optional string): A regular expression, where if the setting value matches with this regular expression, it gets an error state. - Only applies to string-type settings. + * Only applies to string-type settings. * `error_value` (optional): If the setting value is equal to this value, it will show a setting error. - This is used to display errors for non-numerical settings such as checkboxes. + * This is used to display errors for non-numerical settings such as checkboxes. * `warning_value` (optional): If the setting value is equal to this value, it will show a setting warning. - This is used to display warnings for non-numerical settings such as checkboxes. + * This is used to display warnings for non-numerical settings such as checkboxes. -- cgit v1.2.3 From 77cc7787e3444ad30a314ba2642cfadd4a33f564 Mon Sep 17 00:00:00 2001 From: digitalfrost Date: Tue, 23 Aug 2022 15:42:19 +0200 Subject: setting_properties.md: Use bold Use bold for the first part of the description of the property --- docs/profiles/setting_properties.md | 58 ++++++++++++++++++------------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/docs/profiles/setting_properties.md b/docs/profiles/setting_properties.md index cd50fc1e2b..27a0d17c4d 100644 --- a/docs/profiles/setting_properties.md +++ b/docs/profiles/setting_properties.md @@ -2,77 +2,77 @@ Setting Properties ==== Each setting in Cura has a number of properties. It's not just a key and a value. This page lists the properties that a setting can define. -* `key` (string): The identifier by which the setting is referenced. +* `key` (string): __The identifier by which the setting is referenced.__ * This is not a human-readable name, but just a reference string, such as `layer_height_0`. * This is not actually a real property but just an identifier; it can't be changed. * Typically these are named with the most significant category first, in order to sort them better, such as `material_print_temperature`. -* `value` (optional): The current value of the setting. +* `value` (optional): __The current value of the setting.__ * This can be a function (an arbitrary Python expression) that depends on the values of other settings. * If it's not present, the `default_value` is used. -* `default_value`: A default value for the setting if `value` is undefined. +* `default_value`: __A default value for the setting if `value` is undefined.__ * This property is required. * It can't be a Python expression, but it can be any JSON type. * This is made separate so that CuraEngine can read it out for its debugging mode via the command line, without needing a complete Python interpreter. -* `label` (string): The human-readable name for the setting. +* `label` (string): __The human-readable name for the setting.__ * This label is translated. -* `description` (string): A longer description of what the setting does when you change it. +* `description` (string): __A longer description of what the setting does when you change it.__ * This description is translated. -* `type` (string): The type of value that this setting contains. +* `type` (string): __The type of value that this setting contains.__ * Allowed types are: `bool`, `str`, `float`, `int`, `enum`, `category`, `[int]`, `vec3`, `polygon` and `polygons`. -* `unit` (optional string): A unit that is displayed at the right-hand side of the text field where the user enters the setting value. -* `resolve` (optional string): A Python expression that resolves disagreements for global settings if multiple per-extruder profiles define different values for a setting. +* `unit` (optional string): __A unit that is displayed at the right-hand side of the text field where the user enters the setting value.__ +* `resolve` (optional string): __A Python expression that resolves disagreements for global settings if multiple per-extruder profiles define different values for a setting.__ * Typically this takes the values for the setting from all stacks and computes one final value for it that will be used for the global setting. For instance, the `resolve` function for the build plate temperature is `max(extruderValues('material_bed_temperature')`, meaning that it will use the hottest bed temperature of all materials of the extruders in use. -* `limit_to_extruder` (optional): A Python expression that indicates which extruder a setting will be obtained from. +* `limit_to_extruder` (optional): __A Python expression that indicates which extruder a setting will be obtained from.__ * This is used for settings that may be extruder-specific but the extruder is not necessarily the current extruder. For instance, support settings need to be evaluated for the support extruder. Infill settings need to be evaluated for the infill extruder if the infill extruder is changed. -* `enabled` (optional string or boolean): Whether the setting can currently be made visible for the user. +* `enabled` (optional string or boolean): __Whether the setting can currently be made visible for the user.__ * This can be a simple true/false, or a Python expression that depends on other settings. * Typically used for settings that don't apply when another setting is disabled, such as to hide the support settings if support is disabled. -* `minimum_value` (optional): The lowest acceptable value for this setting. +* `minimum_value` (optional): __The lowest acceptable value for this setting.__ * If it's any lower, Cura will not allow the user to slice. * This property only applies to numerical settings. * By convention this is used to prevent setting values that are technically or physically impossible, such as a layer height of 0mm. -* `maximum_value` (optional): The highest acceptable value for this setting. +* `maximum_value` (optional): __The highest acceptable value for this setting.__ * If it's any higher, Cura will not allow the user to slice. * This property only applies to numerical settings. * By convention this is used to prevent setting values that are technically or physically impossible, such as a support overhang angle of more than 90 degrees. -* `minimum_value_warning` (optional): The threshold under which a warning is displayed to the user. +* `minimum_value_warning` (optional): __The threshold under which a warning is displayed to the user.__ * This property only applies to numerical settings. * By convention this is used to indicate that it will probably not print very nicely with such a low setting value. -* `maximum_value_warning` (optional): The threshold above which a warning is displayed to the user. +* `maximum_value_warning` (optional): __The threshold above which a warning is displayed to the user.__ * This property only applies to numerical settings. * By convention this is used to indicate that it will probably not print very nicely with such a high setting value. -* `settable_globally` (optional boolean): Whether the setting can be changed globally. +* `settable_globally` (optional boolean): __Whether the setting can be changed globally.__ * For some mesh-type settings such as `support_mesh` this doesn't make sense, so those can't be changed globally. They are not displayed in the main settings list then. -* `settable_per_meshgroup` (optional boolean): Whether a setting can be changed per group of meshes. +* `settable_per_meshgroup` (optional boolean): __Whether a setting can be changed per group of meshes.__ * *This is currently unused by Cura.* -* `settable_per_extruder` (optional boolean): Whether a setting can be changed per extruder. +* `settable_per_extruder` (optional boolean): __Whether a setting can be changed per extruder.__ * Some settings, like the build plate temperature, can't be adjusted separately for each extruder. An icon is shown in the interface to indicate this. * If the user changes these settings they are stored in the global stack. -* `settable_per_mesh` (optional boolean): Whether a setting can be changed per mesh. +* `settable_per_mesh` (optional boolean): __Whether a setting can be changed per mesh.__ * The settings that can be changed per mesh are shown in the list of available settings in the per-object settings tool. -* `children` (optional list): A list of child settings. +* `children` (optional list): __A list of child settings.__ * These are displayed with an indentation. If all child settings are overridden by the user, the parent setting gets greyed out to indicate that the parent setting has no effect any more. This is not strictly always the case though, because that would depend on the inheritance functions in the `value`. -* `icon` (optional string): A path to an icon to be displayed. +* `icon` (optional string): __A path to an icon to be displayed.__ * Only applies to setting categories. -* `allow_empty` (optional bool): Whether the setting is allowed to be empty. +* `allow_empty` (optional bool): __Whether the setting is allowed to be empty.__ * If it's not, this will be treated as a setting error and Cura will not allow the user to slice. * Only applies to string-type settings. -* `warning_description` (optional string): A warning message to display when the setting has a warning value. +* `warning_description` (optional string): __A warning message to display when the setting has a warning value.__ * *This is currently unused by Cura.* -* `error_description` (optional string): An error message to display when the setting has an error value. +* `error_description` (optional string): __An error message to display when the setting has an error value.__ * *This is currently unused by Cura.* -* `options` (dictionary): A list of values that the user can choose from. +* `options` (dictionary): __A list of values that the user can choose from.__ * The keys of this dictionary are keys that CuraEngine identifies the option with. * The values are human-readable strings and will be translated. * Only applies to (and only required for) enum-type settings. -* `comments` (optional string): Comments to other programmers about the setting. +* `comments` (optional string): __Comments to other programmers about the setting.__ * *This is currently unused by Cura.* -* `is_uuid` (optional boolean): Whether or not this setting indicates a UUID-4. +* `is_uuid` (optional boolean): __Whether or not this setting indicates a UUID-4.__ * If it is, the setting will indicate an error if it's not in the correct format. * Only applies to string-type settings. -* `regex_blacklist_pattern` (optional string): A regular expression, where if the setting value matches with this regular expression, it gets an error state. +* `regex_blacklist_pattern` (optional string): __A regular expression, where if the setting value matches with this regular expression, it gets an error state.__ * Only applies to string-type settings. -* `error_value` (optional): If the setting value is equal to this value, it will show a setting error. +* `error_value` (optional): __If the setting value is equal to this value, it will show a setting error.__ * This is used to display errors for non-numerical settings such as checkboxes. -* `warning_value` (optional): If the setting value is equal to this value, it will show a setting warning. +* `warning_value` (optional): __If the setting value is equal to this value, it will show a setting warning.__ * This is used to display warnings for non-numerical settings such as checkboxes. -- cgit v1.2.3