Skip to content

Commit 9a248b6

Browse files
eshanrnhgitbook-bot
eshanrnh
authored and
gitbook-bot
committed
GITBOOK-67: Fixed Contributing link - v13
1 parent 2318bb8 commit 9a248b6

File tree

37 files changed

+234
-278
lines changed

37 files changed

+234
-278
lines changed

‎13/umbraco-cms/SUMMARY.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
* [Umbraco 8 Documentation](https://our.umbraco.com/documentation/)
77
* [Umbraco 7 Documentation](https://our.umbraco.com/documentation/)
88
* [Release Notes](https://our.umbraco.com/download/releases/)
9-
* [Contribute](https://docs.umbraco.com/welcome/contribute/)
9+
* [Contribute](https://docs.umbraco.com/contributing)
1010
* [Sustainability Best Practices](https://docs.umbraco.com/sustainability-best-practices/)
1111

1212
## Fundamentals

‎13/umbraco-cms/extending/health-check/guides/fixedapplicationurl.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# Health check: Fixed Application URL
2-
3-
_Check to make sure a fixed application URL is specified. This URL is for example used when sending emails from backoffice.
4-
If this is not specified in configuration, Umbraco gets the application URL from last host used to request the application_
1+
# Fixed Application Url
52

3+
_Check to make sure a fixed application URL is specified. This URL is for example used when sending emails from backoffice._\
4+
_If this is not specified in configuration, Umbraco gets the application URL from last host used to request the application_
65

76
## How to fix this health check
87

@@ -39,4 +38,7 @@ One example that can be used in production
3938
}
4039
}
4140
```
42-
{% hint style="info" %} If the site is hosted on Umbraco Cloud, changing the above configuration will have no effect. The site will always use the URL set in the`umbraco-cloud.json` file, which can not be changed. {% endhint %}
41+
42+
{% hint style="info" %}
43+
If the site is hosted on Umbraco Cloud, changing the above configuration will have no effect. The site will always use the URL set in the\`umbraco-cloud.json\` file, which can not be changed.
44+
{% endhint %}

‎13/umbraco-cms/extending/property-editors/declaring-your-property-editor.md‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,25 @@ Generally Umbraco supports two different ways to declare a property editor. Most
44

55
A property editor consists of a number of mandatory properties, and some optional ones as well. As such, the outer JSON object for the property editor has the following properties:
66

7-
| Name | Type | Required | Description |
8-
| ---- | ---- | ---- | ---- |
9-
| `alias` | string | Yes | A unique alias that identifies the property editor. |
10-
| `name` | string | Yes | The friendly name of the property editor, shown in the Umbraco backoffice. |
11-
| `editor` | object | Yes | This describes details about the editor. See the table below for further information. |
12-
| `icon` | string | No | A CSS class for the icon to be used in the **Select Editor** dialog - eg: `icon-autofill`. |
13-
| `group` | string | No | The group to place this editor in within the **Select Editor** dialog. Use a new group name or alternatively use an existing one such as **Pickers**. |
14-
| `isParameterEditor` | boolean | No | Enables the property editor as a macro parameter editor. Can be either `true` or `false` (default). |
15-
| `defaultConfig` | object | No | Provides a collection of default configuration values, in cases the property editor is not configured or is used a parameter editor (which doesn't allow configuration). The object is a key/value collection and must match the prevalue fields keys. |
7+
| Name | Type | Required | Description |
8+
| ------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
9+
| `alias` | string | Yes | A unique alias that identifies the property editor. |
10+
| `name` | string | Yes | The friendly name of the property editor, shown in the Umbraco backoffice. |
11+
| `editor` | object | Yes | This describes details about the editor. See the table below for further information. |
12+
| `icon` | string | No | A CSS class for the icon to be used in the **Select Editor** dialog - eg: `icon-autofill`. |
13+
| `group` | string | No | The group to place this editor in within the **Select Editor** dialog. Use a new group name or alternatively use an existing one such as **Pickers**. |
14+
| `isParameterEditor` | boolean | No | Enables the property editor as a macro parameter editor. Can be either `true` or `false` (default). |
15+
| `defaultConfig` | object | No | Provides a collection of default configuration values, in cases the property editor is not configured or is used a parameter editor (which doesn't allow configuration). The object is a key/value collection and must match the prevalue fields keys. |
1616

1717
The `editor` object then has the following properties:
1818

19-
| Name | Type | Required | Description |
20-
| ---- | ---- | ---- | ---- |
21-
| `view` | string | Yes | This is the full path to the HTML view for your property editor. |
22-
| `hideLabel` | bool | Yes | If set to `true`, this hides the label for the property editor when used in Umbraco on a Document Type. |
23-
| `valueType` | object | No | This is the type of data you want your property editor to save to Umbraco. Possible values are `STRING`, `JSON`, `DATETIME`, `TEXT` and `INT`. Default is `STRING`. |
24-
| `validation` | object | No | Object describing required validators on the editor. |
25-
| `isReadOnly` | boolean | No | If set to true this makes the property editor read only. |
19+
| Name | Type | Required | Description |
20+
| ------------ | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21+
| `view` | string | Yes | This is the full path to the HTML view for your property editor. |
22+
| `hideLabel` | bool | Yes | If set to `true`, this hides the label for the property editor when used in Umbraco on a Document Type. |
23+
| `valueType` | object | No | This is the type of data you want your property editor to save to Umbraco. Possible values are `STRING`, `JSON`, `DATETIME`, `TEXT` and `INT`. Default is `STRING`. |
24+
| `validation` | object | No | Object describing required validators on the editor. |
25+
| `isReadOnly` | boolean | No | If set to true this makes the property editor read only. |
2626

2727
## Using a Package Manifest
2828

@@ -157,23 +157,23 @@ Also notice how the `PropertyEditorAsset` attribute is used to load the `SirTrev
157157

158158
The [DataEditor](https://apidocs.umbraco.com/v13/csharp/api/Umbraco.Cms.Core.PropertyEditors.DataEditorAttribute.html) attribute shown in the example above is the primary component to declaring the property editor in C#. Notice that the first four properties must be set through the constructor.
159159

160-
| Name | Type | Required | Description |
161-
|----------------| ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
162-
| `Alias` | string | Yes | Gets the unique alias of the editor. |
160+
| Name | Type | Required | Description |
161+
| -------------- | --------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------- |
162+
| `Alias` | string | Yes | Gets the unique alias of the editor. |
163163
| `EditorType` | [EditorType](https://apidocs.umbraco.com/v13/csharp/api/Umbraco.Cms.Core.PropertyEditors.EditorType.html) | Yes | Gets the type of the editor. Possible values are `EditorType.PropertyValue`, `EditorType.MacroParameter` or `EditorType.Nothing`. |
164-
| `Name` | string | Yes | Gets the friendly name of the editor. |
165-
| `View` | string | Yes | Gets the view to use to render the editor. |
166-
| `ValueType` | string | No | Gets or sets the type of the edited value. |
167-
| `HideLabel` | boolean | No | Gets or sets a value indicating whether the editor should be displayed without its label. |
168-
| `Icon` | string | No | Gets or sets an optional icon. |
169-
| `Group` | string | No | Gets or sets an optional group. |
170-
| `IsDeprecated` | boolean | No | Gets or sets a value indicating whether the value editor is deprecated. |
164+
| `Name` | string | Yes | Gets the friendly name of the editor. |
165+
| `View` | string | Yes | Gets the view to use to render the editor. |
166+
| `ValueType` | string | No | Gets or sets the type of the edited value. |
167+
| `HideLabel` | boolean | No | Gets or sets a value indicating whether the editor should be displayed without its label. |
168+
| `Icon` | string | No | Gets or sets an optional icon. |
169+
| `Group` | string | No | Gets or sets an optional group. |
170+
| `IsDeprecated` | boolean | No | Gets or sets a value indicating whether the value editor is deprecated. |
171171

172172
### PropertyEditorAsset attribute
173173

174174
As shown in the C# example, the [PropertyEditorAsset](https://apidocs.umbraco.com/v13/csharp/api/Umbraco.Cms.Infrastructure.WebAssets.PropertyEditorAssetAttribute.html) attribute was used to make Umbraco load the specified JavaScript file.
175175

176-
The constructor of the attribute takes the type of the assets as the first parameter.
176+
The constructor of the attribute takes the type of the assets as the first parameter.\
177177
Possible values are either `AssetType.Javascript` or `AssetType.Css`. The second parameter is the URL of the asset.
178178

179179
### DataEditor class
@@ -285,13 +285,13 @@ A benefit of this approach (opposed to `package.manifest` files) is that we can
285285
}
286286
```
287287

288-
Both instances of `IDataType` and `PublishedDataType` have a `Configuration` property.
289-
When looking across all data types and property editors, there is no common type for the configuration, so the return value is `object`.
288+
Both instances of `IDataType` and `PublishedDataType` have a `Configuration` property.\
289+
When looking across all data types and property editors, there is no common type for the configuration, so the return value is `object`.\
290290
To get the strongly typed model, you can either cast the configuration value on your own, or use the generic `ConfigurationAs` extension method as shown above.
291291

292292
Like mentioned before, the `SirTrevorConfigurationEditor` class doesn't really do much in this example with the Sir Trevor property editor. But the **Multi Node Tree Picker** and others of Umbraco's build in property editors also override the `ToValueEditor` method.
293293

294-
This method is used when the strongly typed configuration value is converted to the model used by the Angular logic in the backoffice. So with the implementation of the [MultiNodePickerConfigurationEditor]( https://github.com/umbraco/Umbraco-CMS/blob/ade9bb73246caf25a7073f2b9e5262641a201863/src/Umbraco.Web/PropertyEditors/MultiNodePickerConfigurationEditor.cs) class, some additional configuration fields are sent along. For instance that it's a multi picker and that the ID type should be URI's. These are configuration values that the user should not be able to edit, but the property editor may still rely on them.
294+
This method is used when the strongly typed configuration value is converted to the model used by the Angular logic in the backoffice. So with the implementation of the [MultiNodePickerConfigurationEditor](https://github.com/umbraco/Umbraco-CMS/blob/ade9bb73246caf25a7073f2b9e5262641a201863/src/Umbraco.Web/PropertyEditors/MultiNodePickerConfigurationEditor.cs) class, some additional configuration fields are sent along. For instance that it's a multi picker and that the ID type should be URI's. These are configuration values that the user should not be able to edit, but the property editor may still rely on them.
295295

296296
```csharp
297297
using Umbraco.Cms.Core.IO;

‎13/umbraco-cms/extending/property-editors/full-examples-value-converters.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,10 +96,10 @@ public class ContentPickerPropertyConverter : IPropertyValueConverter
9696
}
9797
}
9898

99-
{% hint style="warning" %}
99+
<div data-gb-custom-block data-tag="hint" data-style='warning'>
100100

101101
The current implementation of XPath is suboptimal, marked as obsolete, and scheduled for removal in Umbraco 14. The replacement for ContentXPath is [IContentLastChanceFinder](../../implementation/custom-routing/README.md#last-chance-icontentfinder).
102102

103-
{% endhint %}
103+
</div>
104104

105105
```

0 commit comments

Comments
 (0)