github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2024-12-21 06:03:42 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
61f23b2d65
discourse/spec/fixtures/theme_locales/objects_settings/en.yaml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

18 lines
456 B
YAML
Raw Normal View History

DEV: Support description for properties in objects schema (#26172) Why this change? When editing a objects typed theme setting, the input fields which are rendered should include a description so that the user knows the purpose of the field which they are changing. What does this change do? This change adds support for adding description to each property in the schema for an object by following a given convention in the locale file. For a schema like this: ``` objects_setting: type: objects schema: name: section properties: name: type: string required: true links: type: objects schema: name: link properties: name: type: string required: true validations: max_length: 20 url: type: string ``` Description for each property in the object can be added like so: ``` en: theme_metadata: settings: objects_setting: description: <description> for the setting schema: properties: name: <description for the name property> links: name: <description for the name property in link> url: <description for the url property in link> ``` If the a description is not present, the input field will simply not have an description. Also note that a description for a theme setting can now be added like so: ``` en: theme_metadata: settings: some_other_setting: <This will be used as the description> objects_setting: description: <This will also be used as the description> ```
2024-03-15 07:47:42 +08:00
en:
theme_metadata:
settings:
objects_setting:
description: "This is a description for objects setting"
schema:
properties:
DEV: Support translations for property labels in objects schema editor (#26362) Why this change? In cdba86459877987f52def4bcfeba5c7bef7de407, we added support for adding a description which will be displayed under the input of each property on the client side. Currently this convention in the locale file is followed: ``` en: theme_metadata: settings: objects_setting: description: <description> for the setting schema: properties: name: <description for the name property> links: name: <description for the name property in link> url: <description for the url property in link> ``` Since we now want to allow the label to be translated as well, we will be changing the convention to the following: ``` en: theme_metadata: settings: objects_setting: description: <description> for the setting schema: properties: name: label: <label for the name property> description: <description for the name property> links: name: label: <label for the name property> description: <description for the name property in link> url: label: <label for the url property> description: <description for the url property in link> ``` If the locale file does not provide a `label` key under the property's name, the client side will just display the property's name as the label for the input field.
2024-03-28 10:53:51 +08:00
name:
label: Name
description: "Section Name"
DEV: Support description for properties in objects schema (#26172) Why this change? When editing a objects typed theme setting, the input fields which are rendered should include a description so that the user knows the purpose of the field which they are changing. What does this change do? This change adds support for adding description to each property in the schema for an object by following a given convention in the locale file. For a schema like this: ``` objects_setting: type: objects schema: name: section properties: name: type: string required: true links: type: objects schema: name: link properties: name: type: string required: true validations: max_length: 20 url: type: string ``` Description for each property in the object can be added like so: ``` en: theme_metadata: settings: objects_setting: description: <description> for the setting schema: properties: name: <description for the name property> links: name: <description for the name property in link> url: <description for the url property in link> ``` If the a description is not present, the input field will simply not have an description. Also note that a description for a theme setting can now be added like so: ``` en: theme_metadata: settings: some_other_setting: <This will be used as the description> objects_setting: description: <This will also be used as the description> ```
2024-03-15 07:47:42 +08:00
links:
DEV: Support translations for property labels in objects schema editor (#26362) Why this change? In cdba86459877987f52def4bcfeba5c7bef7de407, we added support for adding a description which will be displayed under the input of each property on the client side. Currently this convention in the locale file is followed: ``` en: theme_metadata: settings: objects_setting: description: <description> for the setting schema: properties: name: <description for the name property> links: name: <description for the name property in link> url: <description for the url property in link> ``` Since we now want to allow the label to be translated as well, we will be changing the convention to the following: ``` en: theme_metadata: settings: objects_setting: description: <description> for the setting schema: properties: name: label: <label for the name property> description: <description for the name property> links: name: label: <label for the name property> description: <description for the name property in link> url: label: <label for the url property> description: <description for the url property in link> ``` If the locale file does not provide a `label` key under the property's name, the client side will just display the property's name as the label for the input field.
2024-03-28 10:53:51 +08:00
name:
label: Name
description: "Name of the link"
url:
label: URL
description: "URL of the link"
Reference in New Issue Copy Permalink