Skip to content

Commit d0a3af6

Browse files
committed
Merge branch 'forms/release-13.3-14.1' of https://github.com/AndyButland/UmbracoDocs into forms/release-13.3-14.1
2 parents aba1801 + c57ba60 commit d0a3af6

File tree

13 files changed

+50
-47
lines changed

13 files changed

+50
-47
lines changed

13/umbraco-forms/developer/configuration/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -526,7 +526,7 @@ A custom date format can be provided in [momentjs format](https://momentjscom.re
526526

527527
#### DatePickerFormatForValidation
528528

529-
If a custom date format is provided it will be used on the client-side. A matching string in [C# date format](https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings) should be provided, in order that server-side validation will match the expected format of the entry.
529+
If a custom date format is provided it will be used on the client-side. A matching string in [C# date format](https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings) should be provided, so that server-side validation will match the expected format of the entry.
530530

531531
### reCAPTCHA v2 field type configuration
532532

13/umbraco-forms/developer/extending/adding-a-fieldtype.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ To support this, a read-only view of the field is necessary.
114114

115115
For most fields, nothing is required here, as the default read-only display defined in the built-in `ReadOnly.cshtml` file suffices.
116116

117-
However, if you want to provide a custom read-only display for your field, you can do so by creating a second partial view. This should be named with a `.ReadOnly` suffix. For this example, we would create `FieldType.Slider.ReadOnly.cshtml`.
117+
However, if you want to provide a custom read-only display for your field, you can do so by creating a second partial view. This should be named with a `.ReadOnly` suffix. For this example, you would create `FieldType.Slider.ReadOnly.cshtml`.
118118

119119
## Umbraco backoffice view
120120

13/umbraco-forms/developer/themes.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,12 @@ If adding or amending client-side scripts, you need to copy the `Script.cshtml`
4545

4646
Umbraco Forms provides it's built-in themes as part of a Razor Class Library for ease of distribution. This can be useful for custom themes, particularly those used in multiple solutions or released as an Umbraco package.
4747

48-
From Forms 13.3 it's possible to do this for custom themes.
48+
From Forms 13.3 it is possible to do this for custom themes.
4949

50-
Firstly you'll create a new Razor Class Library project to hold the theme. You then create the necessary partial views for your theme as usual within `Views\Partials\Forms\Themes\<my-custom-theme>`.
51-
52-
You then need to provide the names of the files in your theme via an implementation of `ITheme`. For example, if only overriding a single file, your class would look like this:
50+
1. Create a new Razor Class Library project to hold the theme.
51+
2. Create the necessary Partial Views for your theme within `Views\Partials\Forms\Themes\<my-custom-theme>`.
52+
3. Provide the names of the files in your theme via an implementation of `ITheme`.
53+
* For example, if only overriding a single file, your class would look like the code snippet below:
5354

5455
```csharp
5556
using Umbraco.Forms.Core.Interfaces;
@@ -67,7 +68,7 @@ public class MyCustomTheme : ITheme
6768
}
6869
```
6970

70-
In your project that consumes the theme, you register the ones you want to use via a composer:
71+
4. Register the themes you want to use via a composer:
7172

7273
```csharp
7374
public class MyComposer : IComposer
@@ -80,11 +81,11 @@ public class MyComposer : IComposer
8081
}
8182
```
8283

83-
With that in place your theme will be picked up for selection in the theme picker. And the partial view files included will be used when rendering forms.
84+
Your theme will now be available in the Theme Picker and the partial view files will be used when rendering forms.
8485

8586
#### Email Templates
8687

87-
Email templates provided for the send email workflow can be provided in a Razor Class Library in a similar way.
88+
Email templates provided for the send email workflow can be provided in a Razor Class Library similar to the Theme files.
8889

8990
The partial view will be created in `Views\Partials\Forms\Emails`.
9091

13/umbraco-forms/release-notes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,21 @@ This section contains the release notes for Umbraco Forms 13 including all chang
2323

2424
The 13.3 release of Forms contains features that can improve the user experience of completing multi-page forms.
2525

26-
We've added the option for [editors to choose to display paging details on the forms](./editor/creating-a-form/form-settings.md#multi-page-forms). This will allow those completing forms to get a better understanding of progress as well as see details of the pages still to complete. [#281](https://github.com/umbraco/Umbraco.Forms.Issues/issues/281) [#648](https://github.com/umbraco/Umbraco.Forms.Issues/issues/648).
26+
We have added the option for [editors to choose to display paging details on the forms](./editor/creating-a-form/form-settings.md#multi-page-forms). This will allow those completing forms to get a better understanding of progress as well as see details of the pages still to be completed. [#281](https://github.com/umbraco/Umbraco.Forms.Issues/issues/281) [#648](https://github.com/umbraco/Umbraco.Forms.Issues/issues/648).
2727

28-
These can be options are enabled and configured on a per-form basis by editors in the form settings section. We also provide a [configuration based toggle for the feature as a whole](./developer/configuration/README.md#enablemultipageformsettings). In this way editors can be given access to use the feature only once the styling or theme is prepared.
28+
These options are enabled and configured by editors in the Forms settings section on a per-form basis. We also provide a [configuration-based toggle for the feature as a whole](./developer/configuration/README.md#enablemultipageformsettings). In this way, editors can be given access to use the feature only once the styling or theme is prepared.
2929

3030
##### Ship themes in Razor Class Libraries
3131

3232
Forms ships it's themes and email templates as part of a razor class library for ease of distribution. With this release we make that feature [available to your own custom themes and templates](./developer/themes.md#shipping-themes-in-a-razor-class-library) (or those created by package developers) [#795](https://github.com/umbraco/Umbraco.Forms.Issues/issues/795).
3333

3434
##### Date picker field type
3535

36-
We've also made a couple of updates to the date picker field type. The format for the field can now be provided in configuration [#1276](https://github.com/umbraco/Umbraco.Forms.Issues/issues/1276). And you can now override and localize the aria label provided for assistive technologies such as screen readers [https://github.com/umbraco/Umbraco.Forms.Issues/issues/1082](https://github.com/umbraco/Umbraco.Forms.Issues/issues/1082).
36+
We have made a couple of updates to the Date Picker field type. The format for the field can now be provided in configuration [#1276](https://github.com/umbraco/Umbraco.Forms.Issues/issues/1276). And you can now override and localize the aria-label provided for assistive technologies such as screen readers [https://github.com/umbraco/Umbraco.Forms.Issues/issues/1082](https://github.com/umbraco/Umbraco.Forms.Issues/issues/1082).
3737

3838
##### Finer grained entries permissions
3939

40-
To allow finer control over editor permissions, we've introduced a "delete entries" setting available on users and user groups. Thus you can now give editors explicit permissions to view, edit or delete entries [#1303](https://github.com/umbraco/Umbraco.Forms.Issues/issues/1303).
40+
To allow finer control over editor permissions, we have introduced a "delete entries" setting for users and user groups. Thus you can now give editors explicit permissions to view, edit, or delete entries [#1303](https://github.com/umbraco/Umbraco.Forms.Issues/issues/1303).
4141

4242
##### Other
4343

14/umbraco-forms/developer/configuration/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -523,7 +523,7 @@ A custom date format can be provided in [momentjs format](https://momentjscom.re
523523

524524
#### DatePickerFormatForValidation
525525

526-
If a custom date format is provided it will be used on the client-side. A matching string in [C# date format](https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings) should be provided, in order that server-side validation will match the expected format of the entry.
526+
If a custom date format is provided it will be used on the client-side. A matching string in [C# date format](https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings) should be provided, so that server-side validation will match the expected format of the entry.
527527

528528
### reCAPTCHA v2 field type configuration
529529

14/umbraco-forms/developer/extending/adding-a-fieldtype.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ To support this, a read-only view of the field is necessary.
133133

134134
For most fields, nothing is required here, as the default read-only display defined in the built-in `ReadOnly.cshtml` file suffices.
135135

136-
However, if you want to provide a custom read-only display for your field, you can do so by creating a second partial view. This should be named with a `.ReadOnly` suffix. For this example, we would create `FieldType.Slider.ReadOnly.cshtml`.
136+
However, if you want to provide a custom read-only display for your field, you can do so by creating a second partial view. This should be named with a `.ReadOnly` suffix. For this example, you would create `FieldType.Slider.ReadOnly.cshtml`.
137137

138138
## Field Settings
139139

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
# Property Editors
22

3-
When forms are created, editors will want to add them to pages in Umbraco. To do this they need a Document Type with a property that uses a datatype based on a form picker property editor.
3+
When forms are created, editors will want to add them to pages in Umbraco. To do this they need a Document Type with a property that uses a Data Type based on a Form Picker property editor.
44

55
Umbraco Forms provides three variations of a form picker.
66

77
<figure><img src="images/form-pickers.png" alt=""><figcaption><p>Form Pickers</p></figcaption></figure>
88

99
Most commonly used is **Form Picker (single)**. This will allow the editor to select a single form for display on page.
1010

11-
Rarely but feasibly, you'll have a requirement to present multiple forms on a page. Should this be appropriate, you can use **Form Picker (multiple)**.
11+
Rarely but feasibly, you will have a requirement to present multiple forms on a page. Should this be appropriate, you can use **Form Picker (multiple)**.
1212

1313
{% hint style="info" %}
1414
Internally this is used for presenting the list of "Allowed forms" you can select when setting up a form picker datatype.
1515
{% endhint %}
1616

17-
Finally you can provide further flexibility for the editor to select not only a form, but also the theme and redirect as well. For this you'll use the **Form Details Picker**.
17+
Finally you can provide further flexibility for the editor to select not only a form, but also the theme and redirect as well. For this you will use the **Form Details Picker**.
1818

1919
## Configuring the Data Type
2020

21-
Each property editor allows you to restrict the forms that can be chosen with the datatype. You do this by setting either or both of the list of "Allowed folders" or "Allowed forms".
21+
Each property editor allows you to restrict the forms that can be chosen with the Data Type. You do this by setting either or both of the list of "Allowed folders" or "Allowed forms".
2222

2323
<figure><img src="images/form-picker-config.png" alt=""><figcaption><p>Form Picker DataType Configuration</p></figcaption></figure>
2424

25-
THe "Form Details Picker" also allow you to select whether theme or redirect selection is available.
25+
The "Form Details Picker" also allows you to select whether a theme or redirect selection is available.
2626

2727
## Property Value Conversion
2828

29-
The type of a property based on the form picker presented in a Razor class library is as followes:
29+
The type of a property based on the Form Picker presented in a Razor class library is as follows:
3030

3131
| Option | Description |
3232
| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
@@ -36,4 +36,4 @@ The type of a property based on the form picker presented in a Razor class libra
3636

3737
## Content Delivery API Expansion
3838

39-
Each reference to a form supports expansion via the Umbraco Content Delivery API, as described [here](./ajaxforms.md#working-with-the-cms-content-delivery-api).
39+
Each reference to a form supports expansion via the Umbraco Content Delivery API, as described in the [Working with the CMS Content Delivery API](./ajaxforms.md#working-with-the-cms-content-delivery-api) article.

14/umbraco-forms/developer/themes.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,12 @@ If adding or amending client-side scripts, you need to copy the `Script.cshtml`
4646

4747
Umbraco Forms provides it's built-in themes as part of a Razor Class Library for ease of distribution. This can be useful for custom themes, particularly those used in multiple solutions or released as an Umbraco package.
4848

49-
From Forms 14.2 it's possible to do this for custom themes.
49+
From Forms 14.2 it is possible to do this for custom themes.
5050

51-
Firstly you'll create a new Razor Class Library project to hold the theme. You then create the necessary partial views for your theme as usual within `Views\Partials\Forms\Themes\<my-custom-theme>`.
52-
53-
You then need to provide the names of the files in your theme via an implementation of `ITheme`. For example, if only overriding a single file, your class would look like this:
51+
1. Create a new Razor Class Library project to hold the theme.
52+
2. Create the necessary Partial Views for your theme within `Views\Partials\Forms\Themes\<my-custom-theme>`.
53+
3. Provide the names of the files in your theme via an implementation of `ITheme`.
54+
* For example, if only overriding a single file, your class would look like the code snippet below:
5455

5556
```csharp
5657
using Umbraco.Forms.Core.Interfaces;
@@ -68,7 +69,7 @@ public class MyCustomTheme : ITheme
6869
}
6970
```
7071

71-
In your project that consumes the theme, you register the ones you want to use via a composer:
72+
4. Register the themes you want to use via a composer:
7273

7374
```csharp
7475
public class MyComposer : IComposer
@@ -81,11 +82,11 @@ public class MyComposer : IComposer
8182
}
8283
```
8384

84-
With that in place your theme will be picked up for selection in the theme picker. And the partial view files included will be used when rendering forms.
85+
Your theme will now be available in the Theme Picker and the partial view files will be used when rendering forms.
8586

8687
#### Email Templates
8788

88-
Email templates provided for the send email workflow can be provided in a Razor Class Library in a similar way.
89+
Email templates provided for the send email workflow can be provided in a Razor Class Library similar to the Themes files.
8990

9091
The partial view will be created in `Views\Partials\Forms\Emails`.
9192

14/umbraco-forms/release-notes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ This section contains the release notes for Umbraco Forms 14 including all chang
2424

2525
The 14.2 release of Forms contains features that can improve the user experience of completing multi-page forms.
2626

27-
We've added the option for [editors to choose to display paging details on the forms](./editor/creating-a-form/form-settings.md#multi-page-forms). This will allow those completing forms to get a better understanding of progress as well as see details of the pages still to complete. [#281](https://github.com/umbraco/Umbraco.Forms.Issues/issues/281) [#648](https://github.com/umbraco/Umbraco.Forms.Issues/issues/648).
27+
We have added the option for [editors to choose to display paging details on the forms](./editor/creating-a-form/form-settings.md#multi-page-forms). This will allow those completing forms to get a better understanding of progress as well as see details of the pages still to be completed. [#281](https://github.com/umbraco/Umbraco.Forms.Issues/issues/281) [#648](https://github.com/umbraco/Umbraco.Forms.Issues/issues/648).
2828

29-
These can be options are enabled and configured on a per-form basis by editors in the form settings section. We also provide a [configuration based toggle for the feature as a whole](./developer/configuration/README.md#enablemultipageformsettings). In this way editors can be given access to use the feature only once the styling or theme is prepared.
29+
These options are enabled and configured by editors in the Forms settings section on a per-form basis. We also provide a [configuration-based toggle for the feature as a whole](./developer/configuration/README.md#enablemultipageformsettings). In this way, editors can be given access to use the feature only once the styling or theme is prepared.
3030

3131
##### Form picker enhancements
3232

@@ -48,7 +48,7 @@ When creating a prevalue source based on Umbraco documents, you can now select c
4848

4949
##### Finer grained entries permissions
5050

51-
To allow finer control over editor permissions, we've introduced a "delete entries" setting available on users and user groups. Thus you can now give editors explicit permissions to view, edit or delete entries [#1303](https://github.com/umbraco/Umbraco.Forms.Issues/issues/1303).
51+
To allow finer control over editor permissions, we have introduced a "delete entries" setting for users and user groups. Thus you can now give editors explicit permissions to view, edit, or delete entries [#1303](https://github.com/umbraco/Umbraco.Forms.Issues/issues/1303).
5252

5353
##### Backoffice localization
5454

15/umbraco-forms/developer/configuration/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -516,7 +516,7 @@ A custom date format can be provided in [momentjs format](https://momentjscom.re
516516

517517
#### DatePickerFormatForValidation
518518

519-
If a custom date format is provided it will be used on the client-side. A matching string in [C# date format](https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings) should be provided, in order that server-side validation will match the expected format of the entry.
519+
If a custom date format is provided it will be used on the client side. A matching string in [C# date format](https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings) should be provided, so that server-side validation will match the expected format of the entry.
520520

521521
### reCAPTCHA v2 field type configuration
522522

0 commit comments

Comments
 (0)