Merge pull request #8130 from umbraco/forms/docs-codebase-audit

Update Forms 16/17/18 docs to match current codebase

Author: sofietoft

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

@@ -12,7 +12,7 @@ With Umbraco Forms it's possible to customize the functionality with various con
 
 All configuration for Umbraco Forms is held in the `appsettings.json` file found at the root of your Umbraco website. If the configuration has been customized to use another source, then the same keys and values discussed in this article can be applied there.
 
-The convention for Umbraco configuration is to have package based options stored as a child structure below the `Umbraco` element, and as a sibling of `CMS`. Forms configuration follows this pattern, i.e.:
+The convention for Umbraco configuration is to have package-based options stored as a child structure below the `Umbraco` element, and as a sibling of `CMS`. Forms configuration follows this pattern, i.e.:
 
 ```json
 {
@@ -53,6 +53,7 @@ For illustration purposes, the following structure represents the full set of op
         "PreviousPageButtonLabel": "Previous",
         "SubmitButtonLabel": "Submit",
         "MessageOnSubmit": "Thank you",
+        "MessageOnSubmitIsHtml": false,
         "StoreRecordsLocally": true,
         "AutocompleteAttribute": "",
         "DaysToRetainSubmittedRecordsFor": 0,
@@ -89,15 +90,14 @@ For illustration purposes, the following structure represents the full set of op
       "DisableRecordIndexing": false,
       "EnableFormsApi": false,
       "EnableRecordingOfIpWithFormSubmission": false,
-      "UseSemanticFieldsetRendering": false,
       "DisableClientSideValidationDependencyCheck": false,
       "DisableRelationTracking": false,
       "TrackRenderedFormsStorageMethod": "HttpContextItems",
       "EnableMultiPageFormSettings": true,
       "EnableAdvancedValidationRules": false
     },
     "Security": {
-      "DisallowedFileUploadExtensions": "config,exe,dll,asp,aspx",
+      "DisallowedFileUploadExtensions": "config,exe,dll,asp,aspx,js",
       "AllowedFileUploadExtensions": "",
       "EnableAntiForgeryToken": true,
       "SavePlainTextPasswords": false,
@@ -304,6 +304,10 @@ These settings configure the default next, previous, and submit button labels. B
 
 This allows you to configure what text is displayed when a form is submitted and is not being redirected to a different content node. Defaults to `Thank you`.
 
+#### MessageOnSubmitIsHtml
+
+This setting needs to be a `true` or `false` value. When set to `true`, the message configured in `MessageOnSubmit` is rendered as HTML. Defaults to `false`.
+
 #### StoreRecordsLocally
 
 This setting needs to be a `True` or `False` value and will allow you to toggle if form submission data should be stored in the Umbraco Forms database tables. By default this is set to `True`.
@@ -424,14 +428,6 @@ To include this information in the saved data, set this value to `true`.
 
 If recording IPs and your site is behind a proxy, load balancer or CDN, we recommend using [ASP.NET's forwarded headers middleware](https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/proxy-load-balancer?view=aspnetcore-7.0) to ensure the correct value for the client IP is resolved.
 
-### UseSemanticFieldsetRendering
-
-In Forms 12.1 amends were made to the default theme for Forms that improved accessibility. Specifically we provide the option to use alternative markup for rendering checkbox and radio button lists. These use the more semantically correct `fieldset` and `legend` elements, instead of the previously used `div` and `label`.
-
-Although this semantic markup is preferred, it could be a presentational breaking change for those styling the default theme. As such we have made this markup improvement optional. You can opt into using it by setting this configuration value to `true`.
-
-In Umbraco 13 this configuration option will be removed and the semantic rendering made the only option.
-
 ### DisableClientSideValidationDependencyCheck
 
 When a form is rendered on the front-end website, a check is run to ensure that client-side validation framework is available and registered.

16/umbraco-forms/developer/configuration/type-details.md

@@ -1,5 +1,5 @@
 ---
-description: Provides details of the built-in provider types available with Umbraco Forms
+description: "Provides details of the built-in provider types available with Umbraco Forms"
 ---
 
 # Forms Provider Type Details
@@ -184,7 +184,7 @@ The intention is to be able to make available details such as IDs, aliases and p
 
 <details>
 
-<summary></summary>
+<summary>reCAPTCHA Enterprise</summary>
 
 **ID:** `1BAB78CB-52B1-495C-BBC2-A46540642828`
 
@@ -200,7 +200,7 @@ The intention is to be able to make available details such as IDs, aliases and p
 
 <details>
 
-<summary></summary>
+<summary>Rich Text</summary>
 
 **ID:** `1F8D45F8-76E6-4550-A0F5-9637B8454619`
 
@@ -215,7 +215,7 @@ The intention is to be able to make available details such as IDs, aliases and p
 
 <details>
 
-<summary></summary>
+<summary>Single Choice</summary>
 
 **ID:** `903DF9B0-A78C-11DE-9FC1-DB7A56D89593`
 
@@ -231,7 +231,7 @@ The intention is to be able to make available details such as IDs, aliases and p
 
 <details>
 
-<summary></summary>
+<summary>Short Answer</summary>
 
 **ID:** `3F92E01B-29E2-4a30-BF33-9DF5580ED52C`
 
@@ -269,7 +269,7 @@ The intention is to be able to make available details such as IDs, aliases and p
 
 <details>
 
-<summary></summary>
+<summary>Change Record State</summary>
 
 **ID:** `4C40A092-0CB5-481d-96A7-A02D8E7CDB2F`
 
@@ -284,7 +284,7 @@ The intention is to be able to make available details such as IDs, aliases and p
 
 <details>
 
-<summary></summary>
+<summary>Post as XML</summary>
 
 **ID:** `470EEB3A-CB15-4b08-9FC0-A2F091583332`
 
@@ -296,14 +296,15 @@ The intention is to be able to make available details such as IDs, aliases and p
 * `Method`
 * `XsltFile`
 * `Fields`
+* `DefaultElementForFields`
 * `Username`
 * `Password`
 
 </details>
 
 <details>
 
-<summary></summary>
+<summary>Save As Umbraco Content Node</summary>
 
 **ID:** `89FB1E31-9F36-4e08-9D1B-AF1180D340DB`
 
@@ -319,7 +320,7 @@ The intention is to be able to make available details such as IDs, aliases and p
 
 <details>
 
-<summary></summary>
+<summary>Save As XML File</summary>
 
 **ID:** `9CC5854D-61A2-48f6-9F4A-8F3BDFAFB521`
 
@@ -371,13 +372,16 @@ The intention is to be able to make available details such as IDs, aliases and p
 * `ReplyToEmail`
 * `Subject`
 * `RazorViewFilePath`
+* `HeaderHtml`
+* `BodyHtml`
+* `FooterHtml`
 * `Attachment`
 
 </details>
 
 <details>
 
-<summary></summary>
+<summary>Send Email With Extensible Stylesheet Language Transformations (XSLT) Template</summary>
 
 **ID:** `616edfeb-badf-414b-89dc-d8655eb85998`
 
@@ -397,7 +401,7 @@ The intention is to be able to make available details such as IDs, aliases and p
 
 <details>
 
-<summary></summary>
+<summary>Send Form To URL</summary>
 
 **ID:** `FD02C929-4E7D-4f90-B9FA-13D074A76688`
 
@@ -409,14 +413,15 @@ The intention is to be able to make available details such as IDs, aliases and p
 * `Method`
 * `StandardFields`
 * `Fields`
+* `DefaultElementForFields`
 * `Username`
 * `Password`
 
 </details>
 
 <details>
 
-<summary></summary>
+<summary>Slack</summary>
 
 **ID:** `bc52ab28-d3ff-42ee-af75-a5d49be83040`
 
@@ -449,7 +454,7 @@ The intention is to be able to make available details such as IDs, aliases and p
 
 <details>
 
-<summary></summary>
+<summary>Datasource</summary>
 
 **ID:** `cc9f9b2a-a746-11de-9e17-681b56d89593`
 
@@ -459,7 +464,7 @@ The intention is to be able to make available details such as IDs, aliases and p
 
 <details>
 
-<summary></summary>
+<summary>Get Values From Text File</summary>
 
 **ID:** `35C2053E-CBF7-4793-B27C-6E97B7671A2D`
 
@@ -473,7 +478,7 @@ The intention is to be able to make available details such as IDs, aliases and p
 
 <details>
 
-<summary></summary>
+<summary>SQL Database</summary>
 
 **ID:** `F1F5BD4D-E6AE-44ed-86CB-97661E4660B2`
 
@@ -492,7 +497,7 @@ The intention is to be able to make available details such as IDs, aliases and p
 
 <details>
 
-<summary></summary>
+<summary>Umbraco Datatype Prevalues</summary>
 
 **ID:** `EA773CAF-FEF2-491B-B5B7-6A3552B1A0E2`
 

16/umbraco-forms/developer/custom-markup.md

@@ -43,20 +43,20 @@ The rest of the views start with FieldType, like `FieldType.Textfield.cshtml` an
 Contents of the `FieldType.Textfield.cshtml` view (from the default theme):
 
 ```csharp
-@model Umbraco.Forms.Mvc.Models.FieldViewModel
-@using Umbraco.Forms.Mvc
-
-<input type="text"
-    name="@Model.Name"
-    id="@Model.Id"
-    class="@Html.GetFormFieldClass(Model.FieldTypeName) text"
-    value="@Model.ValueAsHtmlString"
-    maxlength="500"
-    @{if(string.IsNullOrEmpty(Model.PlaceholderText) == false){<text>placeholder="@Model.PlaceholderText"</text>}}
-    @{if(Model.Mandatory || Model.Validate){<text>data-val="true"</text>}}
-    @{if (Model.Mandatory) {<text> data-val-required="@Model.RequiredErrorMessage"</text>}}
-    @{if (Model.Validate) {<text> data-val-regex="@Model.InvalidErrorMessage" data-val-regex-pattern="@Html.Raw(Model.Regex)"</text>}}
-/>
+@using Umbraco.Forms.Web
+@model Umbraco.Forms.Web.Models.FieldViewModel
+@{
+    var maxLength = Model.GetSettingValue<int>("MaximumLength", 255);
+    var fieldType = Model.GetSettingValue<string>("FieldType", "text");
+    var autocompleteAttribute = Model.GetSettingValue<string>("AutocompleteAttribute", string.Empty);
+}
+<input type="@fieldType" name="@Model.Name" id="@Model.Id" data-umb="@Model.Id" class="text @Html.GetFormFieldClass(Model.FieldTypeName)" value="@Model.ValueAsHtmlString" maxlength="@maxLength"
+       @{if (string.IsNullOrEmpty(Model.PlaceholderText) == false) { <text> placeholder="@Model.PlaceholderText" </text>  }}
+       @{if (string.IsNullOrEmpty(autocompleteAttribute) == false) { <text> autocomplete="@autocompleteAttribute" </text>  }}
+       @{if (Model.Mandatory || Model.Validate) { <text> data-val="true" </text>  }}
+       @{if (Model.Mandatory) { <text> data-val-required="@Model.RequiredErrorMessage" aria-required="true" </text>  }}
+       @{if (Model.Validate) { <text> data-val-regex="@Model.InvalidErrorMessage" data-val-regex-pattern="@Html.Raw(Model.Regex)" </text>  }}
+       aria-describedby="@(Model.Id)_validation@(!string.IsNullOrEmpty(Model.ToolTip) ? $" {Model.Id}_description" : "")"/>
 ```
 
 Umbraco Forms uses ASP.NET Unobtrusive Validation which is why you see attributes like `data-val` and `data-val-required`.

16/umbraco-forms/developer/email-templates.md

@@ -177,6 +177,7 @@ Below is an example of an email template from the `~/Views/Partials/Forms/Emails
 								{
 									"FieldType.Recaptcha2.cshtml",
 									"FieldType.Recaptcha3.cshtml",
+									"FieldType.RecaptchaEnterprise.cshtml",
 									"FieldType.RichText.cshtml",
 									"FieldType.Text.cshtml"
 								};