From 90411df78cdd70c53054c4c87e6b19a930af2502 Mon Sep 17 00:00:00 2001 From: Hisham Bin Ateya Date: Wed, 5 Feb 2025 00:12:51 +0300 Subject: [PATCH] Fix table format in docs (#17446) --- src/docs/community/owners/README.md | 40 +-- .../leverage-csproj-meta-info/README.md | 46 +-- src/docs/reference/libraries/README.md | 86 ++--- .../modules/AdminDashboard/README.md | 10 +- .../reference/modules/AutoSetup/README.md | 36 +- .../reference/modules/ContentFields/README.md | 56 +-- .../reference/modules/ContentParts/README.md | 40 +-- .../reference/modules/ContentTypes/README.md | 10 +- src/docs/reference/modules/Contents/README.md | 82 ++--- src/docs/reference/modules/Data/README.md | 18 +- .../reference/modules/Diagnostics/README.md | 12 +- .../modules/DisplayManagement/README.md | 20 +- .../reference/modules/DynamicCache/README.md | 86 ++--- .../reference/modules/Elasticsearch/README.md | 30 +- .../reference/modules/Email.Azure/README.md | 8 +- .../reference/modules/Email.Smtp/README.md | 30 +- src/docs/reference/modules/Email/README.md | 12 +- .../reference/modules/HealthChecks/README.md | 6 +- src/docs/reference/modules/Html/README.md | 30 +- src/docs/reference/modules/Layers/README.md | 26 +- src/docs/reference/modules/Liquid/README.md | 180 +++++----- src/docs/reference/modules/Lists/README.md | 36 +- src/docs/reference/modules/Lucene/README.md | 20 +- src/docs/reference/modules/Markdown/README.md | 108 +++--- src/docs/reference/modules/Menu/README.md | 74 ++-- .../Microsoft.Authentication/README.md | 10 +- .../reference/modules/Navigation/README.md | 96 +++--- .../reference/modules/Notifications/README.md | 12 +- src/docs/reference/modules/OpenId/README.md | 20 +- src/docs/reference/modules/Razor/README.md | 68 ++-- src/docs/reference/modules/Recipes/README.md | 12 +- .../reference/modules/Resources/README.md | 62 ++-- src/docs/reference/modules/Roles/README.md | 16 +- .../reference/modules/SQLIndexing/README.md | 318 +++++++++--------- .../reference/modules/Scripting/README.md | 104 +++--- .../reference/modules/Security/Permissions.md | 262 +++++++-------- src/docs/reference/modules/Security/README.md | 10 +- src/docs/reference/modules/Setup/README.md | 28 +- .../reference/modules/Shortcodes/README.md | 64 ++-- .../reference/modules/Sms.Azure/README.md | 8 +- src/docs/reference/modules/Sms/README.md | 8 +- .../reference/modules/Taxonomies/README.md | 120 +++---- .../reference/modules/Templates/README.md | 268 +++++++-------- src/docs/reference/modules/Title/README.md | 4 +- .../reference/modules/UrlRewriting/README.md | 6 +- src/docs/reference/modules/Widgets/README.md | 28 +- .../reference/modules/Workflows/README.md | 130 +++---- src/docs/releases/1.5.0.md | 18 +- src/docs/releases/1.6.0.md | 40 +-- src/docs/releases/1.7.0.md | 8 +- 50 files changed, 1411 insertions(+), 1411 deletions(-) diff --git a/src/docs/community/owners/README.md b/src/docs/community/owners/README.md index 38ae7414eb0..fe432932345 100644 --- a/src/docs/community/owners/README.md +++ b/src/docs/community/owners/README.md @@ -2,23 +2,23 @@ The below table lists the different code/features areas and their owners: -| Owner | Area | -|--- | --- | -| [Jean-Thierry Kéchichian](https://github.com/jtkech) | Infrastructure, Build, Distributed Services | -| [Sipke Schoorstra](https://github.com/sfmskywalker) | Forms, Workflows | -| [Nicholas Mayne](https://github.com/Jetski5822) | GraphQL | -| [Carl Woodhouse](https://github.com/carlwoodhouse) | GraphQL | -| [Kévin Chalet](https://github.com/kevinchalet) | OpenID | -| [Dean Marcussen](https://github.com/deanmarcussen) | Azure, Media, Shortcodes, Sitemaps, Taxonomies | -| [Antoine Griffard](https://github.com/agriffard) | Docs, Crowdin Translations, Try, Website | -| [Hisham Bin Ateya](https://github.com/hishamco) | Cultures, Email, Localization, RTL, Translation, UI | -| [Jean-Philippe Tissot](https://github.com/jptissot) | Localization, Tests | -| [Larrem Panganiban](https://github.com/larremp) | Workshops | -| [Lukas Kabrt](https://github.com/lukaskabrt) | Po files extractor | -| [Matias Molleja](https://github.com/matiasmolleja) | Media | -| [Michael Petrinolis](https://github.com/MichaelPetrinolis) | External authentication providers | -| [Zoltán Lehóczky](https://github.com/Piedone) | PublishLater, Preview packages | -| [Sébastien Ros](https://github.com/sebastienros) | YesSql, Fluid, Jint, Shortcodes | -| [Jasmin Savard](https://github.com/skrypt) | Lucene, Indexing, Admin, UI | -| [Bertrand Le Roy](https://github.com/bleroy) | Commerce module | -| [Mike Alhayek](https://github.com/MikeAlhayek) | Azure AI Search, Notifications, SMS | +| Owner | Area | +|------------------------------------------------------------|-----------------------------------------------------| +| [Jean-Thierry Kéchichian](https://github.com/jtkech) | Infrastructure, Build, Distributed Services | +| [Sipke Schoorstra](https://github.com/sfmskywalker) | Forms, Workflows | +| [Nicholas Mayne](https://github.com/Jetski5822) | GraphQL | +| [Carl Woodhouse](https://github.com/carlwoodhouse) | GraphQL | +| [Kévin Chalet](https://github.com/kevinchalet) | OpenID | +| [Dean Marcussen](https://github.com/deanmarcussen) | Azure, Media, Shortcodes, Sitemaps, Taxonomies | +| [Antoine Griffard](https://github.com/agriffard) | Docs, Crowdin Translations, Try, Website | +| [Hisham Bin Ateya](https://github.com/hishamco) | Cultures, Email, Localization, RTL, Translation, UI | +| [Jean-Philippe Tissot](https://github.com/jptissot) | Localization, Tests | +| [Larrem Panganiban](https://github.com/larremp) | Workshops | +| [Lukas Kabrt](https://github.com/lukaskabrt) | Po files extractor | +| [Matias Molleja](https://github.com/matiasmolleja) | Media | +| [Michael Petrinolis](https://github.com/MichaelPetrinolis) | External authentication providers | +| [Zoltán Lehóczky](https://github.com/Piedone) | PublishLater, Preview packages | +| [Sébastien Ros](https://github.com/sebastienros) | YesSql, Fluid, Jint, Shortcodes | +| [Jasmin Savard](https://github.com/skrypt) | Lucene, Indexing, Admin, UI | +| [Bertrand Le Roy](https://github.com/bleroy) | Commerce module | +| [Mike Alhayek](https://github.com/MikeAlhayek) | Azure AI Search, Notifications, SMS | diff --git a/src/docs/guides/leverage-csproj-meta-info/README.md b/src/docs/guides/leverage-csproj-meta-info/README.md index d7123176038..225f08779fb 100644 --- a/src/docs/guides/leverage-csproj-meta-info/README.md +++ b/src/docs/guides/leverage-csproj-meta-info/README.md @@ -70,22 +70,22 @@ There are several items you may be interested in, depending on your projects, i. With all _properties_ described as follows. -|Property|Type|Description| -|-|-|-| -|`Include`|`string` 1|Required, signals `MSBuild` that an _item list_ is supported, which `Identity` serves as the attribute `Id`.| -|`Name`|`string`|Optional, human readable name for the module or feature.| -|`Base`|`string`|Optional, the base theme from which the assembly is derived. Not applicable to either _features_ or _modules_.| -|`ModuleType`|`string`|Optional author provided `Type`; defaults to `"Module"` or `"Theme"`. Not applicable to _features_ since this is a _Module_ base class property. 2| -|`Category`|`string`|Optional category for the feature.| -|`Priority`|`int` 1|Optional integer priority, given as a `string`, defaults to `0`; lower priority given precedence.| -|`Description`|`string`|Optional descriptive text.| -|`Author`|`string`|Optional, author provided identification.| -|`Version`|`string`|Optional, recommended, semantic versioning text, defaults to `"0.0"`.| -|`Dependencies`|`list`|Optional, semi-colon delimited list of _Module Identifier_ dependencies. 3| -|`Tags`|`list`|Optional, semi-colon delimited list of tags. 3| -|`DefaultTenant`|`bool` 1|Optional, Boolean, `true|false`, defaults to`false`.| -|`AlwaysEnabled`|`bool` 1|Optional, Boolean, `true|false`, defaults to`false`.| -|`EnabledByDependencyOnly`|`bool` 1|Optional, Boolean, `true|false`, defaults to`false`.| +| Property | Type | Description | +|---------------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `Include` | `string` 1 | Required, signals `MSBuild` that an _item list_ is supported, which `Identity` serves as the attribute `Id`. | +| `Name` | `string` | Optional, human readable name for the module or feature. | +| `Base` | `string` | Optional, the base theme from which the assembly is derived. Not applicable to either _features_ or _modules_. | +| `ModuleType` | `string` | Optional author provided `Type`; defaults to `"Module"` or `"Theme"`. Not applicable to _features_ since this is a _Module_ base class property. 2 | +| `Category` | `string` | Optional category for the feature. | +| `Priority` | `int` 1 | Optional integer priority, given as a `string`, defaults to `0`; lower priority given precedence. | +| `Description` | `string` | Optional descriptive text. | +| `Author` | `string` | Optional, author provided identification. | +| `Version` | `string` | Optional, recommended, semantic versioning text, defaults to `"0.0"`. | +| `Dependencies` | `list` | Optional, semi-colon delimited list of _Module Identifier_ dependencies. 3 | +| `Tags` | `list` | Optional, semi-colon delimited list of tags. 3 | +| `DefaultTenant` | `bool` 1 | Optional, Boolean, `true |false`, defaults to`false`.| +| `AlwaysEnabled` | `bool` 1 | Optional, Boolean, `true |false`, defaults to`false`.| +| `EnabledByDependencyOnly` | `bool` 1 | Optional, Boolean, `true |false`, defaults to`false`.| [1] `MSBuild` relays all meta data as `string`, leaving authors to contend with either `string` or `object` type conversions i.e. either `int` or `bool`, which is fine for our purposes.
[2] Depending on the `Attribute` context, `ModuleAttribute` yields `"Module"`, `ThemeAttribute` yields `"Theme"` by default. @@ -99,9 +99,9 @@ And for convenience, you may specify all of your assembly Orchard Core attribute ... /> ``` -|Property|Type|Description| -|-|-|-| -|`Type`|`string`|Commonly either, `"feature"`, `"theme"` or `"module"`. Anything else not `"feature"` or `"theme"` assumes _Module_.| +| Property | Type | Description | +|----------|----------|---------------------------------------------------------------------------------------------------------------------| +| `Type` | `string` | Commonly either, `"feature"`, `"theme"` or `"module"`. Anything else not `"feature"` or `"theme"` assumes _Module_. | Otherwise, the `OrchardCoreAttributes` should include all the same _properties_ that the desired `Type` would require. @@ -109,10 +109,10 @@ Otherwise, the `OrchardCoreAttributes` should include all the same _properties_ A couple of convenience [`MSBuild` _properties_](https://docs.microsoft.com/en-us/visualstudio/msbuild/msbuild-properties) are provided, which authors may leverage in order to accommodate their internal target build orders. -|Property|Default|Description| -|-|-|-| -|`OrchardCoreEmbeddingAfterTargets`|`AfterResolveReferences`|_Orchard Core_ assembly embedding to occur **_after_** these targets.| -|`OrchardCoreEmbeddingBeforeTargets`|`GenerateAssemblyInfo`|_Orchard Core_ assembly embedding to occur **_before_** these targets.| +| Property | Default | Description | +|-------------------------------------|--------------------------|------------------------------------------------------------------------| +| `OrchardCoreEmbeddingAfterTargets` | `AfterResolveReferences` | _Orchard Core_ assembly embedding to occur **_after_** these targets. | +| `OrchardCoreEmbeddingBeforeTargets` | `GenerateAssemblyInfo` | _Orchard Core_ assembly embedding to occur **_before_** these targets. | We do not recommend changing the defaults in any way, but rather to append with your custom targets as desired, i.e. diff --git a/src/docs/reference/libraries/README.md b/src/docs/reference/libraries/README.md index 6b366621ed0..2c10492f826 100644 --- a/src/docs/reference/libraries/README.md +++ b/src/docs/reference/libraries/README.md @@ -2,49 +2,49 @@ The below table lists the different .NET libraries used in Orchard Core: -| Library | Usage | License | -|--- | --- | --- | -| [Angle Sharp](https://github.com/AngleSharp/AngleSharp) | Angle brackets parser library. | [MIT](https://github.com/AngleSharp/AngleSharp/blob/devel/LICENSE) | -| [AWSSDK S3](https://github.com/aws/aws-sdk-net) | AWS SDK for .NET. | [Apache-2.0 license](https://github.com/aws/aws-sdk-net/blob/master/License.txt) | -| [AWSSDK Extensions Setup](https://github.com/aws/aws-sdk-net) | AWS SDK for .NET. | [Apache-2.0 license](https://github.com/aws/aws-sdk-net/blob/master/License.txt) | -| [Azure Identity](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/README.md) | Azure Active Directory token authentication support. | [MIT](https://github.com/Azure/azure-sdk-for-net/blob/master/LICENSE.txt) | -| [Azure Communication Services](https://github.com/Azure/Communication) | Azure Communication Services are cloud-based services with REST APIs and client library SDKs to help you integrate communication into your applications | [MIT](https://github.com/Azure/azure-sdk-for-net/blob/master/LICENSE.txt) | -| [Azure Configuration Secrets](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Extensions.AspNetCore.Configuration.Secrets_1.3.1/sdk/extensions/Azure.Extensions.AspNetCore.Configuration.Secrets/README.md) | Azure Key Vault configuration provider implementation for Microsoft.Extensions.Configuration. | [MIT](https://github.com/Azure/azure-sdk-for-net/blob/master/LICENSE.txt) | -| [Azure Storage Blobs](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Blobs/README.md) | Azure Storage Blobs client library for .NET. | [MIT](https://github.com/Azure/azure-sdk-for-net/blob/master/LICENSE.txt) | -| [Azure Storage Blobs for DataProtection](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Extensions.AspNetCore.DataProtection.Blobs_1.3.2/sdk/extensions/Azure.Extensions.AspNetCore.DataProtection.Blobs/README.md) | Allows storing ASP.NET Core DataProtection keys in Azure Blob Storage. | [MIT](https://github.com/Azure/azure-sdk-for-net/blob/master/LICENSE.txt) | -| [Castle.Core](https://github.com/castleproject/Core) | Castle DynamicProxy. | [Apache-2.0](https://github.com/castleproject/Core/blob/master/LICENSE) | -| [DocumentFormat.OpenXML](https://github.com/dotnet/Open-XML-SDK) | The Open XML SDK provides tools for working with Office Word, Excel, and PowerPoint documents | [MIT](https://github.com/dotnet/Open-XML-SDK/blob/main/LICENSE) | -| [Fluid.Core](https://github.com/sebastienros/fluid) | .NET Liquid template engine. | [MIT](https://github.com/sebastienros/fluid/blob/dev/LICENSE) | -| [GraphQL](https://github.com/graphql/graphiql) | GraphiQL & GraphQL. | [MIT](https://github.com/graphql/graphiql/blob/main/LICENSE) | -| [HtmlSanitizer](https://github.com/mganss/HtmlSanitizer) | Cleans HTML to avoid XSS attacks. | [MIT](https://github.com/mganss/HtmlSanitizer/blob/master/LICENSE.md) | -| [ImageSharp](https://github.com/SixLabors/ImageSharp.Web) | Middleware for ASP.NET-Core for image manipulation. | [Apache-2.0](https://github.com/SixLabors/ImageSharp.Web/blob/master/LICENSE) | -| [Irony.Core](https://github.com/daxnet/irony) | A modified version of the Irony project with .NET Core support | [MIT](https://github.com/daxnet/irony/blob/master/LICENSE) | -| [Jint](https://github.com/sebastienros/jint) | Javascript Interpreter for .NET. | [MIT](https://github.com/sebastienros/jint/blob/dev/LICENSE) | -| [JsonPath.NET](https://github.com/gregsdennis/json-everything/tree/master/JsonPath) | A string syntax for selecting and extracting JSON values from within a given JSON value. | [MIT](https://github.com/gregsdennis/json-everything/blob/master/LICENSE) | -| [libphonenumber-csharp](https://github.com/twcclegg/libphonenumber-csharp) | .NET library for parsing, formatting, and validating international phone numbers | [Apache-2.0](https://github.com/twcclegg/libphonenumber-csharp/blob/main/LICENSE) | -| [Lorem.NET for netstandard](https://github.com/trichards57/Lorem.Universal.NET) | A .NET library for all things random! | [MIT](https://github.com/trichards57/Lorem.Universal.NET/blob/master/license.md) | -| [Lucene.Net](https://github.com/apache/lucenenet) | .NET full-text search engine. | [Apache-2.0](https://github.com/apache/lucenenet/blob/master/LICENSE.txt) | -| [MailKit](https://github.com/jstedfast/MailKit) | A cross-platform .NET library for IMAP, POP3, and SMTP. | [MIT](https://github.com/jstedfast/MailKit/blob/master/LICENSE) | -| [Markdig](https://github.com/lunet-io/markdig) | .NET Markdown engine. | [BSD-2-Clause](https://github.com/lunet-io/markdig/blob/master/license.txt) | -| [Microsoft.Extensions.Http.Resilience](https://github.com/dotnet/extensions/tree/main/src/Libraries/Microsoft.Extensions.Http.Resilience) | Resilience mechanisms for HttpClient built on the Polly framework. | [MIT](https://github.com/dotnet/extensions/blob/main/LICENSE) | -| [Microsoft.Identity.Web](https://github.com/AzureAD/microsoft-identity-web) | Helps creating protected web apps and web APIs with Microsoft identity platform and Azure AD B2C. | [MIT](https://github.com/AzureAD/microsoft-identity-web/blob/master/LICENSE) | -| [Microsoft.SourceLink.GitHub](https://github.com/dotnet/sourcelink) | Source Link enables a great source debugging experience. | [MIT](https://github.com/dotnet/sourcelink/blob/main/License.txt) | -| [MimeKit](https://github.com/jstedfast/MailKit) | A cross-platform .NET library for IMAP, POP3, and SMTP. | [MIT](https://github.com/jstedfast/MailKit/blob/master/LICENSE) | -| [MiniProfiler](https://github.com/MiniProfiler/dotnet) | A simple but effective mini-profiler for ASP.NET (and Core) websites | [MIT](https://github.com/MiniProfiler/dotnet/blob/main/LICENSE.txt) | -| [NCrontab](https://github.com/atifaziz/NCrontab) | Crontab for .NET | [Apache-2.0](https://github.com/atifaziz/NCrontab/blob/master/COPYING.txt) | -| [Elasticsearch .NET Client](https://github.com/elastic/elasticsearch-net) | .NET Library for Elasticsearch | [Apache-2.0](https://github.com/elastic/elasticsearch-net/blob/main/LICENSE.txt) | -| [Azure.Search.Documents](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Search.Documents_11.5.1/sdk/search/Azure.Search.Documents/README.md) | Azure AI Search client library for .NET | [MIT](https://github.com/AzureAD/microsoft-identity-web/blob/master/LICENSE) | -| [Microsoft.Extensions.Azure](https://github.com/Azure/azure-sdk-for-net/blob/Microsoft.Extensions.Azure_1.7.3/sdk/extensions/Microsoft.Extensions.Azure/README.md) | Azure client library integration for ASP.NET Core | [MIT](https://github.com/AzureAD/microsoft-identity-web/blob/master/LICENSE) | -| [NJsonSchema](https://github.com/RicoSuter/NJsonSchema) | JSON Schema reader, generator and validator for .NET | [MIT](https://github.com/RicoSuter/NJsonSchema/blob/master/LICENSE.md) | -| [NLog.Web.AspNetCore](https://github.com/NLog/NLog.Web/tree/master/src/NLog.Web.AspNetCore) | NLog integration for ASP.NET. | [BSD-3-Clause](https://github.com/NLog/NLog.Web/blob/master/LICENSE) | -| [Noda Time](https://github.com/nodatime/nodatime) | A better date and time API for .NET. | [Apache-2.0](https://github.com/nodatime/nodatime/blob/master/LICENSE.txt) | -| [OpenIddict](https://github.com/openiddict/openiddict-core) | Flexible and versatile OAuth 2.0/OpenID Connect stack for .NET. | [Apache-2.0](https://github.com/openiddict/openiddict-core/blob/dev/LICENSE.md) | -| [PdfPig](https://github.com/UglyToad/PdfPig/) | Library to read and extract text and other content from PDF files. | [Apache-2.0](https://github.com/UglyToad/PdfPig/blob/master/LICENSE) | -| [Serilog.AspNetCore](https://github.com/serilog/serilog-aspnetcore) | Serilog integration for ASP.NET Core. | [Apache-2.0](https://github.com/serilog/serilog-aspnetcore/blob/dev/LICENSE) | -| [Shortcodes](https://github.com/sebastienros/shortcodes) | Shortcodes processor for .NET. | [MIT](https://github.com/sebastienros/shortcodes/blob/dev/LICENSE) | -| [StackExchange.Redis](https://github.com/StackExchange/StackExchange.Redis) | General purpose redis client. | [MIT](https://github.com/StackExchange/StackExchange.Redis/blob/main/LICENSE) | -| [YesSql](https://github.com/sebastienros/yessql) | .NET document database working on any RDBMS. | [MIT](https://github.com/sebastienros/yessql/blob/dev/LICENSE) | -| [ZString](https://github.com/Cysharp/ZString) | Zero Allocation StringBuilder for .NET Core and Unity. | [MIT](https://github.com/Cysharp/ZString/blob/master/LICENSE) | +| Library | Usage | License | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------| +| [Angle Sharp](https://github.com/AngleSharp/AngleSharp) | Angle brackets parser library. | [MIT](https://github.com/AngleSharp/AngleSharp/blob/devel/LICENSE) | +| [AWSSDK S3](https://github.com/aws/aws-sdk-net) | AWS SDK for .NET. | [Apache-2.0 license](https://github.com/aws/aws-sdk-net/blob/master/License.txt) | +| [AWSSDK Extensions Setup](https://github.com/aws/aws-sdk-net) | AWS SDK for .NET. | [Apache-2.0 license](https://github.com/aws/aws-sdk-net/blob/master/License.txt) | +| [Azure Identity](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/README.md) | Azure Active Directory token authentication support. | [MIT](https://github.com/Azure/azure-sdk-for-net/blob/master/LICENSE.txt) | +| [Azure Communication Services](https://github.com/Azure/Communication) | Azure Communication Services are cloud-based services with REST APIs and client library SDKs to help you integrate communication into your applications | [MIT](https://github.com/Azure/azure-sdk-for-net/blob/master/LICENSE.txt) | +| [Azure Configuration Secrets](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Extensions.AspNetCore.Configuration.Secrets_1.3.1/sdk/extensions/Azure.Extensions.AspNetCore.Configuration.Secrets/README.md) | Azure Key Vault configuration provider implementation for Microsoft.Extensions.Configuration. | [MIT](https://github.com/Azure/azure-sdk-for-net/blob/master/LICENSE.txt) | +| [Azure Storage Blobs](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Blobs/README.md) | Azure Storage Blobs client library for .NET. | [MIT](https://github.com/Azure/azure-sdk-for-net/blob/master/LICENSE.txt) | +| [Azure Storage Blobs for DataProtection](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Extensions.AspNetCore.DataProtection.Blobs_1.3.2/sdk/extensions/Azure.Extensions.AspNetCore.DataProtection.Blobs/README.md) | Allows storing ASP.NET Core DataProtection keys in Azure Blob Storage. | [MIT](https://github.com/Azure/azure-sdk-for-net/blob/master/LICENSE.txt) | +| [Castle.Core](https://github.com/castleproject/Core) | Castle DynamicProxy. | [Apache-2.0](https://github.com/castleproject/Core/blob/master/LICENSE) | +| [DocumentFormat.OpenXML](https://github.com/dotnet/Open-XML-SDK) | The Open XML SDK provides tools for working with Office Word, Excel, and PowerPoint documents | [MIT](https://github.com/dotnet/Open-XML-SDK/blob/main/LICENSE) | +| [Fluid.Core](https://github.com/sebastienros/fluid) | .NET Liquid template engine. | [MIT](https://github.com/sebastienros/fluid/blob/dev/LICENSE) | +| [GraphQL](https://github.com/graphql/graphiql) | GraphiQL & GraphQL. | [MIT](https://github.com/graphql/graphiql/blob/main/LICENSE) | +| [HtmlSanitizer](https://github.com/mganss/HtmlSanitizer) | Cleans HTML to avoid XSS attacks. | [MIT](https://github.com/mganss/HtmlSanitizer/blob/master/LICENSE.md) | +| [ImageSharp](https://github.com/SixLabors/ImageSharp.Web) | Middleware for ASP.NET-Core for image manipulation. | [Apache-2.0](https://github.com/SixLabors/ImageSharp.Web/blob/master/LICENSE) | +| [Irony.Core](https://github.com/daxnet/irony) | A modified version of the Irony project with .NET Core support | [MIT](https://github.com/daxnet/irony/blob/master/LICENSE) | +| [Jint](https://github.com/sebastienros/jint) | Javascript Interpreter for .NET. | [MIT](https://github.com/sebastienros/jint/blob/dev/LICENSE) | +| [JsonPath.NET](https://github.com/gregsdennis/json-everything/tree/master/JsonPath) | A string syntax for selecting and extracting JSON values from within a given JSON value. | [MIT](https://github.com/gregsdennis/json-everything/blob/master/LICENSE) | +| [libphonenumber-csharp](https://github.com/twcclegg/libphonenumber-csharp) | .NET library for parsing, formatting, and validating international phone numbers | [Apache-2.0](https://github.com/twcclegg/libphonenumber-csharp/blob/main/LICENSE) | +| [Lorem.NET for netstandard](https://github.com/trichards57/Lorem.Universal.NET) | A .NET library for all things random! | [MIT](https://github.com/trichards57/Lorem.Universal.NET/blob/master/license.md) | +| [Lucene.Net](https://github.com/apache/lucenenet) | .NET full-text search engine. | [Apache-2.0](https://github.com/apache/lucenenet/blob/master/LICENSE.txt) | +| [MailKit](https://github.com/jstedfast/MailKit) | A cross-platform .NET library for IMAP, POP3, and SMTP. | [MIT](https://github.com/jstedfast/MailKit/blob/master/LICENSE) | +| [Markdig](https://github.com/lunet-io/markdig) | .NET Markdown engine. | [BSD-2-Clause](https://github.com/lunet-io/markdig/blob/master/license.txt) | +| [Microsoft.Extensions.Http.Resilience](https://github.com/dotnet/extensions/tree/main/src/Libraries/Microsoft.Extensions.Http.Resilience) | Resilience mechanisms for HttpClient built on the Polly framework. | [MIT](https://github.com/dotnet/extensions/blob/main/LICENSE) | +| [Microsoft.Identity.Web](https://github.com/AzureAD/microsoft-identity-web) | Helps creating protected web apps and web APIs with Microsoft identity platform and Azure AD B2C. | [MIT](https://github.com/AzureAD/microsoft-identity-web/blob/master/LICENSE) | +| [Microsoft.SourceLink.GitHub](https://github.com/dotnet/sourcelink) | Source Link enables a great source debugging experience. | [MIT](https://github.com/dotnet/sourcelink/blob/main/License.txt) | +| [MimeKit](https://github.com/jstedfast/MailKit) | A cross-platform .NET library for IMAP, POP3, and SMTP. | [MIT](https://github.com/jstedfast/MailKit/blob/master/LICENSE) | +| [MiniProfiler](https://github.com/MiniProfiler/dotnet) | A simple but effective mini-profiler for ASP.NET (and Core) websites | [MIT](https://github.com/MiniProfiler/dotnet/blob/main/LICENSE.txt) | +| [NCrontab](https://github.com/atifaziz/NCrontab) | Crontab for .NET | [Apache-2.0](https://github.com/atifaziz/NCrontab/blob/master/COPYING.txt) | +| [Elasticsearch .NET Client](https://github.com/elastic/elasticsearch-net) | .NET Library for Elasticsearch | [Apache-2.0](https://github.com/elastic/elasticsearch-net/blob/main/LICENSE.txt) | +| [Azure.Search.Documents](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Search.Documents_11.5.1/sdk/search/Azure.Search.Documents/README.md) | Azure AI Search client library for .NET | [MIT](https://github.com/AzureAD/microsoft-identity-web/blob/master/LICENSE) | +| [Microsoft.Extensions.Azure](https://github.com/Azure/azure-sdk-for-net/blob/Microsoft.Extensions.Azure_1.7.3/sdk/extensions/Microsoft.Extensions.Azure/README.md) | Azure client library integration for ASP.NET Core | [MIT](https://github.com/AzureAD/microsoft-identity-web/blob/master/LICENSE) | +| [NJsonSchema](https://github.com/RicoSuter/NJsonSchema) | JSON Schema reader, generator and validator for .NET | [MIT](https://github.com/RicoSuter/NJsonSchema/blob/master/LICENSE.md) | +| [NLog.Web.AspNetCore](https://github.com/NLog/NLog.Web/tree/master/src/NLog.Web.AspNetCore) | NLog integration for ASP.NET. | [BSD-3-Clause](https://github.com/NLog/NLog.Web/blob/master/LICENSE) | +| [Noda Time](https://github.com/nodatime/nodatime) | A better date and time API for .NET. | [Apache-2.0](https://github.com/nodatime/nodatime/blob/master/LICENSE.txt) | +| [OpenIddict](https://github.com/openiddict/openiddict-core) | Flexible and versatile OAuth 2.0/OpenID Connect stack for .NET. | [Apache-2.0](https://github.com/openiddict/openiddict-core/blob/dev/LICENSE.md) | +| [PdfPig](https://github.com/UglyToad/PdfPig/) | Library to read and extract text and other content from PDF files. | [Apache-2.0](https://github.com/UglyToad/PdfPig/blob/master/LICENSE) | +| [Serilog.AspNetCore](https://github.com/serilog/serilog-aspnetcore) | Serilog integration for ASP.NET Core. | [Apache-2.0](https://github.com/serilog/serilog-aspnetcore/blob/dev/LICENSE) | +| [Shortcodes](https://github.com/sebastienros/shortcodes) | Shortcodes processor for .NET. | [MIT](https://github.com/sebastienros/shortcodes/blob/dev/LICENSE) | +| [StackExchange.Redis](https://github.com/StackExchange/StackExchange.Redis) | General purpose redis client. | [MIT](https://github.com/StackExchange/StackExchange.Redis/blob/main/LICENSE) | +| [YesSql](https://github.com/sebastienros/yessql) | .NET document database working on any RDBMS. | [MIT](https://github.com/sebastienros/yessql/blob/dev/LICENSE) | +| [ZString](https://github.com/Cysharp/ZString) | Zero Allocation StringBuilder for .NET Core and Unity. | [MIT](https://github.com/Cysharp/ZString/blob/master/LICENSE) | The below table lists the different libraries used as Resources: diff --git a/src/docs/reference/modules/AdminDashboard/README.md b/src/docs/reference/modules/AdminDashboard/README.md index 946e32e2db0..1bf0aa90552 100644 --- a/src/docs/reference/modules/AdminDashboard/README.md +++ b/src/docs/reference/modules/AdminDashboard/README.md @@ -17,11 +17,11 @@ Please note that users lacking the `ManageAdminDashboard` permission will requir Each widget has the following customizable settings: -| Option | Description | -| --------- | ------------------------------------------------------------- | -| `Position`| A numeric value indicating the widget's order on the page. | -| `Width` | An integer value between 1 and 6, representing the widget's width on the screen. Please note that 1 indicates (1/6) of the screen, while 6 signifies full screen width. | -| `Height` | An integer value between 1 and 6, representing the widget's height on the screen. Please note that 1 indicates (1/6) of the screen, while 6 signifies full screen height. | +| Option | Description | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `Position` | A numeric value indicating the widget's order on the page. | +| `Width` | An integer value between 1 and 6, representing the widget's width on the screen. Please note that 1 indicates (1/6) of the screen, while 6 signifies full screen width. | +| `Height` | An integer value between 1 and 6, representing the widget's height on the screen. Please note that 1 indicates (1/6) of the screen, while 6 signifies full screen height. | ### Styling diff --git a/src/docs/reference/modules/AutoSetup/README.md b/src/docs/reference/modules/AutoSetup/README.md index b766f890982..847a5e99978 100644 --- a/src/docs/reference/modules/AutoSetup/README.md +++ b/src/docs/reference/modules/AutoSetup/README.md @@ -43,25 +43,25 @@ Auto-Setup parameters are defined in appsettings.json. Example excerpt: } ``` -| Parameter | Description | -| --- | --- | +| Parameter | Description | +|-----------------|-------------------------------------------------------------------------------------------------------------------------------------| | `AutoSetupPath` | The URL To Trigger AutoSetup For Each Tenant. If empty, auto-setup will be triggered on first tenant request e.g: /, /tenant-prefix | -| `Tenants` | The list of the tenants to install. | - -| Parameter | Description | -| --- | --- | -| `ShellName` | The technical shell / tenant name. It can not be empty and must contain characters only. Use "Default" for the default tenant. | -| `SiteName` | The name of the site. | -| `AdminUsername` | The tenant username of the super user. | -| `AdminEmail` | The email of the tenant super user. | -| `AdminPassword` | The password of the tenant super user. | -| `DatabaseProvider` | The database provider. | -| `DatabaseConnectionString` | The connection string. | -| `DatabaseTablePrefix` | The database table prefix. Can be used to install a tenant on the same database. | -| `RecipeName` | The tenant installation Recipe name. | -| `RequestUrlHost` | The tenant host url. | -| `RequestUrlPrefix` | The tenant url prefix. | -| `FeatureProfile` | Optionally, the name of the feature profile used by default. Only applicable if the "Feature Profiles" feature is used. See the [documentation of the Tenants module](../Tenants/README.md#feature-profiles) for details. | +| `Tenants` | The list of the tenants to install. | + +| Parameter | Description | +|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `ShellName` | The technical shell / tenant name. It can not be empty and must contain characters only. Use "Default" for the default tenant. | +| `SiteName` | The name of the site. | +| `AdminUsername` | The tenant username of the super user. | +| `AdminEmail` | The email of the tenant super user. | +| `AdminPassword` | The password of the tenant super user. | +| `DatabaseProvider` | The database provider. | +| `DatabaseConnectionString` | The connection string. | +| `DatabaseTablePrefix` | The database table prefix. Can be used to install a tenant on the same database. | +| `RecipeName` | The tenant installation Recipe name. | +| `RequestUrlHost` | The tenant host url. | +| `RequestUrlPrefix` | The tenant url prefix. | +| `FeatureProfile` | Optionally, the name of the feature profile used by default. Only applicable if the "Feature Profiles" feature is used. See the [documentation of the Tenants module](../Tenants/README.md#feature-profiles) for details. | !!! note Tenants array must contain the root tenant with `ShellName` equals to `Default`. diff --git a/src/docs/reference/modules/ContentFields/README.md b/src/docs/reference/modules/ContentFields/README.md index cbabd3e6957..00b82846ac7 100644 --- a/src/docs/reference/modules/ContentFields/README.md +++ b/src/docs/reference/modules/ContentFields/README.md @@ -5,25 +5,25 @@ Some fields are available in their specific module. ## Available Fields -| Name | Properties | -| --- | --- | -| `BooleanField` | `bool Value` | -| `ContentPickerField` | `string[] ContentItemIds` | -| `DateField` | `DateTime? Value` | -| `DateTimeField` | `DateTime? Value` | -| `HtmlField` | `string Html` | -| `LinkField` | `string Url, string Text` | -| `LocalizationSetContentPickerField` | `string[] LocalizationSets` | -| `MarkdownField` | `string Markdown` | -| `MediaField` | `string[] Paths` | -| `MultiTextField` | `string[] Values` | -| `NumericField` | `decimal? Value` | -| `GeoPointField` | `decimal Latitude, decimal Longitude` | -| `TaxonomyField` | `string TaxonomyContentItemId, string[] TaxonomyContentItemId` | -| `TextField` | `string Text` | -| `TimeField` | `TimeSpan? Value` | -| `UserPickerField` | `string[] UserIds` | -| `YoutubeField` | `string EmbeddedAddress, string RawAddress` | +| Name | Properties | +|-------------------------------------|----------------------------------------------------------------| +| `BooleanField` | `bool Value` | +| `ContentPickerField` | `string[] ContentItemIds` | +| `DateField` | `DateTime? Value` | +| `DateTimeField` | `DateTime? Value` | +| `HtmlField` | `string Html` | +| `LinkField` | `string Url, string Text` | +| `LocalizationSetContentPickerField` | `string[] LocalizationSets` | +| `MarkdownField` | `string Markdown` | +| `MediaField` | `string[] Paths` | +| `MultiTextField` | `string[] Values` | +| `NumericField` | `decimal? Value` | +| `GeoPointField` | `decimal Latitude, decimal Longitude` | +| `TaxonomyField` | `string TaxonomyContentItemId, string[] TaxonomyContentItemId` | +| `TextField` | `string Text` | +| `TimeField` | `TimeSpan? Value` | +| `UserPickerField` | `string[] UserIds` | +| `YoutubeField` | `string EmbeddedAddress, string RawAddress` | !!! note Each field is rendered by a corresponding `Shape Type` that is using its own a Display view model. @@ -52,10 +52,10 @@ From a field shape (see Shape Type in the table listing all the fields) you can The convention for a field view model is to also expose these properties: -| Property | Description | -| --- | --- | -| `Field` | The ContentField. | -| `Part` | The ContentPart that contains the field. | +| Property | Description | +|-----------------------|------------------------------------------------------------------------------------------------------| +| `Field` | The ContentField. | +| `Part` | The ContentPart that contains the field. | | `PartFieldDefinition` | The Content Part Field Definition that contains the part. Which also give access to the Content Type | Some view models have special properties that are computed from the actual field data and which are more useful for templating. @@ -64,9 +64,9 @@ Some view models have special properties that are computed from the actual field #### `DisplayHtmlFieldViewModel` -| Property | Description | -| --- | --- | -| `Html` | The processed HTML, once all liquid tags have been processed. | +| Property | Description | +|----------|---------------------------------------------------------------| +| `Html` | The processed HTML, once all liquid tags have been processed. | #### Html Field Example @@ -84,8 +84,8 @@ or, to display the raw content before the tags are converted: #### `DisplayDateTimeFieldViewModel` -| Property | Description | -| --- | --- | +| Property | Description | +|-----------------|---------------------------------------------| | `LocalDateTime` | The date time in the time zone of the site. | #### DateTime Field Example diff --git a/src/docs/reference/modules/ContentParts/README.md b/src/docs/reference/modules/ContentParts/README.md index 659a3a211e0..00706b4b608 100644 --- a/src/docs/reference/modules/ContentParts/README.md +++ b/src/docs/reference/modules/ContentParts/README.md @@ -4,26 +4,26 @@ Orchard Core allows you to add Parts to a content type. ## Available Parts -| Name | Description | -| --- | --- | -| [`TitlePart`](../../modules/Title/README.md) | Allows you to add a title. | -| [`AutoroutePart`](../../modules/Autoroute/README.md) | Allows you to add a permalink. | -| [`CommonPart`](../../modules/Contents/README.md) | Allows you to edit the creation date and the owner of the content. | -| [`AliasPart`](../../modules/Alias/README.md) | Allows you to add an alias. | -| [`HtmlBodyPart`](../../modules/Html/README.md) | Allows you to add an HTML body. | -| [`MarkdownPart`](../../modules/Markdown/README.md) | Allows you to add a Markdown body. | -| [`LiquidPart`](../../modules/Liquid/README.md) | Allows you to add a Liquid input. | -| [`LocalizationPart`](../../modules/Localize/README.md) | Allows you to create a localization of the current content. | -| [`ListPart`](../../modules/Lists/README.md) | Allows you to add a list. | -| [`FlowPart`](../../modules/Flow/README.md) | Allows you to add widgets. | -| [`BagPart`](../../modules/Flow/BagPart.md) | Allows you to add inner content items. | -| `WidgetsListPart` | Allows you to add widgets in the different zones. | -| [`FormPart`](../../modules/Forms/README.md) | Allows you to add a form. | -| [`Preview`](../../modules/ContentPreview/README.md) | Allows you to add a preview button. | -| [`PublishLater`](../../modules/PublishLater/README.md) | Allows you to set a date in order to publish later. | -| [`ReCaptcha`](../../modules/ReCaptcha/README.md) | Allows you to add a ReCaptcha. | -| [`SeoMeta`](../../modules/Seo/README.md) | Allows you to configure SEO meta tags. | -| [`AuditTrail`](../../modules/AuditTrail/README.md) | Allows you to add a comment describing the changes of a content item, to be recorded to the Audit Trail. | +| Name | Description | +|--------------------------------------------------------|----------------------------------------------------------------------------------------------------------| +| [`TitlePart`](../../modules/Title/README.md) | Allows you to add a title. | +| [`AutoroutePart`](../../modules/Autoroute/README.md) | Allows you to add a permalink. | +| [`CommonPart`](../../modules/Contents/README.md) | Allows you to edit the creation date and the owner of the content. | +| [`AliasPart`](../../modules/Alias/README.md) | Allows you to add an alias. | +| [`HtmlBodyPart`](../../modules/Html/README.md) | Allows you to add an HTML body. | +| [`MarkdownPart`](../../modules/Markdown/README.md) | Allows you to add a Markdown body. | +| [`LiquidPart`](../../modules/Liquid/README.md) | Allows you to add a Liquid input. | +| [`LocalizationPart`](../../modules/Localize/README.md) | Allows you to create a localization of the current content. | +| [`ListPart`](../../modules/Lists/README.md) | Allows you to add a list. | +| [`FlowPart`](../../modules/Flow/README.md) | Allows you to add widgets. | +| [`BagPart`](../../modules/Flow/BagPart.md) | Allows you to add inner content items. | +| `WidgetsListPart` | Allows you to add widgets in the different zones. | +| [`FormPart`](../../modules/Forms/README.md) | Allows you to add a form. | +| [`Preview`](../../modules/ContentPreview/README.md) | Allows you to add a preview button. | +| [`PublishLater`](../../modules/PublishLater/README.md) | Allows you to set a date in order to publish later. | +| [`ReCaptcha`](../../modules/ReCaptcha/README.md) | Allows you to add a ReCaptcha. | +| [`SeoMeta`](../../modules/Seo/README.md) | Allows you to configure SEO meta tags. | +| [`AuditTrail`](../../modules/AuditTrail/README.md) | Allows you to add a comment describing the changes of a content item, to be recorded to the Audit Trail. | ## Videos diff --git a/src/docs/reference/modules/ContentTypes/README.md b/src/docs/reference/modules/ContentTypes/README.md index 80f87ae38bb..5b981b4fd7e 100644 --- a/src/docs/reference/modules/ContentTypes/README.md +++ b/src/docs/reference/modules/ContentTypes/README.md @@ -10,11 +10,11 @@ The editor returns the selection as a `string[]` on the model. #### Parameters -| Parameter | Type | Description | -| --------- | ---- | ----------- | -| `selectedContentTypes` | `string[]` | The list of content types that should be marked as selected when rendering the editor. | -| `htmlName` | `string` | The name of the model property to bind the result to. -| `stereotype` (optional) | `string` | A stereotype name to filter the list of content types available to select. | +| Parameter | Type | Description | +|-------------------------|------------|----------------------------------------------------------------------------------------| +| `selectedContentTypes` | `string[]` | The list of content types that should be marked as selected when rendering the editor. | +| `htmlName` | `string` | The name of the model property to bind the result to. | +| `stereotype` (optional) | `string` | A stereotype name to filter the list of content types available to select. | #### Sample diff --git a/src/docs/reference/modules/Contents/README.md b/src/docs/reference/modules/Contents/README.md index 72d7b382e16..ca7ba139492 100644 --- a/src/docs/reference/modules/Contents/README.md +++ b/src/docs/reference/modules/Contents/README.md @@ -8,12 +8,12 @@ Attach this part to your content items to edit the common properties like `Creat The following properties are available on `CommonPart`: -| Name | Type | Description | -| -----| ---- |------------ | -| `CreatedUtc` | `DateTime` | The HTML content in the body. | -| `Owner` | `string` | The HTML content in the body. | -| `Content` | | The raw content of the part. | -| `ContentItem` | | The content item containing this part. | +| Name | Type | Description | +|---------------|------------|----------------------------------------| +| `CreatedUtc` | `DateTime` | The HTML content in the body. | +| `Owner` | `string` | The HTML content in the body. | +| `Content` | | The raw content of the part. | +| `ContentItem` | | The content item containing this part. | ## Liquid @@ -98,14 +98,14 @@ Well known properties include The following methods are available from the Razor helper. -| Method | Parameters | Description | -| --------- | ---- |------------ | -| `GetContentItemIdByHandleAsync` | `string name` | Returns the content item id from its handle. Ex: `alias:carousel`, `slug:myblog/my-blog-post` | -| `GetContentItemByHandleAsync` | `string handle, bool latest = false` | Loads a content item from its handle, seeking the latest version or not. | -| `GetContentItemByIdAsync` | `string contentItemId, bool latest = false` | Loads a content item from its id, seeking the latest version or not. | -| `GetContentItemsByIdAsync` | `IEnumerable contentItemIds, bool latest = false` | Loads a list of content items by ids, seeking the latest version or not. | -| `GetContentItemByVersionIdAsync` | `string contentItemVersionId` | Loads a content item from its version id. | -| `ConsoleLog` | `object content` | Logs content to the browser console | +| Method | Parameters | Description | +|----------------------------------|-----------------------------------------------------------|-----------------------------------------------------------------------------------------------| +| `GetContentItemIdByHandleAsync` | `string name` | Returns the content item id from its handle. Ex: `alias:carousel`, `slug:myblog/my-blog-post` | +| `GetContentItemByHandleAsync` | `string handle, bool latest = false` | Loads a content item from its handle, seeking the latest version or not. | +| `GetContentItemByIdAsync` | `string contentItemId, bool latest = false` | Loads a content item from its id, seeking the latest version or not. | +| `GetContentItemsByIdAsync` | `IEnumerable contentItemIds, bool latest = false` | Loads a list of content items by ids, seeking the latest version or not. | +| `GetContentItemByVersionIdAsync` | `string contentItemVersionId` | Loads a content item from its version id. | +| `ConsoleLog` | `object content` | Logs content to the browser console | > The Razor Helper is accessible on the `Orchard` property if the view is using Orchard Core's Razor base class, or by injecting `OrchardCore.IOrchardHelper` in all other cases. @@ -157,15 +157,15 @@ It is usually better to **create a dedicated user for performing API calls**, ma ##### Parameters -| Name | Located in | Description | Required | Schema | -| ---- | ---------- | ----------- | -------- | ---- | -| contentItemId | path | The ID of the Content Item to be retrieved. | Yes | string | +| Name | Located in | Description | Required | Schema | +|---------------|------------|---------------------------------------------|----------|--------| +| contentItemId | path | The ID of the Content Item to be retrieved. | Yes | string | ##### Responses | Code | Description | -| ---- | ----------- | -| 200 | Success | +|------|-------------| +| 200 | Success | *** @@ -173,9 +173,9 @@ It is usually better to **create a dedicated user for performing API calls**, ma ##### Parameters -| Name | Located in | Description | Required | Schema | -| ---- | ---------- | ----------- | -------- | ---- | -| | payload | The content item model to be updated | Yes | Json | +| Name | Located in | Description | Required | Schema | +|------|------------|--------------------------------------|----------|--------| +| | payload | The content item model to be updated | Yes | Json | ##### Body payload example @@ -202,8 +202,8 @@ It is usually better to **create a dedicated user for performing API calls**, ma ##### Responses | Code | Description | -| ---- | ----------- | -| 200 | Success | +|------|-------------| +| 200 | Success | *** @@ -211,15 +211,15 @@ It is usually better to **create a dedicated user for performing API calls**, ma ##### Parameters -| Name | Located in | Description | Required | Schema | -| ---- | ---------- | ----------- | -------- | ---- | -| contentItemId | path | The ID of the Content Item to be deleted. | Yes | string | +| Name | Located in | Description | Required | Schema | +|---------------|------------|-------------------------------------------|----------|--------| +| contentItemId | path | The ID of the Content Item to be deleted. | Yes | string | ##### Responses | Code | Description | -| ---- | ----------- | -| 200 | Success | +|------|-------------| +| 200 | Success | ## GraphQL @@ -259,19 +259,19 @@ query { These fields are available at the content item level: -| Property | -| -------- | -| `contentItemId` | +| Property | +|------------------------| +| `contentItemId` | | `contentItemVersionId` | -| `contentType` | -| `displayText` | -| `published` | -| `latest` | -| `modifiedUtc` | -| `publishedUtc` | -| `createdUtc` | -| `owner` | -| `author` | +| `contentType` | +| `displayText` | +| `published` | +| `latest` | +| `modifiedUtc` | +| `publishedUtc` | +| `createdUtc` | +| `owner` | +| `author` | In addition, all the content parts can also be retrieved like this: diff --git a/src/docs/reference/modules/Data/README.md b/src/docs/reference/modules/Data/README.md index c252e060fc1..dcdb2299d1c 100644 --- a/src/docs/reference/modules/Data/README.md +++ b/src/docs/reference/modules/Data/README.md @@ -28,15 +28,15 @@ See the [`Microsoft.Data.Sqlite` documentation](https://docs.microsoft.com/en-us OrchardCore uses the `YesSql` library to interact with the configured database provider. `YesSql` is shipped with configuration that is suitable for most use cases. However, you can change these settings by configuring `YesSqlOptions`. `YesSqlOptions` provides the following configurable options. -| Setting | Description | -| --- | --- | -| `CommandsPageSize` | Gets or sets the command page size. If you have to many queries in one command, `YesSql` will split the large command into multiple commands. | -| `QueryGatingEnabled` | Gets or sets the `QueryGatingEnabled` option in `YesSql`. | -| `IdGenerator` | You can provide your own implementation for generating ids. | -| `IdentifierAccessorFactory` | You can provide your own value accessor factory. | -| `VersionAccessorFactory` | You can provide your own version accessor factory. | -| `ContentSerializer` | You can provide your own content serializer. | -| `EnableThreadSafetyChecks` | Gets or sets the `EnableThreadSafetyChecks` option in YesSql, which aids in diagnosing concurrency or race condition issues. | +| Setting | Description | +|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| `CommandsPageSize` | Gets or sets the command page size. If you have to many queries in one command, `YesSql` will split the large command into multiple commands. | +| `QueryGatingEnabled` | Gets or sets the `QueryGatingEnabled` option in `YesSql`. | +| `IdGenerator` | You can provide your own implementation for generating ids. | +| `IdentifierAccessorFactory` | You can provide your own value accessor factory. | +| `VersionAccessorFactory` | You can provide your own version accessor factory. | +| `ContentSerializer` | You can provide your own content serializer. | +| `EnableThreadSafetyChecks` | Gets or sets the `EnableThreadSafetyChecks` option in YesSql, which aids in diagnosing concurrency or race condition issues. | For example, you can change the default command-page-size from `500` to `1000` by adding the following code to your startup code. diff --git a/src/docs/reference/modules/Diagnostics/README.md b/src/docs/reference/modules/Diagnostics/README.md index 8e50f2ae2ef..77f2dd9c813 100644 --- a/src/docs/reference/modules/Diagnostics/README.md +++ b/src/docs/reference/modules/Diagnostics/README.md @@ -4,12 +4,12 @@ Enables you to present HTTP errors in a personalized style and offers a means to modify the response of particular HTML errors. By default, we utilizes the following templates. -| Template | Description | -| --------- | ----------- | -| `HttpError__BadRequest` | Generates the `400` HTTP error page. You can adjust its appearance by modifying the `HttpError-BadRequest.cshtml` or `HttpError-BadRequest.liquid` views. | -| `HttpError__Forbidden` | Generates the `403` HTTP error page. You can adjust its appearance by modifying the `HttpError-Forbidden.cshtml` or `HttpError-Forbidden.liquid` views. | -| `HttpError__NotFound` | Generates the `404` HTTP error page. You can adjust its appearance by modifying the `HttpError-NotFound.cshtml` or `HttpError-NotFound.liquid` views. | -| `HttpError__Unauthorized` | Generates the `401` HTTP error page. You can adjust its appearance by modifying the `HttpError-Unauthorized.cshtml` or `HttpError-Unauthorized.liquid` views. | +| Template | Description | +|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `HttpError__BadRequest` | Generates the `400` HTTP error page. You can adjust its appearance by modifying the `HttpError-BadRequest.cshtml` or `HttpError-BadRequest.liquid` views. | +| `HttpError__Forbidden` | Generates the `403` HTTP error page. You can adjust its appearance by modifying the `HttpError-Forbidden.cshtml` or `HttpError-Forbidden.liquid` views. | +| `HttpError__NotFound` | Generates the `404` HTTP error page. You can adjust its appearance by modifying the `HttpError-NotFound.cshtml` or `HttpError-NotFound.liquid` views. | +| `HttpError__Unauthorized` | Generates the `401` HTTP error page. You can adjust its appearance by modifying the `HttpError-Unauthorized.cshtml` or `HttpError-Unauthorized.liquid` views. | | `HttpError__HttpStatusCode` | Fallback template which generates the HTTP error page when no explicit template defined (ex, `HttpError-MethodNotAllowed.cshtml`). You can adjust its appearance by modifying the `HttpError.cshtml` or `HttpError.liquid` views. | ### Example diff --git a/src/docs/reference/modules/DisplayManagement/README.md b/src/docs/reference/modules/DisplayManagement/README.md index 4e52c7b4415..89654186343 100644 --- a/src/docs/reference/modules/DisplayManagement/README.md +++ b/src/docs/reference/modules/DisplayManagement/README.md @@ -108,10 +108,10 @@ This is the same as ` | +| Parameter | Type | Description | +|-----------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `Utc` | `DateTime?` | The date and time to render. If not specified, the current time will be used. | +| `Format` | `string` | The .NET format string. If not specified the long format `dddd, MMMM d, yyyy h:mm:ss tt` will be used. The accepted format can be found at | Tag helper example: @@ -123,10 +123,10 @@ Tag helper example: Renders a relative textual representation of a `Date` and `Time` interval. -| Parameter | Type | Description | -| --------- | ---- |------------ | -| `Utc` | `DateTime?` | The initial date and time. If not specified, the current time will be used. | -| `Origin` | `DateTime?` | The current date and time. If not specified, the current time will be used. | +| Parameter | Type | Description | +|-----------|-------------|-----------------------------------------------------------------------------| +| `Utc` | `DateTime?` | The initial date and time. If not specified, the current time will be used. | +| `Origin` | `DateTime?` | The current date and time. If not specified, the current time will be used. | Tag helper example: @@ -144,8 +144,8 @@ Result: Renders a duration value using the given TimeSpan. -| Parameter | Type | Description | -| --------- | ---- |------------ | +| Parameter | Type | Description | +|------------|-------------|--------------------------| | `timeSpan` | `TimeSpan?` | The time span to render. | Tag helper example: diff --git a/src/docs/reference/modules/DynamicCache/README.md b/src/docs/reference/modules/DynamicCache/README.md index de5e658db09..c5e88dc507b 100644 --- a/src/docs/reference/modules/DynamicCache/README.md +++ b/src/docs/reference/modules/DynamicCache/README.md @@ -51,10 +51,10 @@ If both types of expiration windows are supplied, the sliding policy will be use Here is a list of common cache dependency values that can be used to invalidate cache entries. -| Dependency | Description | -| --------- | ----------- | +| Dependency | Description | +|---------------------------------|------------------------------------------------------------------------------------------------------------------------| | `contentitemid:{ContentItemId}` | Invalidated when a content item described with its unique id (`{ContentItemId}`) is Published, Unpublished or Removed. | -| `alias:{Alias}` | Invalidated when a content item with a specific alias (`{Alias}`) is Published, Unpublished or Removed. | +| `alias:{Alias}` | Invalidated when a content item with a specific alias (`{Alias}`) is Published, Unpublished or Removed. | You can create your own dependencies by calling `RemoveTagAsync()` on `ITagCache` in response to events. @@ -74,15 +74,15 @@ Contexts can be parameterized, for instance `query:age` will pick the `age` valu ### Available Contexts -| Context | Description | -| --------- | ----------- | -| `features` | The list of enabled features. | -| `features:{featureName}` | The specified feature name. | -| `query` | The list of querystring values. | -| `query:{queryName}` | The specified query name value. | -| `user` | The current user. | -| `user.roles` | The roles of the current user. | -| `route` | The current request path. | +| Context | Description | +|--------------------------|---------------------------------| +| `features` | The list of enabled features. | +| `features:{featureName}` | The specified feature name. | +| `query` | The list of querystring values. | +| `query:{queryName}` | The specified query name value. | +| `user` | The current user. | +| `user.roles` | The roles of the current user. | +| `route` | The current request path. | You can create your own Contexts by implementing `ICacheContextProvider`. @@ -112,16 +112,16 @@ Example: `myShape.Cache("myshape")` #### CacheContext members -| Method | Description | -| --------- | ----------- | -| `WithDuration(Timespan)` | Cache the shape for the specified amount of time. | -| `WithSlidingExpiration(Timespan)` | Cache the shape for a specific amount of time with a sliding window. | -| `AddContext(params string[])` | Varies the cached content on the specified context values. | -| `RemoveContext(string)` | Removes the specified context. | -| `AddDependency(params string[])` | Defines the context values that will invalidate the cache entry. | -| `RemoveDependency(string)` | Removes the specified dependency. | -| `AddTag(string)` | Adds a tag to the cache entry to that it can be invalidated by this tag value. | -| `RemoveTag(string)` | Removes the specified tag. | +| Method | Description | +|-----------------------------------|--------------------------------------------------------------------------------| +| `WithDuration(Timespan)` | Cache the shape for the specified amount of time. | +| `WithSlidingExpiration(Timespan)` | Cache the shape for a specific amount of time with a sliding window. | +| `AddContext(params string[])` | Varies the cached content on the specified context values. | +| `RemoveContext(string)` | Removes the specified context. | +| `AddDependency(params string[])` | Defines the context values that will invalidate the cache entry. | +| `RemoveDependency(string)` | Removes the specified dependency. | +| `AddTag(string)` | Adds a tag to the cache entry to that it can be invalidated by this tag value. | +| `RemoveTag(string)` | Removes the specified tag. | !!! note `AddDependency` differs from `AddContext` in that it doesn't store multiple values for each context, @@ -132,14 +132,14 @@ Example: `myShape.Cache("myshape")` When using shape tag helpers, the following attributes can be used: -| Razor Attribute | Liquid Attribute | Description | Required | -| --------- | ----------- | ----------- | ----------- | -| `cache-id` | `cache_id` | The identifier of the cached shape. | Yes | -| `cache-context` | `cache_context` | A set of space/comma-separated context values. | No | -| `cache-dependency` | `cache_dependency` | A set of space/comma-separated dependency values. | No | -| `cache-tag` | `cache_tag` | A set of space/comma-separated tag values. | No | -| `cache-fixed-duration` | `cache_fixed_duration` | The cache duration of the entry, e.g. "00:05:00" for 5 minutes. | No | -| `cache-sliding-duration` | `cache_sliding_duration` | The sliding cache duration of the entry, e.g. "00:05:00" for 5 minutes. | No | +| Razor Attribute | Liquid Attribute | Description | Required | +|--------------------------|--------------------------|-------------------------------------------------------------------------|----------| +| `cache-id` | `cache_id` | The identifier of the cached shape. | Yes | +| `cache-context` | `cache_context` | A set of space/comma-separated context values. | No | +| `cache-dependency` | `cache_dependency` | A set of space/comma-separated dependency values. | No | +| `cache-tag` | `cache_tag` | A set of space/comma-separated tag values. | No | +| `cache-fixed-duration` | `cache_fixed_duration` | The cache duration of the entry, e.g. "00:05:00" for 5 minutes. | No | +| `cache-sliding-duration` | `cache_sliding_duration` | The sliding cache duration of the entry, e.g. "00:05:00" for 5 minutes. | No | For example, to cache the menu shape in a liquid template, you would use this markup: @@ -155,13 +155,13 @@ The liquid `cache` block can be used to cache sections of markup. `cache` blocks #### Arguments -| Liquid Attribute | Description | Required | -| --------- | ----------- | ----------- | -| `id` | The identifier of the cached shape. | Yes (this is the default first argument --- no need to explicitly specify the name of this argument.) | -| `contexts` | A set of space/comma-separated context values. | No | -| `dependencies` | A set of space/comma-separated dependency values. | No | -| `expires_after` | The cache duration of the entry, e.g. "00:05:00" for 5 minutes. | No | -| `expires_sliding` | The sliding cache duration of the entry, e.g. "00:05:00" for 5 minutes. | No | +| Liquid Attribute | Description | Required | +|-------------------|-------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------| +| `id` | The identifier of the cached shape. | Yes (this is the default first argument --- no need to explicitly specify the name of this argument.) | +| `contexts` | A set of space/comma-separated context values. | No | +| `dependencies` | A set of space/comma-separated dependency values. | No | +| `expires_after` | The cache duration of the entry, e.g. "00:05:00" for 5 minutes. | No | +| `expires_sliding` | The sliding cache duration of the entry, e.g. "00:05:00" for 5 minutes. | No | #### Examples @@ -197,12 +197,12 @@ An example might be a cache block around a list of content items from a query -- There are four tags that allow you to alter the current cache scope. It's safe to use these tags even if you don't necessarily know if you're inside a cache block: -| Liquid Tag | Description | Example | -| --------- | ----------- | ----------- | -| `cache_dependency` | Adds a dependency to the current cache scope. | `{% cache_dependency "alias:{Alias}" %}` | -| `cache_expires_on` | Sets a fixed date and time that the cache item will expire. The most restrictive cache policy (i.e. the one with the shortest life) will win in the event of multiple expiry policies being defined for a single block. | `{% cache_expires_on {A DateTime or DateTimeOffset instance %}` (e.g. from a date/time field on a content item) | -| `cache_expires_after` | Sets a timespan relative to when the item was cached that the cache item will expire. The most restrictive cache policy (i.e. the one with the shortest life) will win in the event of multiple expiry policies being defined for a single block. | `{% cache_expires_after "01:00:00" %}` (One hour) | -| `cache_expires_sliding` | Sets a sliding window for the expiry of the cache item. The most restrictive cache policy (i.e. the one with the shortest life) will win in the event of multiple expiry policies being defined for a single block. | `{% cache_expires_sliding "00:01:00" %}` (One minute) | +| Liquid Tag | Description | Example | +|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +| `cache_dependency` | Adds a dependency to the current cache scope. | `{% cache_dependency "alias:{Alias}" %}` | +| `cache_expires_on` | Sets a fixed date and time that the cache item will expire. The most restrictive cache policy (i.e. the one with the shortest life) will win in the event of multiple expiry policies being defined for a single block. | `{% cache_expires_on {A DateTime or DateTimeOffset instance %}` (e.g. from a date/time field on a content item) | +| `cache_expires_after` | Sets a timespan relative to when the item was cached that the cache item will expire. The most restrictive cache policy (i.e. the one with the shortest life) will win in the event of multiple expiry policies being defined for a single block. | `{% cache_expires_after "01:00:00" %}` (One hour) | +| `cache_expires_sliding` | Sets a sliding window for the expiry of the cache item. The most restrictive cache policy (i.e. the one with the shortest life) will win in the event of multiple expiry policies being defined for a single block. | `{% cache_expires_sliding "00:01:00" %}` (One minute) | #### Example diff --git a/src/docs/reference/modules/Elasticsearch/README.md b/src/docs/reference/modules/Elasticsearch/README.md index 11691dac3e9..f4594639c86 100644 --- a/src/docs/reference/modules/Elasticsearch/README.md +++ b/src/docs/reference/modules/Elasticsearch/README.md @@ -188,11 +188,11 @@ Executes a query with the specified name and returns the corresponding content i Verbs: `POST` and `GET` -| Parameter | Example | Description | -| --------- | ---- |------------ | -| `indexName` | `search` | The name of the index to query. | -| `query` | `{ "query": { "match_all": {} }, "size": 10 }` | A JSON object representing the query. | -| `parameters` | `{ size: 3}` | A JSON object representing the parameters of the query. | +| Parameter | Example | Description | +|--------------|------------------------------------------------|---------------------------------------------------------| +| `indexName` | `search` | The name of the index to query. | +| `query` | `{ "query": { "match_all": {} }, "size": 10 }` | A JSON object representing the query. | +| `parameters` | `{ size: 3}` | A JSON object representing the parameters of the query. | ### `api/elasticsearch/documents` @@ -200,11 +200,11 @@ Executes a query with the specified name and returns the corresponding Elasticse Verbs: `POST` and `GET` -| Parameter | Example | Description | -| --------- | ---- |------------ | -| `indexName` | `search` | The name of the index to query. | -| `query` | `{ "query": { "match_all": {} }, "size": 10 }` | A JSON object representing the query. | -| `parameters` | `{ size: 3}` | A JSON object representing the parameters of the query. | +| Parameter | Example | Description | +|--------------|------------------------------------------------|---------------------------------------------------------| +| `indexName` | `search` | The name of the index to query. | +| `query` | `{ "query": { "match_all": {} }, "size": 10 }` | A JSON object representing the query. | +| `parameters` | `{ size: 3}` | A JSON object representing the parameters of the query. | ## Elasticsearch Queries @@ -361,11 +361,11 @@ The equivalent of a `StringField` that will behave the same way as a `keyword` i Here is a small table to compare Lucene and Elasticsearch (string) types: -| Lucene | Elasticsearch | Description | When Stored | Search Query type | -|--------|---------------|---------------------------|-----------------|------------------| -| StringField | Keyword | A field that is indexed but not tokenized: the entire value is indexed as a single token | original value AND indexed | [stored fields](https://www.elastic.co/guide/en/elasticsearch/reference/current/term-level-queries.html) because indexed as a single token. | -| TextField | Text | A field that is indexed and tokenized, without term vectors | original value AND indexed | [analyzed fields](https://www.elastic.co/guide/en/elasticsearch/reference/current/full-text-queries.html). Also known as full-text search | -| StoredField | stored in _source by mapping configuration | A field containing original value (not analyzed) | original value | [stored fields](https://www.elastic.co/guide/en/elasticsearch/reference/current/term-level-queries.html) | +| Lucene | Elasticsearch | Description | When Stored | Search Query type | +|-------------|--------------------------------------------|------------------------------------------------------------------------------------------|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| StringField | Keyword | A field that is indexed but not tokenized: the entire value is indexed as a single token | original value AND indexed | [stored fields](https://www.elastic.co/guide/en/elasticsearch/reference/current/term-level-queries.html) because indexed as a single token. | +| TextField | Text | A field that is indexed and tokenized, without term vectors | original value AND indexed | [analyzed fields](https://www.elastic.co/guide/en/elasticsearch/reference/current/full-text-queries.html). Also known as full-text search | +| StoredField | stored in _source by mapping configuration | A field containing original value (not analyzed) | original value | [stored fields](https://www.elastic.co/guide/en/elasticsearch/reference/current/term-level-queries.html) | ## Video diff --git a/src/docs/reference/modules/Email.Azure/README.md b/src/docs/reference/modules/Email.Azure/README.md index 8dde0ab039b..f64d07d8787 100644 --- a/src/docs/reference/modules/Email.Azure/README.md +++ b/src/docs/reference/modules/Email.Azure/README.md @@ -6,10 +6,10 @@ This module adds Email providers for sending emails through [Azure Communication Enabling this module will introduce a new tab labeled **Azure Communication Services** within the email settings, allowing you to configure the service. To access these settings, navigate to `Configuration` → `Settings` → `Email` and click on the **Azure Communication Services** tab. The following are the available settings -| Setting | Description | -| --- | --- | -| `DefaultSender` | The email of the sender. This will override the `DefaultSender` setting in [`OrchardCore.Email`](../Email/README.md). | -| `ConnectionString` | The ACS connection string that will be used to deliver the email. +| Setting | Description | +|--------------------|-----------------------------------------------------------------------------------------------------------------------| +| `DefaultSender` | The email of the sender. This will override the `DefaultSender` setting in [`OrchardCore.Email`](../Email/README.md). | +| `ConnectionString` | The ACS connection string that will be used to deliver the email. | ## **Default Azure Communication Services** Provider Configuration diff --git a/src/docs/reference/modules/Email.Smtp/README.md b/src/docs/reference/modules/Email.Smtp/README.md index cd54c932117..05620f51e73 100644 --- a/src/docs/reference/modules/Email.Smtp/README.md +++ b/src/docs/reference/modules/Email.Smtp/README.md @@ -8,21 +8,21 @@ To enable the `SMTP` provider, navigate to `Configurations` → `Settings` → ` Here are the available SMTP settings -| Setting | Description | -| --- | --- | -| `DefaultSender` | The email of the sender. | -| `DeliveryMethod` | The method for sending the email, `SmtpDeliveryMethod.Network` (online) or `SmtpDeliveryMethod.SpecifiedPickupDirectory` (offline). | -| `PickupDirectoryLocation` | The directory location for the mailbox (`SmtpDeliveryMethod.SpecifiedPickupDirectory`). | -| `Host` | The SMTP server. | -| `Port` | The SMTP port number. | -| `AutoSelectEncryption` | Whether the SMTP select the encryption automatically. | -| `RequireCredentials` | Whether the SMTP requires the user credentials. | -| `UseDefaultCredentials` | Whether the SMTP will use the default credentials. | -| `EncryptionMethod` | The SMTP encryption method `SmtpEncryptionMethod.None`, `SmtpEncryptionMethod.SSLTLS` or `SmtpEncryptionMethodSTARTTLS`. | -| `UserName` | The username for the sender. | -| `Password` | The password for the sender. | -| `ProxyHost` | The proxy server. | -| `ProxyPort` | The proxy port number. | +| Setting | Description | +|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| `DefaultSender` | The email of the sender. | +| `DeliveryMethod` | The method for sending the email, `SmtpDeliveryMethod.Network` (online) or `SmtpDeliveryMethod.SpecifiedPickupDirectory` (offline). | +| `PickupDirectoryLocation` | The directory location for the mailbox (`SmtpDeliveryMethod.SpecifiedPickupDirectory`). | +| `Host` | The SMTP server. | +| `Port` | The SMTP port number. | +| `AutoSelectEncryption` | Whether the SMTP select the encryption automatically. | +| `RequireCredentials` | Whether the SMTP requires the user credentials. | +| `UseDefaultCredentials` | Whether the SMTP will use the default credentials. | +| `EncryptionMethod` | The SMTP encryption method `SmtpEncryptionMethod.None`, `SmtpEncryptionMethod.SSLTLS` or `SmtpEncryptionMethodSTARTTLS`. | +| `UserName` | The username for the sender. | +| `Password` | The password for the sender. | +| `ProxyHost` | The proxy server. | +| `ProxyPort` | The proxy port number. | !!! note You must configure `ProxyHost` and `ProxyPort` if the SMTP server runs through a proxy server. diff --git a/src/docs/reference/modules/Email/README.md b/src/docs/reference/modules/Email/README.md index 3097913c0d3..cf4cd44409d 100644 --- a/src/docs/reference/modules/Email/README.md +++ b/src/docs/reference/modules/Email/README.md @@ -8,12 +8,12 @@ This module provides the infrastructure necessary to send emails using multiple Enabling the `Email` feature will add a new settings page under `Configurations` → `Settings` → `Email`. You can utilize these settings to set up the default Email provider. The following are the providers that are readily accessible in OrchardCore: -| Provider | Description | -| --- | --- | -| **Simple Mail Transfer Protocol (SMTP)** | The SMTP provider utilizes the SMTP protocol for sending email messages. This provider is a component of the `OrchardCore.Email.Smtp` feature. To activate it, edit the `SMTP` tab in the email settings. For detailed information on configuring the SMTP provider, refer to the [SMTP provider documentation](../Email.Smtp/README.md). | -| **Simple Mail Transfer Protocol (Default SMTP)** | The Default SMTP provider utilization of the SMTP protocol for sending email messages. This provider is a component of the `OrchardCore.Email.Smtp` feature. To activate it, utilize the configuration provider, such as the `appsettings.json` file or environment variables. For detailed information on configuring the SMTP provider, refer to the [SMTP provider documentation](../Email.Smtp/README.md). | -| **Azure Communication Service** | The Azure Communication Service provider utilizes the Azure Communication Services for sending email messages. This provider is a component of the `OrchardCore.Email.Azure` feature. To activate it, edit the `Azure` tab in the email settings. For detailed information on configuring the Azure Communication provider, refer to the [Azure provider documentation](../Email.Azure/README.md). | -| **Default Azure Communication Service** | The Default Azure Communication Service provider utilizes the Azure Communication Services for sending email messages. This provider is a component of the `OrchardCore.Email.Azure` feature. To activate it, utilize the configuration provider, such as the `appsettings.json` file or environment variables. For detailed information on configuring the Azure Communication provider, refer to the [Azure provider documentation](../Email.Azure/README.md). | +| Provider | Description | +|--------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Simple Mail Transfer Protocol (SMTP)** | The SMTP provider utilizes the SMTP protocol for sending email messages. This provider is a component of the `OrchardCore.Email.Smtp` feature. To activate it, edit the `SMTP` tab in the email settings. For detailed information on configuring the SMTP provider, refer to the [SMTP provider documentation](../Email.Smtp/README.md). | +| **Simple Mail Transfer Protocol (Default SMTP)** | The Default SMTP provider utilization of the SMTP protocol for sending email messages. This provider is a component of the `OrchardCore.Email.Smtp` feature. To activate it, utilize the configuration provider, such as the `appsettings.json` file or environment variables. For detailed information on configuring the SMTP provider, refer to the [SMTP provider documentation](../Email.Smtp/README.md). | +| **Azure Communication Service** | The Azure Communication Service provider utilizes the Azure Communication Services for sending email messages. This provider is a component of the `OrchardCore.Email.Azure` feature. To activate it, edit the `Azure` tab in the email settings. For detailed information on configuring the Azure Communication provider, refer to the [Azure provider documentation](../Email.Azure/README.md). | +| **Default Azure Communication Service** | The Default Azure Communication Service provider utilizes the Azure Communication Services for sending email messages. This provider is a component of the `OrchardCore.Email.Azure` feature. To activate it, utilize the configuration provider, such as the `appsettings.json` file or environment variables. For detailed information on configuring the Azure Communication provider, refer to the [Azure provider documentation](../Email.Azure/README.md). | ## Adding Custom Providers diff --git a/src/docs/reference/modules/HealthChecks/README.md b/src/docs/reference/modules/HealthChecks/README.md index da27a734502..b0e706c60a0 100644 --- a/src/docs/reference/modules/HealthChecks/README.md +++ b/src/docs/reference/modules/HealthChecks/README.md @@ -23,8 +23,8 @@ The following configurations are available and can be customized: The supported extensions described as following: -| Extension | Description | -| --- | --- | -| `Url` | The relative URL of the health checks endpoint | +| Extension | Description | +|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| `Url` | The relative URL of the health checks endpoint | | `ShowDetails` | Whether or not to display a detailed information about each health check provider registered in the system, this including: name, description and status. | diff --git a/src/docs/reference/modules/Html/README.md b/src/docs/reference/modules/Html/README.md index bda0473fb96..74f4dd3d8da 100644 --- a/src/docs/reference/modules/Html/README.md +++ b/src/docs/reference/modules/Html/README.md @@ -6,31 +6,31 @@ The following shapes are rendered when the `HtmlBodyPart` is attached to a content type: -| Name | Display Type | Default Location | Model Type | -| ------| ------------ |----------------- | ---------- | -| `HtmlBodyPart` | `Detail` | `Content:5` | `HtmlBodyPartViewModel` | -| `HtmlBodyPart` | `Summary` | `Content:10` | `HtmlBodyPartViewModel` | +| Name | Display Type | Default Location | Model Type | +|----------------|--------------|------------------|-------------------------| +| `HtmlBodyPart` | `Detail` | `Content:5` | `HtmlBodyPartViewModel` | +| `HtmlBodyPart` | `Summary` | `Content:10` | `HtmlBodyPartViewModel` | ### HtmlBodyPartViewModel The following properties are available on the `HtmlBodyPartViewModel` class: -| Property | Type | Description | -| --------- | ---- |------------ | -| `Body` | `string` | The content that was edited. It might contain tokens. | -| `Html` | `string` | The HTML content once all tokens have been processed. | -| `ContentItem` | `ContentItem` | The content item of the part. | -| `HtmlBodyPart` | `HtmlBodyPart` | The `HtmlBodyPart` instance. | -| `TypePartSettings` | `HtmlBodyPartSettings` | The settings of the part. | +| Property | Type | Description | +|--------------------|------------------------|-------------------------------------------------------| +| `Body` | `string` | The content that was edited. It might contain tokens. | +| `Html` | `string` | The HTML content once all tokens have been processed. | +| `ContentItem` | `ContentItem` | The content item of the part. | +| `HtmlBodyPart` | `HtmlBodyPart` | The `HtmlBodyPart` instance. | +| `TypePartSettings` | `HtmlBodyPartSettings` | The settings of the part. | ### HtmlBodyPart The following properties are available on `HtmlBodyPart`: -| Name | Type | Description | -| -----| ---- |------------ | -| `Body` | `string` | The HTML content in the body. It can contain Liquid tags so using it directly might result in unexpected results. Prefer rendering the `HtmlBodyPart` shape instead. | -| `Content` | The raw content of the part. | +| Name | Type | Description | +|---------------|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `Body` | `string` | The HTML content in the body. It can contain Liquid tags so using it directly might result in unexpected results. Prefer rendering the `HtmlBodyPart` shape instead. | +| `Content` | The raw content of the part. | | `ContentItem` | The content item containing this part. | ## Sanitization diff --git a/src/docs/reference/modules/Layers/README.md b/src/docs/reference/modules/Layers/README.md index 440e4d5007d..b41dd3d631f 100644 --- a/src/docs/reference/modules/Layers/README.md +++ b/src/docs/reference/modules/Layers/README.md @@ -28,19 +28,19 @@ _There can be multiple Rules in place for one Layer._ Here are some available conditions: -| Condition | Description | -| -------- | ----------- | -| `Homepage` | Whether the current page is the site homepage | -| `Is anonymous` | Whether the current user is anonymous, i.e. not authenticated. | -| `Is authenticated` | Whether the current user is authenticated. | -| `Role` | A role condition evaluates the current users roles against a value. | -| `Url` | A url condition evaluates the current url against a value. | -| `Culture` | A culture condition evaluates the current ui culture against a value. | -| `Content Type` | A content type condition evaluates the currently displayed content types against a value. | -| `Javascript` | A script condition written in JavaScript. | -| `All` | An all condition group contains other conditions which are all required to be true. | -| `Any` | An any condition group contains other conditions but only requires any condition to be true. | -| `Boolean` | A boolean condition evaluating to `true` or `false`. | +| Condition | Description | +|--------------------|----------------------------------------------------------------------------------------------| +| `Homepage` | Whether the current page is the site homepage | +| `Is anonymous` | Whether the current user is anonymous, i.e. not authenticated. | +| `Is authenticated` | Whether the current user is authenticated. | +| `Role` | A role condition evaluates the current users roles against a value. | +| `Url` | A url condition evaluates the current url against a value. | +| `Culture` | A culture condition evaluates the current ui culture against a value. | +| `Content Type` | A content type condition evaluates the currently displayed content types against a value. | +| `Javascript` | A script condition written in JavaScript. | +| `All` | An all condition group contains other conditions which are all required to be true. | +| `Any` | An any condition group contains other conditions but only requires any condition to be true. | +| `Boolean` | A boolean condition evaluating to `true` or `false`. | Ex: The `Always` Layer has a `Boolean Condition` set to `true`, so widgets on this Layer will always be shown. diff --git a/src/docs/reference/modules/Liquid/README.md b/src/docs/reference/modules/Liquid/README.md index 63a48b3e5cc..9fe53679738 100644 --- a/src/docs/reference/modules/Liquid/README.md +++ b/src/docs/reference/modules/Liquid/README.md @@ -314,22 +314,22 @@ When available, represents the current content item being rendered. The following properties are available on the `ContentItem` object. -| Property | Example | Description | -| --------- | ---- |------------ | -| `Id` | `12` | The id of the document in the database. | -| `ContentItemId` | `4qs7mv9xc4ttg5ktm61qj9dy5d` | The common identifier of all versions of the content item. | -| `ContentItemVersionId` | `4jp895achc3hj1qy7xq8f10nmv` | The unique identifier of the content item version. | -| `DisplayText` | `Blog` | The title of a content item. Can be edited manually by using the TitlePart. | -| `Number` | `6` | The version number. | -| `Owner` | `admin` | The username of the creator of this content item. | -| `Author` | `admin` | The username of the editor of this version. | -| `Published` | `true` | Whether this content item version is published or not. | -| `Latest` | `true` | Whether this content item version is the latest of the content item. | -| `ContentType` | `BlogPost` | The content type. | -| `CreatedUtc` | `2017-05-25 00:27:22.647` | When the content item was first created or first published. | -| `ModifiedUtc` | `2017-05-25 00:27:22.647` | When the content item version was created. | -| `PublishedUtc` | `2017-05-25 00:27:22.647` | When the content item was last published. | -| `Content` | `{ ... }` | A document containing all the content properties. See below for usage. | +| Property | Example | Description | +|------------------------|------------------------------|-----------------------------------------------------------------------------| +| `Id` | `12` | The id of the document in the database. | +| `ContentItemId` | `4qs7mv9xc4ttg5ktm61qj9dy5d` | The common identifier of all versions of the content item. | +| `ContentItemVersionId` | `4jp895achc3hj1qy7xq8f10nmv` | The unique identifier of the content item version. | +| `DisplayText` | `Blog` | The title of a content item. Can be edited manually by using the TitlePart. | +| `Number` | `6` | The version number. | +| `Owner` | `admin` | The username of the creator of this content item. | +| `Author` | `admin` | The username of the editor of this version. | +| `Published` | `true` | Whether this content item version is published or not. | +| `Latest` | `true` | Whether this content item version is the latest of the content item. | +| `ContentType` | `BlogPost` | The content type. | +| `CreatedUtc` | `2017-05-25 00:27:22.647` | When the content item was first created or first published. | +| `ModifiedUtc` | `2017-05-25 00:27:22.647` | When the content item version was created. | +| `PublishedUtc` | `2017-05-25 00:27:22.647` | When the content item was last published. | +| `Content` | `{ ... }` | A document containing all the content properties. See below for usage. | #### Content property @@ -365,10 +365,10 @@ Represents the authenticated user for the current request. The following properties are available on the `User` object. -| Property | Example | Description | -| --------- | ---- |------------ | -| `Identity.Name` | `admin` | The name of the authenticated user. | -| `Identity.Claims` | | The claims of the authenticated user. | +| Property | Example | Description | +|-------------------|---------|---------------------------------------| +| `Identity.Name` | `admin` | The name of the authenticated user. | +| `Identity.Claims` | | The claims of the authenticated user. | ##### user_email filter @@ -392,17 +392,17 @@ Loads a single or multiple user objects from the database by id(s). The resulting object has access to the following properties: -| Property | Example | Description | -| --------- | ---- |------------ | -| `UserId` | `42z3ps88pm8d40zn9cfwbee45c` | The id of the authenticated user. | -| `UserName` | `admin` | The name of the authenticated user. | -| `NormalizedUserName` | `ADMIN` | The normailzed name of the authenticated user. | -| `Email` | `admin@gmail.com` | The email of the authenticated user. | -| `NormailizedEmail` | `ADMIN@GMAIL.COM` | The normalized email of the authenticated user. | -| `EmailConfirmed` | `true` | True if the user has confirmed his email or if the email confirmation is not required | -| `IsEnabled` | `true` | True if the user is enabled | -| `RoleNames` | `[Editor,Contributor]` | An array of role names assigned to the user | -| `Properties` | `UserProfile.FirstName.Text` | Holds the Custom Users Settings of the user. | +| Property | Example | Description | +|----------------------|------------------------------|---------------------------------------------------------------------------------------| +| `UserId` | `42z3ps88pm8d40zn9cfwbee45c` | The id of the authenticated user. | +| `UserName` | `admin` | The name of the authenticated user. | +| `NormalizedUserName` | `ADMIN` | The normailzed name of the authenticated user. | +| `Email` | `admin@gmail.com` | The email of the authenticated user. | +| `NormailizedEmail` | `ADMIN@GMAIL.COM` | The normalized email of the authenticated user. | +| `EmailConfirmed` | `true` | True if the user has confirmed his email or if the email confirmation is not required | +| `IsEnabled` | `true` | True if the user is enabled | +| `RoleNames` | `[Editor,Contributor]` | An array of role names assigned to the user | +| `Properties` | `UserProfile.FirstName.Text` | Holds the Custom Users Settings of the user. | You can use this filter to load the user information of the current authenticated user like this. @@ -453,20 +453,20 @@ Checks if the user has a claim of the specified type Gives access to the current site settings, e.g `Site.SiteName`. -| Property | Example | Description | -| -------- | ------- |------------ | -| `BaseUrl` | | The base URL of the site. | -| `Calendar` | | The site's calendar. | -| `MaxPagedCount` | `0` | The maximum number of pages that can be paged. | -| `MaxPageSize` | `100` | The maximum page size that can be set by a user. | -| `PageSize` | `10` | The default page size of lists. | -| `SiteName` | `My Site` | The friendly name of the site. | -| `SuperUser` | `4kxfgfrxqmdpnt5n508cqvpvca` | The user id of the site's super user. | -| `TimeZoneId` | `America/Los_Angeles` | The site's time zone id as per the tz database, c.f., | -| `UseCdn` | `false` | Enable/disable the use of a CDN. | -| `ResourceDebugMode` | `Disabled` | Provides options for whether src or debug-src is used for loading scripts and stylesheets | -| `CdnBaseUrl` | `https://localhost:44300` | If provided a CDN Base url is prepended to local scripts and stylesheets | -| `Meta` | | The meta to render in the head section of the current theme.| +| Property | Example | Description | +|---------------------|------------------------------|----------------------------------------------------------------------------------------------------------------------| +| `BaseUrl` | | The base URL of the site. | +| `Calendar` | | The site's calendar. | +| `MaxPagedCount` | `0` | The maximum number of pages that can be paged. | +| `MaxPageSize` | `100` | The maximum page size that can be set by a user. | +| `PageSize` | `10` | The default page size of lists. | +| `SiteName` | `My Site` | The friendly name of the site. | +| `SuperUser` | `4kxfgfrxqmdpnt5n508cqvpvca` | The user id of the site's super user. | +| `TimeZoneId` | `America/Los_Angeles` | The site's time zone id as per the tz database, c.f., | +| `UseCdn` | `false` | Enable/disable the use of a CDN. | +| `ResourceDebugMode` | `Disabled` | Provides options for whether src or debug-src is used for loading scripts and stylesheets | +| `CdnBaseUrl` | `https://localhost:44300` | If provided a CDN Base url is prepended to local scripts and stylesheets | +| `Meta` | | The meta to render in the head section of the current theme. | ### Request @@ -474,27 +474,27 @@ Represents the current request. The following properties are available on the `Request` object. -| Property | Example | Description | -| --------- | ---- |------------ | -| `QueryString` | `?sort=name&page=1` | The escaped query string with the leading '?' character. | -| `UriQueryString` | `?sort=name&page=1` | The query string escaped in a way which is correct for combining into the URI representation. | -| `ContentType` | `application/x-www-form-urlencoded; charset=UTF-8` | The `Content-Type` header. | -| `ContentLength` | `600` | The `Content-Length` header. | -| `Cookies` | Usage: `Request.Cookies.orchauth_Default` | The collection of cookies for this request. | -| `Headers` | Usage: `Request.Headers.accept` | The request headers. Each property value is an array of values.| -| `Query` | Usage: `Request.Query.sort` | The query value collection parsed from `QueryString`. Each property value is an array of values. | -| `Form` | Usage: `Request.Form.value` | The collection of form values. | -| `Protocol` | `https` | The protocol of this request. | -| `Path` | `/OrchardCore.ContentPreview/Preview/Render` | The unescaped path of the request. | -| `UriPath` | `/OrchardCore.ContentPreview/Preview/Render` | The path escaped in a way which is correct for combining into the URI representation. | -| `PathBase` | `/mytenant` | The unescaped base path of the request. | -| `UriPathBase` | `/mytenant` | The base path escaped in a way which is correct for combining into the URI representation. | -| `Host` | `localhost:44300` | The unescaped `Host` header. May contain the port. | -| `UriHost` | `localhost:44300` | The `Host` header properly formatted and encoded for use in a URI in a HTTP header. | -| `IsHttps` | `true` | True if the scheme of the request is `https`. | -| `Scheme` | `https` | The scheme of the request. | -| `Method` | `GET` | The HTTP method. | -| `Route` | Usage: `Request.Route.controller` | The route values for this request. | +| Property | Example | Description | +|------------------|----------------------------------------------------|--------------------------------------------------------------------------------------------------| +| `QueryString` | `?sort=name&page=1` | The escaped query string with the leading '?' character. | +| `UriQueryString` | `?sort=name&page=1` | The query string escaped in a way which is correct for combining into the URI representation. | +| `ContentType` | `application/x-www-form-urlencoded; charset=UTF-8` | The `Content-Type` header. | +| `ContentLength` | `600` | The `Content-Length` header. | +| `Cookies` | Usage: `Request.Cookies.orchauth_Default` | The collection of cookies for this request. | +| `Headers` | Usage: `Request.Headers.accept` | The request headers. Each property value is an array of values. | +| `Query` | Usage: `Request.Query.sort` | The query value collection parsed from `QueryString`. Each property value is an array of values. | +| `Form` | Usage: `Request.Form.value` | The collection of form values. | +| `Protocol` | `https` | The protocol of this request. | +| `Path` | `/OrchardCore.ContentPreview/Preview/Render` | The unescaped path of the request. | +| `UriPath` | `/OrchardCore.ContentPreview/Preview/Render` | The path escaped in a way which is correct for combining into the URI representation. | +| `PathBase` | `/mytenant` | The unescaped base path of the request. | +| `UriPathBase` | `/mytenant` | The base path escaped in a way which is correct for combining into the URI representation. | +| `Host` | `localhost:44300` | The unescaped `Host` header. May contain the port. | +| `UriHost` | `localhost:44300` | The `Host` header properly formatted and encoded for use in a URI in a HTTP header. | +| `IsHttps` | `true` | True if the scheme of the request is `https`. | +| `Scheme` | `https` | The scheme of the request. | +| `Method` | `GET` | The HTTP method. | +| `Route` | Usage: `Request.Route.controller` | The route values for this request. | ### Culture @@ -502,15 +502,15 @@ Represents the current culture. The following properties are available on the `Culture` object. -| Property | Example | Description | -| --------- | ---- |------------ | -| `Name` | `en-US` | The ISO language code of the current culture. | -| `Dir` | `rtl` | The text writing direction. | -| `DisplayName` | `English (United States)` | The display name of the current culture. | -| `NativeName` | `English (United States)` | The native name of the current culture. | -| `TwoLetterISOLanguageName` | `en` | The two-letter ISO language name of the current culture. | -| `SupportedCultures` | `['en-US', 'fr' ]` | The list of the currently supported cultures in the site. Each result can be chained with other properties listed in this table. | -| `DefaultCulture` | `en-US` | The default culture as defined in the settings. | +| Property | Example | Description | +|----------------------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------| +| `Name` | `en-US` | The ISO language code of the current culture. | +| `Dir` | `rtl` | The text writing direction. | +| `DisplayName` | `English (United States)` | The display name of the current culture. | +| `NativeName` | `English (United States)` | The native name of the current culture. | +| `TwoLetterISOLanguageName` | `en` | The two-letter ISO language name of the current culture. | +| `SupportedCultures` | `['en-US', 'fr' ]` | The list of the currently supported cultures in the site. Each result can be chained with other properties listed in this table. | +| `DefaultCulture` | `en-US` | The default culture as defined in the settings. | ##### Usage @@ -530,12 +530,12 @@ Represents the current hosting environment. The following properties are available on the `Environment` object. -| Property | Description | -| --------- |------------ | +| Property | Description | +|-----------------|------------------------------------------------------------------| | `IsDevelopment` | Checks if the current hosting environment name is `Development`. | -| `IsStaging` | Checks if the current hosting environment name is `Staging`. | -| `IsProduction` | Checks if the current hosting environment name is `Production`. | -| `Name` | Gets hosting environment name. | +| `IsStaging` | Checks if the current hosting environment name is `Staging`. | +| `IsProduction` | Checks if the current hosting environment name is `Production`. | +| `Name` | Gets hosting environment name. | ### HttpContext @@ -543,9 +543,9 @@ Represents the HttpContext of the current request. The following properties are available on the `HttpContext` object. -| Property | Example | Description | -| --------- | ---- |------------ | -| `Items` | `HttpContext.Items["Item1"]` | Returns an item with key Item1 | +| Property | Example | Description | +|----------|------------------------------|--------------------------------| +| `Items` | `HttpContext.Items["Item1"]` | Returns an item with key Item1 | #### httpcontext_add_items @@ -565,13 +565,13 @@ Represents the tracking consent feature of the current request. The following properties are available on the `TrackingConsent` object. -| Property | Example | Description | -| --------- | ---- |------------ | -| `CanTrack` | `true` | Indicates if tracking is allowed. | -| `HasConsent` | `true` | Indicates if the user has given consent for tracking. | -| `IsConsentNeeded` | `false` | Indicates if consent is needed for tracking. | -| `CookieName` | `ConsentCookie` | The name of the consent cookie. | -| `CookieValue` | `true` | The value of the consent cookie. | +| Property | Example | Description | +|-------------------|-----------------|-------------------------------------------------------| +| `CanTrack` | `true` | Indicates if tracking is allowed. | +| `HasConsent` | `true` | Indicates if the user has given consent for tracking. | +| `IsConsentNeeded` | `false` | Indicates if consent is needed for tracking. | +| `CookieName` | `ConsentCookie` | The name of the consent cookie. | +| `CookieValue` | `true` | The value of the consent cookie. | #### Usage diff --git a/src/docs/reference/modules/Lists/README.md b/src/docs/reference/modules/Lists/README.md index 2dd00aaea42..e29f18aeef0 100644 --- a/src/docs/reference/modules/Lists/README.md +++ b/src/docs/reference/modules/Lists/README.md @@ -8,40 +8,40 @@ A ListPart allows you to associate content items to a parent container (Ex: A bl These shapes are available for theming when a `ListPart` is attached to a content item. -| Name | Display Type | Default Location | Model Type | -| ------| ------------ |----------------- | ---------- | -| `ListPart` | `Detail`, `DetailAdmin` | `Content:10` | `ListPartViewModel` | +| Name | Display Type | Default Location | Model Type | +|------------|-------------------------|------------------|---------------------| +| `ListPart` | `Detail`, `DetailAdmin` | `Content:10` | `ListPartViewModel` | ### `ListPartViewModel` The following properties are available on the `ListPartViewModel` class. -| Property | Type | Description | -| --------- | ---- |------------ | -| `ListPart` | `ListPart` | The `ListPart` instance. | -| `ContentItems` | `IEnumerable` | The content items the part is made of. | -| `ContainedContentTypeDefinitions` | `IEnumerable` | The content types the list accepts. | -| `Context` | `BuildPartDisplayContext` | The current display context. | -| `Pager` | `dynamic` | The pager for the list. | +| Property | Type | Description | +|-----------------------------------|--------------------------------------|----------------------------------------| +| `ListPart` | `ListPart` | The `ListPart` instance. | +| `ContentItems` | `IEnumerable` | The content items the part is made of. | +| `ContainedContentTypeDefinitions` | `IEnumerable` | The content types the list accepts. | +| `Context` | `BuildPartDisplayContext` | The current display context. | +| `Pager` | `dynamic` | The pager for the list. | ### `ListPart` The following properties are available on the `ListPart` class. -| Name | Type | Description | -| -----| ---- |------------ | -| `Content` | The raw content of the part. | +| Name | Type | Description | +|---------------|----------------------------------------|-------------| +| `Content` | The raw content of the part. | | `ContentItem` | The content item containing this part. | ### `ListPartSettings` The following properties are available on the `ListPartSettings` class. -| Name | Type | Description | -| -----| ---- |------------ | -| `PageSize` | The number of content items returned per page. | -| `EnableOrdering` | Flag to enable drag and drop ordering of content items. | -| `ContainedContentTypes` | The content types that may be contained by this part. | +| Name | Type | Description | +|-------------------------|---------------------------------------------------------|-------------| +| `PageSize` | The number of content items returned per page. | +| `EnableOrdering` | Flag to enable drag and drop ordering of content items. | +| `ContainedContentTypes` | The content types that may be contained by this part. | ### Template diff --git a/src/docs/reference/modules/Lucene/README.md b/src/docs/reference/modules/Lucene/README.md index d4f5b0e3f59..260f9bbef86 100644 --- a/src/docs/reference/modules/Lucene/README.md +++ b/src/docs/reference/modules/Lucene/README.md @@ -55,11 +55,11 @@ Executes a query with the specified name and returns the corresponding content i Verbs: `POST` and `GET` -| Parameter | Example | Description | -| --------- | ---- |------------ | -| `indexName` | `search` | The name of the index to query. | -| `query` | `{ "query": { "match_all": {} }, "size": 10 }` | A JSON object representing the query. | -| `parameters` | `{ size: 3}` | A JSON object representing the parameters of the query. | +| Parameter | Example | Description | +|--------------|------------------------------------------------|---------------------------------------------------------| +| `indexName` | `search` | The name of the index to query. | +| `query` | `{ "query": { "match_all": {} }, "size": 10 }` | A JSON object representing the query. | +| `parameters` | `{ size: 3}` | A JSON object representing the parameters of the query. | ### `api/lucene/documents` @@ -68,11 +68,11 @@ Only the stored fields are returned. Verbs: `POST` and `GET` -| Parameter | Example | Description | -| --------- | ---- |------------ | -| `indexName` | `search` | The name of the index to query. | -| `query` | `{ "query": { "match_all": {} }, "size": 10 }` | A JSON object representing the query. | -| `parameters` | `{ size: 3}` | A JSON object representing the parameters of the query. | +| Parameter | Example | Description | +|--------------|------------------------------------------------|---------------------------------------------------------| +| `indexName` | `search` | The name of the index to query. | +| `query` | `{ "query": { "match_all": {} }, "size": 10 }` | A JSON object representing the query. | +| `parameters` | `{ size: 3}` | A JSON object representing the parameters of the query. | ## Lucene Worker (`OrchardCore.Search.Lucene.Worker`) diff --git a/src/docs/reference/modules/Markdown/README.md b/src/docs/reference/modules/Markdown/README.md index 90d6446f42f..1e6f6dc066a 100644 --- a/src/docs/reference/modules/Markdown/README.md +++ b/src/docs/reference/modules/Markdown/README.md @@ -6,32 +6,32 @@ The following shapes are rendered when the `MarkdownBodyPart` is attached to a content type: -| Name | Display Type | Default Location | Model Type | -| ------| ------------ |----------------- | ---------- | -| `MarkdownBodyPart` | `Detail` | `Content:5` | `MarkdownBodyPartViewModel` | -| `MarkdownBodyPart` | `Summary` | `Content:10` | `MarkdownBodyPartViewModel` | +| Name | Display Type | Default Location | Model Type | +|--------------------|--------------|------------------|-----------------------------| +| `MarkdownBodyPart` | `Detail` | `Content:5` | `MarkdownBodyPartViewModel` | +| `MarkdownBodyPart` | `Summary` | `Content:10` | `MarkdownBodyPartViewModel` | ### `BodyPartViewModel` The following properties are available on the `MarkdownBodyPartViewModel` class. -| Property | Type | Description | -| --------- | ---- |------------ | -| `Markdown` | `string` | The Markdown value after all tokens have been processed. | -| `Html` | `string` | The HTML content resulting from the Markdown source. | -| `ContentItem` | `ContentItem` | The content item of the part. | -| `MarkdownBodyPart` | `MarkdownBodyPart` | The `MarkdownBodyPart` instance. | -| `TypePartSettings` | `MarkdownBodyPartSettings` | The settings of the part. | +| Property | Type | Description | +|--------------------|----------------------------|----------------------------------------------------------| +| `Markdown` | `string` | The Markdown value after all tokens have been processed. | +| `Html` | `string` | The HTML content resulting from the Markdown source. | +| `ContentItem` | `ContentItem` | The content item of the part. | +| `MarkdownBodyPart` | `MarkdownBodyPart` | The `MarkdownBodyPart` instance. | +| `TypePartSettings` | `MarkdownBodyPartSettings` | The settings of the part. | ### `MarkdownBodyPart` The following properties are available on `MarkdownBodyPart`: -| Name | Type | Description | -| -----| ---- |------------ | -| `Markdown` | The Markdown content. It can contain Liquid tags so using it directly might result in unexpected results. Prefer rendering the `MarkdownBodyPart` shape instead. | -| `Content` | The raw content of the part. | -| `ContentItem` | The content item containing this part. | +| Name | Type | Description | +|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| `Markdown` | The Markdown content. It can contain Liquid tags so using it directly might result in unexpected results. Prefer rendering the `MarkdownBodyPart` shape instead. | +| `Content` | The raw content of the part. | +| `ContentItem` | The content item containing this part. | ### `MarkdownField` @@ -40,13 +40,13 @@ The shape base class is of type `MarkdownFieldViewModel`. The following properties are available on the `MarkdownFieldViewModel` class. -| Property | Type | Description | -| --------- | ---- |------------ | -| `Markdown` | `string` | The Markdown value once all tokens have been processed. | -| `Html` | `string` | The HTML content resulting from the Markdown source. | -| `Field` | `MarkdownField` | The `MarkdownField` instance. | -| `Part` | `ContentPart` | The part this field is attached to. | -| `PartFieldDefinition` | `ContentPartFieldDefinition` | The part field definition. | +| Property | Type | Description | +|-----------------------|------------------------------|---------------------------------------------------------| +| `Markdown` | `string` | The Markdown value once all tokens have been processed. | +| `Html` | `string` | The HTML content resulting from the Markdown source. | +| `Field` | `MarkdownField` | The `MarkdownField` instance. | +| `Part` | `ContentPart` | The part this field is attached to. | +| `PartFieldDefinition` | `ContentPartFieldDefinition` | The part field definition. | ## Sanitization @@ -145,37 +145,37 @@ The following configuration values are used by default and can be customized: The supported extensions described as following: -| Extension | Description | -| --- | --- | -| `advanced` | Enable advanced markdown extensions | -| `pipetables` | Adds a pipe table | -| `gfm-pipetables` | Adds a pipe table with using header for column count | -| `hardlinebreak` | Uses the softline break as hardline break | -| `footnotes` | Allows a footnotes | -| `footers` | Adds footer block | -| `citations` | Adds citation | -| `attributes` | Allows to attach HTML attributes | -| `gridtables` | Adds grid table | -| `abbreviations` | Stores an abbreviation object at the document level | -| `emojis` | Supports the emojis and smileys | -| `definitionlists` | Adds a definition list | -| `customcontainers` | Adds a block custom container | -| `figures` | Adds figure | -| `mathematics` | Enable mathematics symbols | -| `bootstrap` | Enable bootstrap classes | -| `medialinks` | Extends image Markdown links in case a video or an audio file is linked and output proper link | -| `smartypants` | Uses the SmartyPants | -| `autoidentifiers` | Uses the auto-identifier | -| `tasklists` | Adds the task list | -| `diagrams` | Allows diagrams | -| `nofollowlinks` | Add rel=nofollow to all links rendered to HTML | -| `noopenerlinks` | | -| `noreferrerlinks` | Adds rel=nofollow to all links rendered to HTML | -| `nohtml` | Disables html support | -| `yaml` | Parses a YAML format into the MarkdownDocument | -| `nonascii-noescape` | Disables URI escape with % characters for non-US-ASCII characters | -| `autolinks` | Enable autolinks from text `http://`, `https://`, `ftp://`, `mailto:`, `www.xxx.yyy` | -| `globalization` | Adds support for right-to-left content by adding appropriate html attribtues | +| Extension | Description | +|---------------------|------------------------------------------------------------------------------------------------| +| `advanced` | Enable advanced markdown extensions | +| `pipetables` | Adds a pipe table | +| `gfm-pipetables` | Adds a pipe table with using header for column count | +| `hardlinebreak` | Uses the softline break as hardline break | +| `footnotes` | Allows a footnotes | +| `footers` | Adds footer block | +| `citations` | Adds citation | +| `attributes` | Allows to attach HTML attributes | +| `gridtables` | Adds grid table | +| `abbreviations` | Stores an abbreviation object at the document level | +| `emojis` | Supports the emojis and smileys | +| `definitionlists` | Adds a definition list | +| `customcontainers` | Adds a block custom container | +| `figures` | Adds figure | +| `mathematics` | Enable mathematics symbols | +| `bootstrap` | Enable bootstrap classes | +| `medialinks` | Extends image Markdown links in case a video or an audio file is linked and output proper link | +| `smartypants` | Uses the SmartyPants | +| `autoidentifiers` | Uses the auto-identifier | +| `tasklists` | Adds the task list | +| `diagrams` | Allows diagrams | +| `nofollowlinks` | Add rel=nofollow to all links rendered to HTML | +| `noopenerlinks` | | +| `noreferrerlinks` | Adds rel=nofollow to all links rendered to HTML | +| `nohtml` | Disables html support | +| `yaml` | Parses a YAML format into the MarkdownDocument | +| `nonascii-noescape` | Disables URI escape with % characters for non-US-ASCII characters | +| `autolinks` | Enable autolinks from text `http://`, `https://`, `ftp://`, `mailto:`, `www.xxx.yyy` | +| `globalization` | Adds support for right-to-left content by adding appropriate html attribtues | ## Markdown Pipeline diff --git a/src/docs/reference/modules/Menu/README.md b/src/docs/reference/modules/Menu/README.md index 1a286c4fafd..28eedc769ab 100644 --- a/src/docs/reference/modules/Menu/README.md +++ b/src/docs/reference/modules/Menu/README.md @@ -6,16 +6,16 @@ The `Menu` shape is used to render a Menu. -| Property | Description | -| --------- | ------------ | -| `Model.ContentItemId` | If defined, contains the content item identifier of the menu to render. | -| `Model.Items` | The list of menu items shapes for the menu. These are shapes of type `MenuItem`. | +| Property | Description | +|------------------------|---------------------------------------------------------------------------------------| +| `Model.ContentItemId` | If defined, contains the content item identifier of the menu to render. | +| `Model.Items` | The list of menu items shapes for the menu. These are shapes of type `MenuItem`. | | `Model.Differentiator` | If defined, contains the formatted name of the menu (title). For instance `MainMenu`. | #### Menu Alternates -| Definition | Template | Filename| -| ---------- | --------- | ------------ | +| Definition | Template | Filename | +|--------------------------|------------------|------------------------| | `Menu__[Differentiator]` | `Menu__MainMenu` | `Menu-MainMenu.cshtml` | #### Menu Example @@ -52,24 +52,24 @@ The `Menu` shape is used to render a Menu. The `MenuItem` shape is used to render a menu item. -| Property | Description | -| --------- | ------------ | -| `Model.Menu` | The `Menu` shape owning this item. | -| `Model.ContentItem` | The content item representing this menu item. | -| `Model.Level` | The level of the menu item. `0` for top level menu items. | -| `Model.Items` | The list of sub menu items shapes. These are shapes of type `MenuItem`. | +| Property | Description | +|------------------------|-------------------------------------------------------------------------------| +| `Model.Menu` | The `Menu` shape owning this item. | +| `Model.ContentItem` | The content item representing this menu item. | +| `Model.Level` | The level of the menu item. `0` for top level menu items. | +| `Model.Items` | The list of sub menu items shapes. These are shapes of type `MenuItem`. | | `Model.Differentiator` | If defined, contains the formatted name of the menu. For instance `MainMenu`. | #### MenuItem Alternates -| Definition | Template | Filename| -| ---------- | --------- | ------------ | -| `MenuItem__level__[level]` | `MenuItem__level__2` | `MenuItem-level-2.cshtml` | -| `MenuItem__[ContentType]` | `MenuItem__HtmlMenuItem` | `MenuItem-HtmlMenuItem.cshtml` | -| `MenuItem__[ContentType]__level__[level]` | `MenuItem__HtmlMenuItem__level__2` | `MenuItem-HtmlMenuItem-level-2.cshtml` | -| `MenuItem__[MenuName]` | `MenuItem__MainMenu` | `MenuItem-MainMenu.cshtml` | -| `MenuItem__[MenuName]__level__[level]` | `MenuItem__MainMenu__level__2` | `MenuItem-MainMenu-level-2.cshtml` | -| `MenuItem__[MenuName]__[ContentType]` | `MenuItem__MainMenu__HtmlMenuItem` | `MenuItem-MainMenu-HtmlMenuItem.cshtml` | +| Definition | Template | Filename | +|-------------------------------------------------------|----------------------------------------------|-------------------------------------------------| +| `MenuItem__level__[level]` | `MenuItem__level__2` | `MenuItem-level-2.cshtml` | +| `MenuItem__[ContentType]` | `MenuItem__HtmlMenuItem` | `MenuItem-HtmlMenuItem.cshtml` | +| `MenuItem__[ContentType]__level__[level]` | `MenuItem__HtmlMenuItem__level__2` | `MenuItem-HtmlMenuItem-level-2.cshtml` | +| `MenuItem__[MenuName]` | `MenuItem__MainMenu` | `MenuItem-MainMenu.cshtml` | +| `MenuItem__[MenuName]__level__[level]` | `MenuItem__MainMenu__level__2` | `MenuItem-MainMenu-level-2.cshtml` | +| `MenuItem__[MenuName]__[ContentType]` | `MenuItem__MainMenu__HtmlMenuItem` | `MenuItem-MainMenu-HtmlMenuItem.cshtml` | | `MenuItem__[MenuName]__[ContentType]__level__[level]` | `MenuItem__MainMenu__HtmlMenuItem__level__2` | `MenuItem-MainMenu-HtmlMenuItem-level-2.cshtml` | #### MenuItem Example @@ -132,24 +132,24 @@ The `MenuItemLink` shape is used to render a menu item link. This shape is created by morphing a `MenuItem` shape into a `MenuItemLink`. Hence all the properties available on the `MenuItem` shape are still available. -| Property | Description | -| --------- | ------------ | -| `Model.Menu` | The `Menu` shape owning this item. | -| `Model.ContentItem` | The content item representing this menu item. | -| `Model.Level` | The level of the menu item. `0` for top level menu items. | -| `Model.Items` | The list of sub menu items shapes. These are shapes of type `MenuItem`. | +| Property | Description | +|------------------------|-------------------------------------------------------------------------------| +| `Model.Menu` | The `Menu` shape owning this item. | +| `Model.ContentItem` | The content item representing this menu item. | +| `Model.Level` | The level of the menu item. `0` for top level menu items. | +| `Model.Items` | The list of sub menu items shapes. These are shapes of type `MenuItem`. | | `Model.Differentiator` | If defined, contains the formatted name of the menu. For instance `MainMenu`. | #### `MenuItemLink` Alternates -| Definition | Template | Filename| -| ---------- | --------- | ------------ | -| `MenuItemLink__level__[level]` | `MenuItemLink__level__2` | `MenuItemLink-level-2.cshtml` | -| `MenuItemLink__[ContentType]` | `MenuItemLink__HtmlMenuItem` | `MenuItemLink-HtmlMenuItem.cshtml` | -| `MenuItemLink__[ContentType]__level__[level]` | `MenuItemLink__HtmlMenuItem__level__2` | `MenuItemLink-HtmlMenuItem-level-2.cshtml` | -| `MenuItemLink__[MenuName]` | `MenuItemLink__MainMenu` | `MenuItemLink-MainMenu.cshtml` | -| `MenuItemLink__[MenuName]__level__[level]` | `MenuItemLink__MainMenu__level__2` | `MenuItemLink-MainMenu-level-2.cshtml` | -| `MenuItemLink__[MenuName]__[ContentType]` | `MenuItemLink__MainMenu__HtmlMenuItem` | `MenuItemLink-MainMenu-HtmlMenuItem.cshtml` | +| Definition | Template | Filename | +|-----------------------------------------------------------|--------------------------------------------------|-----------------------------------------------------| +| `MenuItemLink__level__[level]` | `MenuItemLink__level__2` | `MenuItemLink-level-2.cshtml` | +| `MenuItemLink__[ContentType]` | `MenuItemLink__HtmlMenuItem` | `MenuItemLink-HtmlMenuItem.cshtml` | +| `MenuItemLink__[ContentType]__level__[level]` | `MenuItemLink__HtmlMenuItem__level__2` | `MenuItemLink-HtmlMenuItem-level-2.cshtml` | +| `MenuItemLink__[MenuName]` | `MenuItemLink__MainMenu` | `MenuItemLink-MainMenu.cshtml` | +| `MenuItemLink__[MenuName]__level__[level]` | `MenuItemLink__MainMenu__level__2` | `MenuItemLink-MainMenu-level-2.cshtml` | +| `MenuItemLink__[MenuName]__[ContentType]` | `MenuItemLink__MainMenu__HtmlMenuItem` | `MenuItemLink-MainMenu-HtmlMenuItem.cshtml` | | `MenuItemLink__[MenuName]__[ContentType]__level__[level]` | `MenuItemLink__MainMenu__HtmlMenuItem__level__2` | `MenuItemLink-MainMenu-HtmlMenuItem-level-2.cshtml` | #### `MenuItemLink` Example @@ -195,10 +195,10 @@ Because menus are cached, this must be done from javascript. OrchardCore.Menu mo function activateLinks(options,cb) ``` -| Parameter | Description| -| -------- | ----------- | +| Parameter | Description | +|------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `options: {class:'active',selector:null,traverse:0}` | Use `class` to define what class you want to add to the parent of the anchor tag that has the current url as href. If you want to apply it to a child, set the `selector` property. Use the `traverse` to a positive number in order to seek a less specific url in the menu tree then the currently displayed on. ex. If you have a link to '/todo-items' in menu and you have navigated to '/todo-items/Create', it will try to find the item with traverse item less segments in the menu and activate it. | -| `cb: function( items )` | If it finds an active item, the call back is hit for extra configuration. ex. Expand a menu item if the active one is nested.| +| `cb: function( items )` | If it finds an active item, the call back is hit for extra configuration. ex. Expand a menu item if the active one is nested. | ### `activateLinks` usage in `Layout` file diff --git a/src/docs/reference/modules/Microsoft.Authentication/README.md b/src/docs/reference/modules/Microsoft.Authentication/README.md index f4e3589808a..e2869960c13 100644 --- a/src/docs/reference/modules/Microsoft.Authentication/README.md +++ b/src/docs/reference/modules/Microsoft.Authentication/README.md @@ -67,11 +67,11 @@ This feature supports either single-tenant or multi-tenant app registrations. Be When you register and configure an application, you can configure it to be single-tenant or multi-tenant by setting the audience and tenant ID as follows: -| Audience | Single/multi-tenant | Tenant ID | Who can sign in | -|----------|---------------------|-----------|-----------------| -| Accounts in your directory only | Single tenant | Use the "Directory (tenant) ID" from the Azure Portal. | All user and guest accounts in your directory can authenticate. Use this option if your target audience is internal to your organization. | -| Accounts in any Microsoft Entra directory | Multi-tenant | `organizations` | All users and guests with a work or school account from Microsoft can authenticate. This includes schools and businesses that use Microsoft 365. Use this option if your target audience is business or educational customers. | -| Accounts in any Microsoft Entra directory and personal Microsoft accounts (such as Skype, Xbox, Outlook.com) | Multi-tenant | `common` | All users with a work or school, or personal Microsoft account can authenticate. It includes schools and businesses that use Microsoft 365 as well as personal accounts that are used to sign in to services like Xbox and Skype. Use this option to target the widest set of Microsoft accounts. | +| Audience | Single/multi-tenant | Tenant ID | Who can sign in | +|--------------------------------------------------------------------------------------------------------------|---------------------|--------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Accounts in your directory only | Single tenant | Use the "Directory (tenant) ID" from the Azure Portal. | All user and guest accounts in your directory can authenticate. Use this option if your target audience is internal to your organization. | +| Accounts in any Microsoft Entra directory | Multi-tenant | `organizations` | All users and guests with a work or school account from Microsoft can authenticate. This includes schools and businesses that use Microsoft 365. Use this option if your target audience is business or educational customers. | +| Accounts in any Microsoft Entra directory and personal Microsoft accounts (such as Skype, Xbox, Outlook.com) | Multi-tenant | `common` | All users with a work or school, or personal Microsoft account can authenticate. It includes schools and businesses that use Microsoft 365 as well as personal accounts that are used to sign in to services like Xbox and Skype. Use this option to target the widest set of Microsoft accounts. | !!! warning When configuring your application for multitenancy, it's crucial to be aware of the security implications. Allowing users from any Microsoft Entra directory and personal Microsoft accounts to authenticate can significantly broaden the potential user base. diff --git a/src/docs/reference/modules/Navigation/README.md b/src/docs/reference/modules/Navigation/README.md index 85c337c4d51..41cc61da3ea 100644 --- a/src/docs/reference/modules/Navigation/README.md +++ b/src/docs/reference/modules/Navigation/README.md @@ -23,38 +23,38 @@ The theme developer has full control over how and where navigation is displayed This is a multi-purpose pagination component that renders links to specific page numbers. It can optionally render _First_ and _Last_ links. -| Parameter | Type | Description | -| --------- | ---- |------------ | -| `Page` | `int` | Active page number. | -| `PageSize` | `int` | Number of items per page. | -| `TotalItemCount` | `double` | Total number of items (used to calculate the number of the last page). | -| `Quantity` | `int?` | Number of pages to show, 7 if not specified. | -| `FirstText` | `object` | Text of the "First" link, default: `S["<<"]` .| -| `PreviousText` | `object` | Text of the "Previous" link, default: `S["<"]`. | -| `NextText` | `object` | Text of the "Next" link, default: `S[">"]` .| -| `LastText` | `object` | Text of the "Last" link, default: `S[">>"]`. | -| `GapText` | `object` | Text of the "Gap" element, default: `S["..."]`. | -| `PagerId` | `string` | An identifier for the pager. Used to create alternate like `Pager__[PagerId]`. | -| `ShowNext` | `bool` | If true, the "Next" link is always displayed. | +| Parameter | Type | Description | +|------------------|----------|--------------------------------------------------------------------------------| +| `Page` | `int` | Active page number. | +| `PageSize` | `int` | Number of items per page. | +| `TotalItemCount` | `double` | Total number of items (used to calculate the number of the last page). | +| `Quantity` | `int?` | Number of pages to show, 7 if not specified. | +| `FirstText` | `object` | Text of the "First" link, default: `S["<<"]` . | +| `PreviousText` | `object` | Text of the "Previous" link, default: `S["<"]`. | +| `NextText` | `object` | Text of the "Next" link, default: `S[">"]` . | +| `LastText` | `object` | Text of the "Last" link, default: `S[">>"]`. | +| `GapText` | `object` | Text of the "Gap" element, default: `S["..."]`. | +| `PagerId` | `string` | An identifier for the pager. Used to create alternate like `Pager__[PagerId]`. | +| `ShowNext` | `bool` | If true, the "Next" link is always displayed. | Properties inherited from the `List` shape: -| Parameter | Type | Description | -| --------- | ---- |------------ | -| `ItemTagName` | `string` | The HTML tag used for the pages, default: `li`. | -| `ItemClasses` | `List` | Classes that are assigned to the pages, default: _none_. | -| `ItemAttributes` | `Dictionary` | Attributes that are assigned to the pages. | -| `FirstClass` | `string` | The HTML class used for the first page, default: `first`. | -| `LastClass` | `string` | The HTML tag used for last page, default: `last`. | +| Parameter | Type | Description | +|------------------|------------------------------|-----------------------------------------------------------| +| `ItemTagName` | `string` | The HTML tag used for the pages, default: `li`. | +| `ItemClasses` | `List` | Classes that are assigned to the pages, default: _none_. | +| `ItemAttributes` | `Dictionary` | Attributes that are assigned to the pages. | +| `FirstClass` | `string` | The HTML class used for the first page, default: `first`. | +| `LastClass` | `string` | The HTML tag used for last page, default: `last`. | Properties inherited from the base Shape class: -| Parameter | Type | Description | -| --------- | ---- |------------ | -| `Id` | `string` | The HTML id used for the pager, default: _none_. | -| `TagName` | `string` | The HTML tag used for the pager, default: `ul`. | +| Parameter | Type | Description | +|--------------|------------------------------|-----------------------------------------------------| +| `Id` | `string` | The HTML id used for the pager, default: _none_. | +| `TagName` | `string` | The HTML tag used for the pager, default: `ul`. | | `Attributes` | `Dictionary` | Attributes that are assigned to the main container. | -| `Classes` | `Dictionary` | CSS classes to add to the main Tag element. | +| `Classes` | `Dictionary` | CSS classes to add to the main Tag element. | The `PagerId` property is used to create templates for specific instances. For instance, assigning the value `MainBlog` to `PagerId` and then rendering the pager will look for a template named @@ -77,32 +77,32 @@ would in turn look for the template `Pager-MainBlog.Previous.cshtml`. This shape renders a pager that is comprised of two links: _Previous_ and _Next_. -| Parameter | Type | Description | -| --------- | ---- |------------ | -| `PreviousClass` | `string` | The HTML class used for the _Previous_ link, default: _none_. | -| `NextClass` | `string` | The HTML class used for the _Next_ link, default: _none_. | -| `PreviousText` | `object` | Text of the "Previous" link, default: `S["<"]`. | -| `NextText` | `object` | Text of the "Next" link, default: `S[">"]`. | -| `UrlParams` | `Dictionary` | QueryString params to pass to the pager. Parameter name and value in that order | +| Parameter | Type | Description | +|-----------------|------------------------------|---------------------------------------------------------------------------------| +| `PreviousClass` | `string` | The HTML class used for the _Previous_ link, default: _none_. | +| `NextClass` | `string` | The HTML class used for the _Next_ link, default: _none_. | +| `PreviousText` | `object` | Text of the "Previous" link, default: `S["<"]`. | +| `NextText` | `object` | Text of the "Next" link, default: `S[">"]`. | +| `UrlParams` | `Dictionary` | QueryString params to pass to the pager. Parameter name and value in that order | Properties inherited from the `List` shape: -| Parameter | Type | Description | -| --------- | ---- |------------ | -| `ItemTagName` | `string` | The HTML tag used for the pages, default: `li`. | -| `ItemClasses` | `List` | Classes that are assigned to the pages, default: _none_. | -| `ItemAttributes` | `Dictionary` | Attributes that are assigned to the pages. | -| `FirstClass` | `string` | The HTML class used for the first page, default: `first`. | -| `LastClass` | `string` | The HTML tag used for last page, default: `last`. | +| Parameter | Type | Description | +|------------------|------------------------------|-----------------------------------------------------------| +| `ItemTagName` | `string` | The HTML tag used for the pages, default: `li`. | +| `ItemClasses` | `List` | Classes that are assigned to the pages, default: _none_. | +| `ItemAttributes` | `Dictionary` | Attributes that are assigned to the pages. | +| `FirstClass` | `string` | The HTML class used for the first page, default: `first`. | +| `LastClass` | `string` | The HTML tag used for last page, default: `last`. | Properties inherited from the base Shape class: -| Parameter | Type | Description | -| --------- | ---- |------------ | -| `Id` | `string` | The HTML id used for the pager, default: _none_. | -| `TagName` | `string` | The HTML tag used for the pager, default: `ul`. | +| Parameter | Type | Description | +|--------------|------------------------------|-----------------------------------------------------| +| `Id` | `string` | The HTML id used for the pager, default: _none_. | +| `TagName` | `string` | The HTML tag used for the pager, default: `ul`. | | `Attributes` | `Dictionary` | Attributes that are assigned to the main container. | -| `Classes` | `Dictionary` | CSS classes to add to the main Tag element. | +| `Classes` | `Dictionary` | CSS classes to add to the main Tag element. | A slim pager can be further customized by defining templates for the following shapes: @@ -178,10 +178,10 @@ public sealed class MainMenu : INavigationProvider As mentioned about, you can implement the `INavigationProvider` interface to add menu items to any menu in your application. Below are specific implementations to guide you: -| **Class Name** | **Description** | -| ----------------------------- | -------------------------------------------------------------------------------- | -| `NamedNavigationProvider` | Inherit from this class to add menu items to a menu with a specific name. | -| `AdminNavigationProvider` | Inherit from this class to add menu items that will only appear in the admin menu. | +| **Class Name** | **Description** | +|---------------------------|------------------------------------------------------------------------------------| +| `NamedNavigationProvider` | Inherit from this class to add menu items to a menu with a specific name. | +| `AdminNavigationProvider` | Inherit from this class to add menu items that will only appear in the admin menu. | diff --git a/src/docs/reference/modules/Notifications/README.md b/src/docs/reference/modules/Notifications/README.md index 6f0e5f2601d..d5442f6641e 100644 --- a/src/docs/reference/modules/Notifications/README.md +++ b/src/docs/reference/modules/Notifications/README.md @@ -15,12 +15,12 @@ You can customize the default notification options through the configuration pro Available Options and Their Definitions: -| **Property** | **Description** | -|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `TotalUnreadNotifications` | Specifies the maximum number of unread notifications displayed in the navigation bar. Default is 10. | -| `DisableNotificationHtmlBodySanitizer` | Allows you to disable the default sanitization of the `HtmlBody` in notifications generated from workflows. | -| `AbsoluteCacheExpirationSeconds` | Specifies the absolute maximum duration, in seconds, for which the top unread user notifications are cached when caching is enabled. A value of 0 does not disable caching but indicates that there is no fixed expiration time for the cache. You can set this value to define a maximum lifespan for the cached data before it is invalidated. | -| `SlidingCacheExpirationSeconds` | Gets or sets how long a cache entry can be inactive (e.g. not accessed) before it will be removed. This will not extend the entry lifetime beyond the absolute expiration (if set). To disable sliding expiration, you can set this value to 0. | +| **Property** | **Description** | +|----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `TotalUnreadNotifications` | Specifies the maximum number of unread notifications displayed in the navigation bar. Default is 10. | +| `DisableNotificationHtmlBodySanitizer` | Allows you to disable the default sanitization of the `HtmlBody` in notifications generated from workflows. | +| `AbsoluteCacheExpirationSeconds` | Specifies the absolute maximum duration, in seconds, for which the top unread user notifications are cached when caching is enabled. A value of 0 does not disable caching but indicates that there is no fixed expiration time for the cache. You can set this value to define a maximum lifespan for the cached data before it is invalidated. | +| `SlidingCacheExpirationSeconds` | Gets or sets how long a cache entry can be inactive (e.g. not accessed) before it will be removed. This will not extend the entry lifetime beyond the absolute expiration (if set). To disable sliding expiration, you can set this value to 0. | ## Notification Methods diff --git a/src/docs/reference/modules/OpenId/README.md b/src/docs/reference/modules/OpenId/README.md index ba71506f7fd..987b9832e69 100644 --- a/src/docs/reference/modules/OpenId/README.md +++ b/src/docs/reference/modules/OpenId/README.md @@ -150,12 +150,12 @@ Scopes can be set through OpenID Connect Scopes menu in the admin dashboard (thr OpenID Connect Scopes require the following configuration. -| Property | Description | -| -------- | ----------- | -| Name | Unique name of the scope. | -| Display Name | Display name associated with the current scope. | -| Description | Describe how this scope is used in the system. | -| Tenants | Build the audience based on tenants names. | +| Property | Description | +|----------------------|-------------------------------------------------------------------| +| Name | Unique name of the scope. | +| Display Name | Display name associated with the current scope. | +| Description | Describe how this scope is used in the system. | +| Tenants | Build the audience based on tenants names. | | Additional resources | Build the audience based on the space separated strings provided. | A sample of OpenID Connect Scope recipe step: @@ -255,11 +255,11 @@ To use the certificate on an Azure hosted site. Token Validation require the following configuration. -| Property | Description | -| -------- | ----------- | +| Property | Description | +|-----------------------------|------------------------------------------------------------------------------------------------------------------| | Authorization server tenant | The tenant that runs OpenID Connect Server. If none is selected, then the following properties must be provided. | -| Authority | The address of the remote OpenID Connect server that issued the token. | -| Audience | Defines the intended recipient of the token that must be checked. | +| Authority | The address of the remote OpenID Connect server that issued the token. | +| Audience | Defines the intended recipient of the token that must be checked. | A sample of Token Validation Settings recipe step: diff --git a/src/docs/reference/modules/Razor/README.md b/src/docs/reference/modules/Razor/README.md index 24ad6e5bce9..c3cac71e071 100644 --- a/src/docs/reference/modules/Razor/README.md +++ b/src/docs/reference/modules/Razor/README.md @@ -4,40 +4,40 @@ Many extensions methods are available in Razor with `@Orchard`. ## Razor extensions -| Method | Module | Description | -| ------ | ------ | ----------- | -| `DisplayAsync(ContentItem content, string displayType = "")` | OrchardCore.ContentManagement.Display | Renders a content item with the corresponding display type. | -| `GetContentCultureAsync(ContentItem contentItem)` | OrchardCore.ContentLocalization | Returns the culture for a given ContentItem. | -| `CultureDir()` | OrchardCore.DisplayManagement | Returns the current culture direction. | -| `CultureName()` | OrchardCore.DisplayManagement | Returns the current culture name. | -| `ResourceUrl(string resourcePath, bool? appendVersion = null)` | OrchardCore.ResourceManagement | Prefixes the Cdn Base URL to the specified resource path. | -| `GetContentItemIdByAliasAsync(string alias)` | OrchardCore.Alias | Returns a content item id from its alias. Ex: `carousel` | -| `GetContentItemIdBySlugAsync(string slug)` | OrchardCore.Autoroute | Returns a content item id from its slug. Ex: `myblog/my-blog-post` | -| `GetContentItemIdByHandleAsync(string handle)` | OrchardCore.Contents | Returns a content item id from its handle. Ex: `alias:carousel`, `slug:myblog/my-blog-post` | -| `GetContentItemByAliasAsync(string alias, bool latest = false)` | OrchardCore.Alias | Loads a content item by its alias, seeking the latest version or not. Ex: `carousel` | -| `GetContentItemBySlugAsync(string slug, bool latest = false)` | OrchardCore.Autoroute | Loads a content item by its slug, seeking the latest version or not. Ex: `slug:myblog/my-blog-post`| -| `GetContentItemByHandleAsync(string handle, bool latest = false)` | OrchardCore.Contents | Loads a content item by its handle, seeking the latest version or not. Ex: `alias:carousel`, `slug:myblog/my-blog-post`| -| `GetContentItemByIdAsync(string contentItemId, bool latest = false)` | OrchardCore.Contents | Loads a content item by its id. | -| `GetContentItemsByIdAsync(IEnumerable contentItemIds, bool latest = false)` | OrchardCore.Contents | Loads a list of content items by their ids. | -| `GetContentItemByVersionIdAsync(string contentItemVersionId)` | OrchardCore.Contents | Loads a content item by its version id. | -| `QueryContentItemsAsync(Func, IQuery> query)` | OrchardCore.Contents | Query content items. | -| `GetRecentContentItemsByContentTypeAsync(string contentType, int maxContentItems = 10)` | OrchardCore.Contents | Loads content items of a specific type. | -| `LiquidToHtmlAsync(string liquid)` | [OrchardCore.Liquid](../../modules/Liquid/README.md#razor-helpers) | Parses a liquid string to HTML. | -| `LiquidToHtmlAsync(string liquid, object model)` | [OrchardCore.Liquid](../../modules/Liquid/README.md#razor-helpers) | Parses a liquid string to HTML. | -| `SanitizeHtml(string html)` | [OrchardCore.Infrastructure](../Sanitizer/README.md#razor-helper) | Sanitizes an HTML string. | -| `QueryListItemsCountAsync(string listContentItemId, Expression> itemPredicate = null)` | OrchardCore.Lists | Returns list count. | -| `QueryListItemsAsync(string listContentItemId, Expression> itemPredicate = null)` | [OrchardCore.List](../../modules/Lists/README.md#orchard-helpers) | Returns list items. | -| `MarkdownToHtmlAsync(string listContentItemId, Expression> itemPredicate = null)` | [OrchardCore.Markdown](../../modules/Markdown/README.md#razor-helper) | Converts Markdown string to HTML. | -| `AssetUrl(string assetPath, int? width = null, int? height = null, ResizeMode resizeMode = ResizeMode.Undefined, bool appendVersion = false)` | [OrchardCore.Media](../../modules/Media/README.md#razor-helpers) | Returns the relative URL of the specifier asset path with optional resizing parameters. | -| `ImageResizeUrl(string imagePath, int? width = null, int? height = null, ResizeMode resizeMode = ResizeMode.Undefined)` | [OrchardCore.Media](../../modules/Media/README.md#razor-helpers) | Returns a URL with custom resizing parameters for an existing image path. | -| `ContentQueryAsync(string queryName)` | [OrchardCore.Queries](../../modules/Queries/README.md#razor-helpers) | Returns a List of Content items | -| `ContentQueryAsync(string queryName, IDictionary parameters)` | [OrchardCore.Queries](../../modules/Queries/README.md#razor-helpers) | Returns a List of Content items | -| `QueryAsync(string liquid, object model)` | [OrchardCore.Queries](../../modules/Queries/README.md#razor-helpers) | Returns a List of objects | -| `QueryAsync(string queryName, IDictionary parameters)` | [OrchardCore.Queries](../../modules/Queries/README.md#razor-helpers) | Returns a List of objects | -| `ShortcodesToHtmlAsync(string html, object model = null)` | [OrchardCore.Shortcodes](../../modules/Shortcodes/README.md#rendering-shortcodes) | Renders shortcodes. | -| `GetTaxonomyTermAsync(string taxonomyContentItemId, string termContentItemId)` | [OrchardCore.Taxonomies](../../modules/Taxonomies/README.md#orchard-helpers) | Returns a the term from its content item id and taxonomy. | -| `GetInheritedTermsAsync(string taxonomyContentItemId, string termContentItemId)` | [OrchardCore.Taxonomies](../../modules/Taxonomies/README.md#orchard-helpers) | Returns the list of terms including their parents. | -| `QueryCategorizedContentItemsAsync(string taxonomy(Func, IQuery> query)` | [OrchardCore.Taxonomies](../../modules/Taxonomies/README.md#orchard-helpers) | Query content items. | +| Method | Module | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| `DisplayAsync(ContentItem content, string displayType = "")` | OrchardCore.ContentManagement.Display | Renders a content item with the corresponding display type. | +| `GetContentCultureAsync(ContentItem contentItem)` | OrchardCore.ContentLocalization | Returns the culture for a given ContentItem. | +| `CultureDir()` | OrchardCore.DisplayManagement | Returns the current culture direction. | +| `CultureName()` | OrchardCore.DisplayManagement | Returns the current culture name. | +| `ResourceUrl(string resourcePath, bool? appendVersion = null)` | OrchardCore.ResourceManagement | Prefixes the Cdn Base URL to the specified resource path. | +| `GetContentItemIdByAliasAsync(string alias)` | OrchardCore.Alias | Returns a content item id from its alias. Ex: `carousel` | +| `GetContentItemIdBySlugAsync(string slug)` | OrchardCore.Autoroute | Returns a content item id from its slug. Ex: `myblog/my-blog-post` | +| `GetContentItemIdByHandleAsync(string handle)` | OrchardCore.Contents | Returns a content item id from its handle. Ex: `alias:carousel`, `slug:myblog/my-blog-post` | +| `GetContentItemByAliasAsync(string alias, bool latest = false)` | OrchardCore.Alias | Loads a content item by its alias, seeking the latest version or not. Ex: `carousel` | +| `GetContentItemBySlugAsync(string slug, bool latest = false)` | OrchardCore.Autoroute | Loads a content item by its slug, seeking the latest version or not. Ex: `slug:myblog/my-blog-post` | +| `GetContentItemByHandleAsync(string handle, bool latest = false)` | OrchardCore.Contents | Loads a content item by its handle, seeking the latest version or not. Ex: `alias:carousel`, `slug:myblog/my-blog-post` | +| `GetContentItemByIdAsync(string contentItemId, bool latest = false)` | OrchardCore.Contents | Loads a content item by its id. | +| `GetContentItemsByIdAsync(IEnumerable contentItemIds, bool latest = false)` | OrchardCore.Contents | Loads a list of content items by their ids. | +| `GetContentItemByVersionIdAsync(string contentItemVersionId)` | OrchardCore.Contents | Loads a content item by its version id. | +| `QueryContentItemsAsync(Func, IQuery> query)` | OrchardCore.Contents | Query content items. | +| `GetRecentContentItemsByContentTypeAsync(string contentType, int maxContentItems = 10)` | OrchardCore.Contents | Loads content items of a specific type. | +| `LiquidToHtmlAsync(string liquid)` | [OrchardCore.Liquid](../../modules/Liquid/README.md#razor-helpers) | Parses a liquid string to HTML. | +| `LiquidToHtmlAsync(string liquid, object model)` | [OrchardCore.Liquid](../../modules/Liquid/README.md#razor-helpers) | Parses a liquid string to HTML. | +| `SanitizeHtml(string html)` | [OrchardCore.Infrastructure](../Sanitizer/README.md#razor-helper) | Sanitizes an HTML string. | +| `QueryListItemsCountAsync(string listContentItemId, Expression> itemPredicate = null)` | OrchardCore.Lists | Returns list count. | +| `QueryListItemsAsync(string listContentItemId, Expression> itemPredicate = null)` | [OrchardCore.List](../../modules/Lists/README.md#orchard-helpers) | Returns list items. | +| `MarkdownToHtmlAsync(string listContentItemId, Expression> itemPredicate = null)` | [OrchardCore.Markdown](../../modules/Markdown/README.md#razor-helper) | Converts Markdown string to HTML. | +| `AssetUrl(string assetPath, int? width = null, int? height = null, ResizeMode resizeMode = ResizeMode.Undefined, bool appendVersion = false)` | [OrchardCore.Media](../../modules/Media/README.md#razor-helpers) | Returns the relative URL of the specifier asset path with optional resizing parameters. | +| `ImageResizeUrl(string imagePath, int? width = null, int? height = null, ResizeMode resizeMode = ResizeMode.Undefined)` | [OrchardCore.Media](../../modules/Media/README.md#razor-helpers) | Returns a URL with custom resizing parameters for an existing image path. | +| `ContentQueryAsync(string queryName)` | [OrchardCore.Queries](../../modules/Queries/README.md#razor-helpers) | Returns a List of Content items | +| `ContentQueryAsync(string queryName, IDictionary parameters)` | [OrchardCore.Queries](../../modules/Queries/README.md#razor-helpers) | Returns a List of Content items | +| `QueryAsync(string liquid, object model)` | [OrchardCore.Queries](../../modules/Queries/README.md#razor-helpers) | Returns a List of objects | +| `QueryAsync(string queryName, IDictionary parameters)` | [OrchardCore.Queries](../../modules/Queries/README.md#razor-helpers) | Returns a List of objects | +| `ShortcodesToHtmlAsync(string html, object model = null)` | [OrchardCore.Shortcodes](../../modules/Shortcodes/README.md#rendering-shortcodes) | Renders shortcodes. | +| `GetTaxonomyTermAsync(string taxonomyContentItemId, string termContentItemId)` | [OrchardCore.Taxonomies](../../modules/Taxonomies/README.md#orchard-helpers) | Returns a the term from its content item id and taxonomy. | +| `GetInheritedTermsAsync(string taxonomyContentItemId, string termContentItemId)` | [OrchardCore.Taxonomies](../../modules/Taxonomies/README.md#orchard-helpers) | Returns the list of terms including their parents. | +| `QueryCategorizedContentItemsAsync(string taxonomy(Func, IQuery> query)` | [OrchardCore.Taxonomies](../../modules/Taxonomies/README.md#orchard-helpers) | Query content items. | ## How to use diff --git a/src/docs/reference/modules/Recipes/README.md b/src/docs/reference/modules/Recipes/README.md index e84b880e6d6..55216465843 100644 --- a/src/docs/reference/modules/Recipes/README.md +++ b/src/docs/reference/modules/Recipes/README.md @@ -468,12 +468,12 @@ Recipes can use script helpers like this: } ``` -| Name | Description | -| --- | --- | -| `uuid()` | Generates a unique identifier for a content item. | -| `base64(string)` | Decodes the specified string from Base64 encoding. Use to convert your files to base64. | -| `html(string)` | Decodes the specified string from HTML encoding. | -| `gzip(string)` | Decodes the specified string from gzip/base64 encoding. Use to gzip your strings. | +| Name | Description | +|------------------|--------------------------------------------------------------------------------------------------------------------------| +| `uuid()` | Generates a unique identifier for a content item. | +| `base64(string)` | Decodes the specified string from Base64 encoding. Use to convert your files to base64. | +| `html(string)` | Decodes the specified string from HTML encoding. | +| `gzip(string)` | Decodes the specified string from gzip/base64 encoding. Use to gzip your strings. | ## Recipe Migrations diff --git a/src/docs/reference/modules/Resources/README.md b/src/docs/reference/modules/Resources/README.md index d35e393b3f1..e19cc1cabf9 100644 --- a/src/docs/reference/modules/Resources/README.md +++ b/src/docs/reference/modules/Resources/README.md @@ -42,36 +42,36 @@ Named resources are well-known scripts and stylesheets that are described in a m They have a name, a type (script, stylesheet) and optionally a version. The `OrchardCore.Resources` module provides some commonly used ones: -| Name | Type | Versions | Dependencies | -| --------------------- | ------ | ------------- | -------------- | -| jQuery | Script | 3.7.1 | - | -| jQuery.slim | Script | 3.7.1 | - | -| jQuery-ui | Script | 1.12.1 | jQuery | -| jQuery-ui-i18n | Script | 1.7.2 | jQuery-ui | -| jquery.easing | Script | 1.4.1 | - | -| jquery-resizable-dom | Script | 0.35.0 | - | -| js-cookie | Script | 3.0.5 | - | -| popper | Script | 1.16.1 | - | -| popperjs | Script | 2.11.8 | - | -| bootstrap | Script | 4.6.1 | popper | -| bootstrap | Script | 5.3.3 | popperjs | -| bootstrap | Style | 4.6.1, 5.3.3 | - | -| bootstrap-select | Script | 1.14.0-beta3 | - | -| bootstrap-select | Style | 1.14.0-beta3 | - | -| codemirror | Script | 5.65.7 | - | -| codemirror | Style | 5.65.7 | - | -| font-awesome | Style | 6.6.0, 6.7.2 | - | -| font-awesome | Script | 6.6.0, 6.7.2 | - | -| font-awesome-v4-shims | Script | 6.6.0, 6.7.2 | - | -| Sortable | Script | 1.10.2 | - | -| trumbowyg | Style | 2.28.0 | - | -| trumbowyg | Script | 2.28.0 | - | -| vue-multiselect | Script | 2.1.6 | - | -| vuedraggable | Script | 2.24.3 | Sortable | -| monaco-loader | Script | 0.46.0 | - | -| monaco | Script | 0.46.0 | monaco-loader | -| nouislider | Script | 15.6.1 | - | -| nouislider | Style | 15.6.1 | - | +| Name | Type | Versions | Dependencies | +|-----------------------|--------|--------------|---------------| +| jQuery | Script | 3.7.1 | - | +| jQuery.slim | Script | 3.7.1 | - | +| jQuery-ui | Script | 1.12.1 | jQuery | +| jQuery-ui-i18n | Script | 1.7.2 | jQuery-ui | +| jquery.easing | Script | 1.4.1 | - | +| jquery-resizable-dom | Script | 0.35.0 | - | +| js-cookie | Script | 3.0.5 | - | +| popper | Script | 1.16.1 | - | +| popperjs | Script | 2.11.8 | - | +| bootstrap | Script | 4.6.1 | popper | +| bootstrap | Script | 5.3.3 | popperjs | +| bootstrap | Style | 4.6.1, 5.3.3 | - | +| bootstrap-select | Script | 1.14.0-beta3 | - | +| bootstrap-select | Style | 1.14.0-beta3 | - | +| codemirror | Script | 5.65.7 | - | +| codemirror | Style | 5.65.7 | - | +| font-awesome | Style | 6.6.0, 6.7.2 | - | +| font-awesome | Script | 6.6.0, 6.7.2 | - | +| font-awesome-v4-shims | Script | 6.6.0, 6.7.2 | - | +| Sortable | Script | 1.10.2 | - | +| trumbowyg | Style | 2.28.0 | - | +| trumbowyg | Script | 2.28.0 | - | +| vue-multiselect | Script | 2.1.6 | - | +| vuedraggable | Script | 2.24.3 | Sortable | +| monaco-loader | Script | 0.46.0 | - | +| monaco | Script | 0.46.0 | monaco-loader | +| nouislider | Script | 15.6.1 | - | +| nouislider | Style | 15.6.1 | - | ### Registering a Resource Manifest @@ -520,7 +520,7 @@ If you wish to use files contained in the media library when using the link tag These properties are available: | Name | Description | -| ---------------------------- | --------------------------------------------------------------------- | +|------------------------------|-----------------------------------------------------------------------| | `name` (`asp-name` in Razor) | The `name` attribute of the tag | | `content` | The `content` attribute of the tag | | `httpequiv` | The `http-equiv` attribute of the tag | diff --git a/src/docs/reference/modules/Roles/README.md b/src/docs/reference/modules/Roles/README.md index 0c7e4337d75..6f21fd8aa9c 100644 --- a/src/docs/reference/modules/Roles/README.md +++ b/src/docs/reference/modules/Roles/README.md @@ -6,15 +6,15 @@ Enabling the `OrchardCore.Roles` module will allow you to manage the user roles. Orchard Core defines the following predefined permission stereotypes: -| Name | Description | -| --- | --- | +| Name | Description | +|-----------------|----------------------------------------------------------------------| | `Administrator` | A **system role** that grants all permissions to the assigned users. | -| `Anonymous` | A **system role** representing all non-authenticated users. | -| `Authenticated` | A **system role** representing all authenticated users. | -| `Author` | Grants users the ability to create content. | -| `Contributor` | Grants users the ability to contribute content. | -| `Editor` | Grants users the ability to edit existing content. | -| `Moderator` | Grants users the ability to moderate content. | +| `Anonymous` | A **system role** representing all non-authenticated users. | +| `Authenticated` | A **system role** representing all authenticated users. | +| `Author` | Grants users the ability to create content. | +| `Contributor` | Grants users the ability to contribute content. | +| `Editor` | Grants users the ability to edit existing content. | +| `Moderator` | Grants users the ability to moderate content. | !!! note System roles cannot be deleted, and the `Administrator` role cannot be edited. diff --git a/src/docs/reference/modules/SQLIndexing/README.md b/src/docs/reference/modules/SQLIndexing/README.md index dbf021d9fcd..027b1cd0aa0 100644 --- a/src/docs/reference/modules/SQLIndexing/README.md +++ b/src/docs/reference/modules/SQLIndexing/README.md @@ -6,31 +6,31 @@ Here are some SQL tables that you can query and their columns. ### **ContentItemIndex** -| Name | Type | Non-Null | Primary Key | -| --- | --- | --- | --- | -| `Id` | `int` | `true` | `true` | -| `DocumentId` | `int` | `false` | `false` | -| `ContentItemId` | `nvarchar(26)` | `false` | `false` | -| `Published` | `bit` | `false` | `false` | -| `Latest` | `bit` | `false` | `false` | -| `ModifiedUtc` | `datetime` | `false` | `false` | -| `PublishedUtc` | `datetime` | `false` | `false` | -| `CreatedUtc` | `datetime` | `false` | `false` | -| `Owner` | `nvarchar(255)` | `false` | `false` | -| `Author` | `nvarchar(255)` | `false` | `false` | -| `DisplayText` | `nvarchar(255)` | `false` | `false` | +| Name | Type | Non-Null | Primary Key | +|-----------------|-----------------|----------|-------------| +| `Id` | `int` | `true` | `true` | +| `DocumentId` | `int` | `false` | `false` | +| `ContentItemId` | `nvarchar(26)` | `false` | `false` | +| `Published` | `bit` | `false` | `false` | +| `Latest` | `bit` | `false` | `false` | +| `ModifiedUtc` | `datetime` | `false` | `false` | +| `PublishedUtc` | `datetime` | `false` | `false` | +| `CreatedUtc` | `datetime` | `false` | `false` | +| `Owner` | `nvarchar(255)` | `false` | `false` | +| `Author` | `nvarchar(255)` | `false` | `false` | +| `DisplayText` | `nvarchar(255)` | `false` | `false` | ### **LocalizedContentItemIndex** -| Name | Type | Non-Null | Primary Key | -| --- | --- | --- | --- | -| `Id` | `int` | `true` | `true` | -| `DocumentId` | `int` | `false` | `false` | -| `ContentItemId` | `nvarchar(26)` | `false` | `false` | -| `Published` | `bit` | `false` | `false` | -| `Latest` | `bit` | `false` | `false` | -| **LocalizationSet** | **nvarchar** | **false** | **false** | -| **Culture** | **nvarchar** | **false** | **false** | +| Name | Type | Non-Null | Primary Key | +|---------------------|----------------|-----------|-------------| +| `Id` | `int` | `true` | `true` | +| `DocumentId` | `int` | `false` | `false` | +| `ContentItemId` | `nvarchar(26)` | `false` | `false` | +| `Published` | `bit` | `false` | `false` | +| `Latest` | `bit` | `false` | `false` | +| **LocalizationSet** | **nvarchar** | **false** | **false** | +| **Culture** | **nvarchar** | **false** | **false** | ## Content Fields Indexing @@ -44,173 +44,173 @@ The `OrchardCore.ContentFields.Indexing.SQL` module provides database indexing f ### **BooleanFieldIndex** -| Name | Type | Non-Null | Primary Key | -| --- | --- | --- | --- | -| `Id` | `int` | `true` | `true` | -| `DocumentId` | `int` | `false` | `false` | -| `ContentItemId` | `nvarchar(26)` | `false` | `false` | -| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | -| `ContentType` | `nvarchar(255)` | `false` | `false` | -| `ContentPart` | `nvarchar(255)` | `false` | `false` | -| `ContentField` | `nvarchar(255)` | `false` | `false` | -| `Published` | `bit` | `false` | `false` | -| `Latest` | `bit` | `false` | `false` | -| **Boolean** | **bit** | **false** | **false** | +| Name | Type | Non-Null | Primary Key | +|------------------------|-----------------|-----------|-------------| +| `Id` | `int` | `true` | `true` | +| `DocumentId` | `int` | `false` | `false` | +| `ContentItemId` | `nvarchar(26)` | `false` | `false` | +| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | +| `ContentType` | `nvarchar(255)` | `false` | `false` | +| `ContentPart` | `nvarchar(255)` | `false` | `false` | +| `ContentField` | `nvarchar(255)` | `false` | `false` | +| `Published` | `bit` | `false` | `false` | +| `Latest` | `bit` | `false` | `false` | +| **Boolean** | **bit** | **false** | **false** | ### **ContentPickerFieldIndex** -| Name | Type | Non-Null | Primary Key | -| --- | --- | --- | --- | -| `Id` | `int` | `true` | `true` | -| `DocumentId` | `int` | `false` | `false` | -| `ContentItemId` | `nvarchar(26)` | `false` | `false` | -| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | -| `ContentType` | `nvarchar(255)` | `false` | `false` | -| `ContentPart` | `nvarchar(255)` | `false` | `false` | -| `ContentField` | `nvarchar(255)` | `false` | `false` | -| `Published` | `bit` | `false` | `false` | -| `Latest` | `bit` | `false` | `false` | -| **SelectedContentItemId** | **nvarchar(26)** | **false** | **false** | +| Name | Type | Non-Null | Primary Key | +|---------------------------|------------------|-----------|-------------| +| `Id` | `int` | `true` | `true` | +| `DocumentId` | `int` | `false` | `false` | +| `ContentItemId` | `nvarchar(26)` | `false` | `false` | +| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | +| `ContentType` | `nvarchar(255)` | `false` | `false` | +| `ContentPart` | `nvarchar(255)` | `false` | `false` | +| `ContentField` | `nvarchar(255)` | `false` | `false` | +| `Published` | `bit` | `false` | `false` | +| `Latest` | `bit` | `false` | `false` | +| **SelectedContentItemId** | **nvarchar(26)** | **false** | **false** | ### **DateFieldIndex** -| Name | Type | Non-Null | Primary Key | -| --- | --- | --- | --- | -| `Id` | `int` | `true` | `true` | -| `DocumentId` | `int` | `false` | `false` | -| `ContentItemId` | `nvarchar(26)` | `false` | `false` | -| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | -| `ContentType` | `nvarchar(255)` | `false` | `false` | -| `ContentPart` | `nvarchar(255)` | `false` | `false` | -| `ContentField` | `nvarchar(255)` | `false` | `false` | -| `Published` | `bit` | `false` | `false` | -| `Latest` | `bit` | `false` | `false` | -| **Date** | **datetime** | **false** | **false** | +| Name | Type | Non-Null | Primary Key | +|------------------------|-----------------|-----------|-------------| +| `Id` | `int` | `true` | `true` | +| `DocumentId` | `int` | `false` | `false` | +| `ContentItemId` | `nvarchar(26)` | `false` | `false` | +| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | +| `ContentType` | `nvarchar(255)` | `false` | `false` | +| `ContentPart` | `nvarchar(255)` | `false` | `false` | +| `ContentField` | `nvarchar(255)` | `false` | `false` | +| `Published` | `bit` | `false` | `false` | +| `Latest` | `bit` | `false` | `false` | +| **Date** | **datetime** | **false** | **false** | ### **DateTimeFieldIndex** -| Name | Type | Non-Null | Primary Key | -| --- | --- | --- | --- | -| `Id` | `int` | `true` | `true` | -| `DocumentId` | `int` | `false` | `false` | -| `ContentItemId` | `nvarchar(26)` | `false` | `false` | -| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | -| `ContentType` | `nvarchar(255)` | `false` | `false` | -| `ContentPart` | `nvarchar(255)` | `false` | `false` | -| `ContentField` | `nvarchar(255)` | `false` | `false` | -| `Published` | `bit` | `false` | `false` | -| `Latest` | `bit` | `false` | `false` | -| **DateTime** | **datetime** | **false** | **false** | +| Name | Type | Non-Null | Primary Key | +|------------------------|-----------------|-----------|-------------| +| `Id` | `int` | `true` | `true` | +| `DocumentId` | `int` | `false` | `false` | +| `ContentItemId` | `nvarchar(26)` | `false` | `false` | +| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | +| `ContentType` | `nvarchar(255)` | `false` | `false` | +| `ContentPart` | `nvarchar(255)` | `false` | `false` | +| `ContentField` | `nvarchar(255)` | `false` | `false` | +| `Published` | `bit` | `false` | `false` | +| `Latest` | `bit` | `false` | `false` | +| **DateTime** | **datetime** | **false** | **false** | ### **HtmlFieldIndex** -| Name | Type | Non-Null | Primary Key | -| --- | --- | --- | --- | -| `Id` | `int` | `true` | `true` | -| `DocumentId` | `int` | `false` | `false` | -| `ContentItemId` | `nvarchar(26)` | `false` | `false` | -| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | -| `ContentType` | `nvarchar(255)` | `false` | `false` | -| `ContentPart` | `nvarchar(255)` | `false` | `false` | -| `ContentField` | `nvarchar(255)` | `false` | `false` | -| `Published` | `bit` | `false` | `false` | -| `Latest` | `bit` | `false` | `false` | -| **Html** | **nvarchar(max)** | **false** | **false** | +| Name | Type | Non-Null | Primary Key | +|------------------------|-------------------|-----------|-------------| +| `Id` | `int` | `true` | `true` | +| `DocumentId` | `int` | `false` | `false` | +| `ContentItemId` | `nvarchar(26)` | `false` | `false` | +| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | +| `ContentType` | `nvarchar(255)` | `false` | `false` | +| `ContentPart` | `nvarchar(255)` | `false` | `false` | +| `ContentField` | `nvarchar(255)` | `false` | `false` | +| `Published` | `bit` | `false` | `false` | +| `Latest` | `bit` | `false` | `false` | +| **Html** | **nvarchar(max)** | **false** | **false** | ### **LinkFieldIndex** -| Name | Type | Non-Null | Primary Key | -| --- | --- | --- | --- | -| `Id` | `int` | `true` | `true` | -| `DocumentId` | `int` | `false` | `false` | -| `ContentItemId` | `nvarchar(26)` | `false` | `false` | -| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | -| `ContentType` | `nvarchar(255)` | `false` | `false` | -| `ContentPart` | `nvarchar(255)` | `false` | `false` | -| `ContentField` | `nvarchar(255)` | `false` | `false` | -| `Published` | `bit` | `false` | `false` | -| `Latest` | `bit` | `false` | `false` | -| **Url** | **nvarchar(766)** | **false** | **false** | -| **BigUrl** | **nvarchar(max)** | **false** | **false** | -| **Text** | **nvarchar(766)** | **false** | **false** | -| **BigText** | **nvarchar(max)** | **false** | **false** | +| Name | Type | Non-Null | Primary Key | +|------------------------|-------------------|-----------|-------------| +| `Id` | `int` | `true` | `true` | +| `DocumentId` | `int` | `false` | `false` | +| `ContentItemId` | `nvarchar(26)` | `false` | `false` | +| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | +| `ContentType` | `nvarchar(255)` | `false` | `false` | +| `ContentPart` | `nvarchar(255)` | `false` | `false` | +| `ContentField` | `nvarchar(255)` | `false` | `false` | +| `Published` | `bit` | `false` | `false` | +| `Latest` | `bit` | `false` | `false` | +| **Url** | **nvarchar(766)** | **false** | **false** | +| **BigUrl** | **nvarchar(max)** | **false** | **false** | +| **Text** | **nvarchar(766)** | **false** | **false** | +| **BigText** | **nvarchar(max)** | **false** | **false** | ### **MultiTextFieldIndex** -| Name | Type | Non-Null | Primary Key | -| --- | --- | --- | --- | -| `Id` | `Int` | `true` | `true` | -| `DocumentId` | `int` | `false` | `false` | -| `ContentItemId` | `nvarchar(26)` | `false` | `false` | -| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | -| `ContentType` | `nvarchar(255)` | `false` | `false` | -| `ContentPart` | `nvarchar(255)` | `false` | `false` | -| `ContentField` | `nvarchar(255)` | `false` | `false` | -| `Published` | `bit` | `false` | `false` | -| `Latest` | `bit` | `false` | `false` | -| **Value** | **nvarchar(766)** | **false** | **false** | -| **BigValue** | **nvarchar(max)** | **false** | **false** | +| Name | Type | Non-Null | Primary Key | +|------------------------|-------------------|-----------|-------------| +| `Id` | `Int` | `true` | `true` | +| `DocumentId` | `int` | `false` | `false` | +| `ContentItemId` | `nvarchar(26)` | `false` | `false` | +| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | +| `ContentType` | `nvarchar(255)` | `false` | `false` | +| `ContentPart` | `nvarchar(255)` | `false` | `false` | +| `ContentField` | `nvarchar(255)` | `false` | `false` | +| `Published` | `bit` | `false` | `false` | +| `Latest` | `bit` | `false` | `false` | +| **Value** | **nvarchar(766)** | **false** | **false** | +| **BigValue** | **nvarchar(max)** | **false** | **false** | ### **NumericFieldIndex** -| Name | Type | Non-Null | Primary Key | -| --- | --- | --- | --- | -| `Id` | `int` | `true` | `true` | -| `DocumentId` | `int` | `false` | `false` | -| `ContentItemId` | `nvarchar(26)` | `false` | `false` | -| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | -| `ContentType` | `nvarchar(255)` | `false` | `false` | -| `ContentPart` | `nvarchar(255)` | `false` | `false` | -| `ContentField` | `nvarchar(255)` | `false` | `false` | -| `Published` | `bit` | `false` | `false` | -| `Latest` | `bit` | `false` | `false` | -| **Numeric** | **decimal(19,5)** | **false** | **false** | +| Name | Type | Non-Null | Primary Key | +|------------------------|-------------------|-----------|-------------| +| `Id` | `int` | `true` | `true` | +| `DocumentId` | `int` | `false` | `false` | +| `ContentItemId` | `nvarchar(26)` | `false` | `false` | +| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | +| `ContentType` | `nvarchar(255)` | `false` | `false` | +| `ContentPart` | `nvarchar(255)` | `false` | `false` | +| `ContentField` | `nvarchar(255)` | `false` | `false` | +| `Published` | `bit` | `false` | `false` | +| `Latest` | `bit` | `false` | `false` | +| **Numeric** | **decimal(19,5)** | **false** | **false** | ### **TextFieldIndex** -| Name | Type | Non-Null | Primary Key | -| --- | --- | --- | --- | -| `Id` | `Int` | `true` | `true` | -| `DocumentId` | `int` | `false` | `false` | -| `ContentItemId` | `nvarchar(26)` | `false` | `false` | -| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | -| `ContentType` | `nvarchar(255)` | `false` | `false` | -| `ContentPart` | `nvarchar(255)` | `false` | `false` | -| `ContentField` | `nvarchar(255)` | `false` | `false` | -| `Published` | `bit` | `false` | `false` | -| `Latest` | `bit` | `false` | `false` | -| **Text** | **nvarchar(766)** | **false** | **false** | -| **BigText** | **nvarchar(max)** | **false** | **false** | +| Name | Type | Non-Null | Primary Key | +|------------------------|-------------------|-----------|-------------| +| `Id` | `Int` | `true` | `true` | +| `DocumentId` | `int` | `false` | `false` | +| `ContentItemId` | `nvarchar(26)` | `false` | `false` | +| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | +| `ContentType` | `nvarchar(255)` | `false` | `false` | +| `ContentPart` | `nvarchar(255)` | `false` | `false` | +| `ContentField` | `nvarchar(255)` | `false` | `false` | +| `Published` | `bit` | `false` | `false` | +| `Latest` | `bit` | `false` | `false` | +| **Text** | **nvarchar(766)** | **false** | **false** | +| **BigText** | **nvarchar(max)** | **false** | **false** | ### **TimeFieldIndex** -| Name | Type | Non-Null | Primary Key | -| --- | --- | --- | --- | -| `Id` | `Int` | `true` | `true` | -| `DocumentId` | `int` | `false` | `false` | -| `ContentItemId` | `nvarchar(26)` | `false` | `false` | -| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | -| `ContentType` | `nvarchar(255)` | `false` | `false` | -| `ContentPart` | `nvarchar(255)` | `false` | `false` | -| `ContentField` | `nvarchar(255)` | `false` | `false` | -| `Published` | `bit` | `false` | `false` | -| `Latest` | `bit` | `false` | `false` | -| **Time** | **datetime** | **false** | **false** | +| Name | Type | Non-Null | Primary Key | +|------------------------|-----------------|-----------|-------------| +| `Id` | `Int` | `true` | `true` | +| `DocumentId` | `int` | `false` | `false` | +| `ContentItemId` | `nvarchar(26)` | `false` | `false` | +| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | +| `ContentType` | `nvarchar(255)` | `false` | `false` | +| `ContentPart` | `nvarchar(255)` | `false` | `false` | +| `ContentField` | `nvarchar(255)` | `false` | `false` | +| `Published` | `bit` | `false` | `false` | +| `Latest` | `bit` | `false` | `false` | +| **Time** | **datetime** | **false** | **false** | ### **UserPickerFieldIndex** -| Name | Type | Non-Null | Primary Key | -| --- | --- | --- | --- | -| `Id` | `Int` | `true` | `true` | -| `DocumentId` | `int` | `false` | `false` | -| `ContentItemId` | `nvarchar(26)` | `false` | `false` | -| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | -| `ContentType` | `nvarchar(255)` | `false` | `false` | -| `ContentPart` | `nvarchar(255)` | `false` | `false` | -| `ContentField` | `nvarchar(255)` | `false` | `false` | -| `Published` | `bit` | `false` | `false` | -| `Latest` | `bit` | `false` | `false` | -| **SelectedUserId** | **string** | **false** | **false** | +| Name | Type | Non-Null | Primary Key | +|------------------------|-----------------|-----------|-------------| +| `Id` | `Int` | `true` | `true` | +| `DocumentId` | `int` | `false` | `false` | +| `ContentItemId` | `nvarchar(26)` | `false` | `false` | +| `ContentItemVersionId` | `nvarchar(26)` | `false` | `false` | +| `ContentType` | `nvarchar(255)` | `false` | `false` | +| `ContentPart` | `nvarchar(255)` | `false` | `false` | +| `ContentField` | `nvarchar(255)` | `false` | `false` | +| `Published` | `bit` | `false` | `false` | +| `Latest` | `bit` | `false` | `false` | +| **SelectedUserId** | **string** | **false** | **false** | ## Usage diff --git a/src/docs/reference/modules/Scripting/README.md b/src/docs/reference/modules/Scripting/README.md index 09f4876ba3d..4babb567dad 100644 --- a/src/docs/reference/modules/Scripting/README.md +++ b/src/docs/reference/modules/Scripting/README.md @@ -48,10 +48,10 @@ To create a global method, implement the `IGlobalMethodProvider`. Then, add it t The File scripting engine provides methods to read file contents. -| Name | Example | Description | -| ---- | ---- | -------- | -| `text` | `file:text('../wwwroot/template.html')` | Returns the content of a text file. | -| `base64` | `file:base64('../wwwroot/image.jpg')` | Returns the base64 encoded content of a file. | +| Name | Example | Description | +|----------|-----------------------------------------|-----------------------------------------------| +| `text` | `file:text('../wwwroot/template.html')` | Returns the content of a text file. | +| `base64` | `file:base64('../wwwroot/image.jpg')` | Returns the base64 encoded content of a file. | ## JavaScript `OrchardCore.Scripting.JavaScript` @@ -63,74 +63,74 @@ Here is a list of javascript methods provided by Orchard Modules. #### Generic functions -| Function | Description -| -------- | ----------- | -| `log(level: String, text: String, param: Object): void` | Formats and writes a log message at the specified log level. | -| `uuid(): String` | Generates a unique identifier for a content item. | -| `base64(String): String` | Decodes the specified string from Base64 encoding. Use to convert your files to base64. | -| `html(String): String` | Decodes the specified string from HTML encoding. | -| `gzip(String): String` | Decodes the specified string from gzip/base64 encoding. Use to gzip your strings. | +| Function | Description +|---------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------| +| `log(level: String, text: String, param: Object): void` | Formats and writes a log message at the specified log level. | +| `uuid(): String` | Generates a unique identifier for a content item. | +| `base64(String): String` | Decodes the specified string from Base64 encoding. Use to convert your files to base64. | +| `html(String): String` | Decodes the specified string from HTML encoding. | +| `gzip(String): String` | Decodes the specified string from gzip/base64 encoding. Use to gzip your strings. | #### Content (`OrchardCore.Contents`) -| Function | Description -| -------- | ----------- | -| `newContentItem(contentTypeName: String): IContent`| Creates a new instance of a ContentType (does not persist)| -| `createContentItem(contentTypeName: String, publish: Boolean, properties: Object): IContent`| Creates and persists a new ContentItem. Conditionally publishes it. | -| `updateContentItem(contentItem: IContent, properties: Object)`| Updates an existing content item with the properties | -| `deleteContentItem(contentItem: IContent)`| Deletes an existing content item | -| `getUrlPrefix(path: String): String`| Prefixes the path with the Tenant prefix (if specified) | +| Function | Description +|----------------------------------------------------------------------------------------------|---------------------------------------------------------------------| +| `newContentItem(contentTypeName: String): IContent` | Creates a new instance of a ContentType (does not persist) | +| `createContentItem(contentTypeName: String, publish: Boolean, properties: Object): IContent` | Creates and persists a new ContentItem. Conditionally publishes it. | +| `updateContentItem(contentItem: IContent, properties: Object)` | Updates an existing content item with the properties | +| `deleteContentItem(contentItem: IContent)` | Deletes an existing content item | +| `getUrlPrefix(path: String): String` | Prefixes the path with the Tenant prefix (if specified) | #### Layers (`OrchardCore.Layers`) -| Function | Description -| -------- | ----------- | -| `isHomepage(): Boolean` | Returns true if the current request Url is the current homepage | -| `isAnonymous(): Boolean` | Returns true if there is no authenticated user on the current request | -| `isAuthenticated(): Boolean` | Returns true if there is an authenticated user on the current request | -| `url(url: String): Boolean` | Returns true if the current url matches the provided url. Add a `*` to the end of the url parameter to match any url that start with | -| `culture(name: String): Boolean` | Returns true if the current culture name or the current culture's parent name matches the `name` argument | +| Function | Description +|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| `isHomepage(): Boolean` | Returns true if the current request Url is the current homepage | +| `isAnonymous(): Boolean` | Returns true if there is no authenticated user on the current request | +| `isAuthenticated(): Boolean` | Returns true if there is an authenticated user on the current request | +| `url(url: String): Boolean` | Returns true if the current url matches the provided url. Add a `*` to the end of the url parameter to match any url that start with | +| `culture(name: String): Boolean` | Returns true if the current culture name or the current culture's parent name matches the `name` argument | #### Queries (`OrchardCore.Queries`) -| Function | Description -| -------- | ----------- | +| Function | Description +|------------------------------------------------------------------------------------------|----------------------------------| | `executeQuery(name: String, parameters: Dictionary): IEnumerable` | Returns the result of the query. | #### HTTP (`OrchardCore.Workflows.Http`) -| Function | Description -| -------- | ----------- | -| `httpContext(): HttpContext` | Returns the `HttpContext` which encapsulates all HTTP-specific information about an individual HTTP request. | -| `queryString(name: String): String | Array` | Returns the entire query string (including the leading `?`) when invoked with no arguments, or the value(s) of the parameter name passed in as an argument. | -| `responseWrite(text: String): void` | Writes the argument string directly to the HTTP response stream. | -| `absoluteUrl(relativePath: String): String` | Returns the absolute URL for the relative path argument. | -| `readBody(): String` | Returns the raw HTTP request body. | -| `requestForm(name: String): String | Array` | Returns the value(s) of the form field name passed in as an argument. | +| Function | Description +|--------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `httpContext(): HttpContext` | Returns the `HttpContext` which encapsulates all HTTP-specific information about an individual HTTP request. | +| `queryString(name: String): String | Array` | Returns the entire query string (including the leading `?`) when invoked with no arguments, or the value(s) of the parameter name passed in as an argument. | +| `responseWrite(text: String): void` | Writes the argument string directly to the HTTP response stream. | +| `absoluteUrl(relativePath: String): String` | Returns the absolute URL for the relative path argument. | +| `readBody(): String` | Returns the raw HTTP request body. | +| `requestForm(name: String): String | Array` | Returns the value(s) of the form field name passed in as an argument. | | `deserializeRequestData(): Dictionary` | Deserializes the request data as a Dictionary for requests that send JSON or form data. Replaces deprecated queryStringAsJson and requestFormAsJson methods | #### Recipes (`OrchardCore.Recipes`) -| Function | Description -| -------- | ----------- | -| `variables()` | Declare variables at the root of a recipe. Ex: `"variables": { "blogContentItemId": "[js:uuid()]" }` Retrieve a variable value like this: `"ContentItemId": "[js: variables('blogContentItemId')]"` | -| `parameters()` | Retrieves the parameters specified during the setup. Ex: `"Owner": "[js: parameters('AdminUserId')]"` See the available [Setup Recipe parameters](../Setup/README.md#recipe-parameters) | +| Function | Description +|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `variables()` | Declare variables at the root of a recipe. Ex: `"variables": { "blogContentItemId": "[js:uuid()]" }` Retrieve a variable value like this: `"ContentItemId": "[js: variables('blogContentItemId')]"` | +| `parameters()` | Retrieves the parameters specified during the setup. Ex: `"Owner": "[js: parameters('AdminUserId')]"` See the available [Setup Recipe parameters](../Setup/README.md#recipe-parameters) | | `configuration(key: String, defaultValue: String)` | Retrieves the specified configuration setting by its key, optionally providing a default. Ex: `[js: configuration('OrchardCore_Admin:AdminUrlPrefix', 'Admin')]` See [IShellConfiguration](../Configuration/README.md) | #### Workflows (`OrchardCore.Workflows.Http`) The following JavaScript functions are available by default to any workflow activity that supports script expressions: -| Function | Description | -| -------- | ----------- | -| `workflow(): WorkflowExecutionContext` | Returns the `WorkflowExecutionContext` which provides access to all information related to the current workflow execution context. | -| `workflowId(): String` | Returns the unique workflow ID. | -| `input(name: String): Any` | Returns the input parameter with the specified name. Input to the workflow is provided when the workflow is executed by the workflow manager. | -| `output(name: String, value: Any): void` | Sets an output parameter with the specified name. Workflow output can be collected by the invoker of the workflow. | -| `property(name: String): Any` | Returns the property value with the specified name. Properties are a dictionary that workflow activities can read and write information from and to. | -| `lastResult(): Any` | Returns the value that the previous activity provided, if any. | -| `correlationId(): String` | Returns the correlation value of the workflow instance. | -| `setCorrelationId(id:string): void` | Set the correlation value of the workflow instance. | -| `signalUrl(signal: String): String` | Returns workflow trigger URL with a protected SAS token into which the specified signal name is encoded. Use this to generate URLs that can be shared with trusted parties to trigger the current workflow if it is blocked on the Signal activity that is configured with the same signal name. | -| `setOutcome(outcome: String): void` | Adds the provided outcome to the list of outcomes of the current activity | -| `createWorkflowToken(workflowTypeId: String, activityId: String, expiresInDays: Integer): String` | Generates a workflow SAS token for the specidied workflowTypeid, activityId. You can also set the expiration date in number of days. | +| Function | Description | +|---------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `workflow(): WorkflowExecutionContext` | Returns the `WorkflowExecutionContext` which provides access to all information related to the current workflow execution context. | +| `workflowId(): String` | Returns the unique workflow ID. | +| `input(name: String): Any` | Returns the input parameter with the specified name. Input to the workflow is provided when the workflow is executed by the workflow manager. | +| `output(name: String, value: Any): void` | Sets an output parameter with the specified name. Workflow output can be collected by the invoker of the workflow. | +| `property(name: String): Any` | Returns the property value with the specified name. Properties are a dictionary that workflow activities can read and write information from and to. | +| `lastResult(): Any` | Returns the value that the previous activity provided, if any. | +| `correlationId(): String` | Returns the correlation value of the workflow instance. | +| `setCorrelationId(id:string): void` | Set the correlation value of the workflow instance. | +| `signalUrl(signal: String): String` | Returns workflow trigger URL with a protected SAS token into which the specified signal name is encoded. Use this to generate URLs that can be shared with trusted parties to trigger the current workflow if it is blocked on the Signal activity that is configured with the same signal name. | +| `setOutcome(outcome: String): void` | Adds the provided outcome to the list of outcomes of the current activity | +| `createWorkflowToken(workflowTypeId: String, activityId: String, expiresInDays: Integer): String` | Generates a workflow SAS token for the specidied workflowTypeid, activityId. You can also set the expiration date in number of days. | diff --git a/src/docs/reference/modules/Security/Permissions.md b/src/docs/reference/modules/Security/Permissions.md index a00dc956a47..593cc5c90e2 100644 --- a/src/docs/reference/modules/Security/Permissions.md +++ b/src/docs/reference/modules/Security/Permissions.md @@ -3,137 +3,137 @@ Orchard Core provides a comprehensive set of permissions to manage various aspects of the system. Below is a list of permissions along with their descriptions. Note that security critical permissions allow users to elevate their permissions and should be assigned with caution. -| Permission Group | Permission | Description | -|------------------|------------|-------------| -| Admin (OrchardCore.Admin) | AccessAdminPanel | Access admin panel | -| | ManageAdminSettings | Manage Admin Settings | -| Admin Menu (OrchardCore.AdminMenu) | ManageAdminMenu | Manage the admin menu | -| | ViewAdminMenu_[MenuName] | View Admin Menu - [MenuName] | -| | ViewAdminMenuAll | View Admin Menu - View All | -| Amazon Media Storage (OrchardCore.Media.AmazonS3) | ViewAmazonS3MediaOptions | View Amazon S3 Media Options | -| Audit Trail (OrchardCore.AuditTrail) | ManageAuditTrailSettings | Manage audit trail settings | -| | ViewAuditTrail | View audit trail | -| Autoroute (OrchardCore.Autoroute) | SetHomepage | Set homepage | -| Azure Media ImageSharp Image Cache (OrchardCore.Media.Azure.ImageSharpImageCache) | ViewAzureMediaOptions | View Azure Media Options | -| Background Tasks (OrchardCore.BackgroundTasks) | ManageBackgroundTasks | Manage background tasks | -| Permissions for each Content Type | Clone_[ContentType] | Clone [ContentType] by others | -| | CloneOwn_[ContentType] | Clone own [ContentType] | -| | DeleteOwn_[ContentType] | Delete [ContentType] | -| | Delete_[ContentType] | Delete [ContentType] for others | -| | EditOwn_[ContentType] | Edit [ContentType] | -| | Edit_[ContentType] | Edit [ContentType] for others | -| | EditContentOwner_[ContentType] | Edit the owner of a [ContentType] content item | -| | ListContent_[ContentType] | List [ContentType] content items | -| | Preview_[ContentType] | Preview [ContentType] by others | -| | PreviewOwn_[ContentType] | Preview own [ContentType] | -| | PublishOwn_[ContentType] | Publish or unpublish [ContentType] | -| | Publish_[ContentType] | Publish or unpublish [ContentType] for others | -| | View_[ContentType] | View [ContentType] by others | -| | ViewOwn_[ContentType] | View own [ContentType] | -| Content Localization (OrchardCore.ContentLocalization) | LocalizeContent | Localize content for others | -| | LocalizeOwnContent | Localize own content | -| | ManageContentCulturePicker | Manage ContentCulturePicker settings | -| Content Types (OrchardCore.ContentTypes) | EditContentTypes (security critical) | Edit content types | -| | ViewContentTypes | View content types | -| Contents (OrchardCore.Contents) | AccessContentApi | Access content via the api | -| | ApiViewContent | Access view content endpoints | -| | CloneContent | Clone content | -| | CloneOwnContent | Clone own content | -| | DeleteContent | Delete content for others | -| | DeleteOwnContent | Delete own content | -| | EditContent | Edit content for others | -| | EditOwnContent | Edit own content | -| | EditContentOwner | Edit the owner of a content item | -| | ListContent | List content items | -| | PreviewContent | Preview content | -| | PreviewOwnContent | Preview own content | -| | PublishContent | Publish or unpublish content for others | -| | PublishOwnContent | Publish or unpublish own content | -| | ViewContent | View all content | -| | ViewOwnContent | View own content | -| Custom Settings (OrchardCore.CustomSettings) | ManageCustomSettings_[CustomSettingsType] | Manage Custom Settings | -| Deployment (OrchardCore.Deployment) | Export | Export Data | -| | Import (security critical) | Import Data | -| | ManageDeploymentPlan | Manage deployment plans | -| Elasticsearch (OrchardCore.Search.Elasticsearch) | ManageElasticIndexes | Manage Elasticsearch Indexes | -| | QueryElasticsearchApi | Query Elasticsearch Api | -| Email (OrchardCore.Email) | ManageEmailSettings | Manage Email Settings | -| Features (OrchardCore.Features) | ManageFeatures | Manage Features | -| GitHub Authentication (OrchardCore.GitHub.Authentication) | ManageGitHubAuthentication | Manage GitHub Authentication settings | -| Google Tag Manager (OrchardCore.Google.TagManager) | ManageGoogleAnalytics | Manage Google Analytics settings | -| | ManageGoogleAuthentication | Manage Google Authentication settings | -| | ManageGoogleTagManager | Manage Google Tag Manager settings | -| GraphQL (OrchardCore.Apis.GraphQL) | ExecuteGraphQLMutations | Execute GraphQL Mutations | -| | ExecuteGraphQL | Execute GraphQL | -| HTTPS (OrchardCore.Https) | ManageHttps | Manage HTTPS | -| Layers (OrchardCore.Layers) | ManageLayers | Manage layers | -| Localization (OrchardCore.Localization) | ManageCultures | Manage supported culture | -| Media (OrchardCore.Media) | ManageMediaFolder | Manage All Media Folders | -| | ManageAttachedMediaFieldsFolder | Manage Attached Media Fields Folder | -| | ManageMediaContent | Manage Media | -| | ManageOthersMediaContent | Manage Media For Others | -| | ManageMediaProfiles | Manage Media Profiles | -| | ManageOwnMediaContent | Manage Own Media | -| | ViewMediaOptions | View Media Options | -| Media Cache (OrchardCore.Media.Cache) | ManageAssetCache | Manage Asset Cache Folder | -| Menu (OrchardCore.Menu) | ManageMenu | Manage menus | -| Meta Core Components (OrchardCore.Facebook) | ManageFacebookApp | View and edit the Facebook app | -| Meta Pixel (OrchardCore.Facebook.Pixel) | ManageFacebookPixel | Manage Facebook Pixel settings | -| Microsoft Entra ID (Azure Active Directory) Authentication (OrchardCore.Microsoft.Authentication.AzureAD) | ManageMicrosoftAuthentication | Manage Microsoft Authentication settings | -| Notifications (OrchardCore.Notifications) | ManageNotifications | Manage notifications | -| OpenID Connect Core Services (OrchardCore.OpenId) | ManageClientSettings | View and edit the OpenID Connect client settings | -| | ManageServerSettings | View and edit the OpenID Connect server settings | -| | ManageValidationSettings | View and edit the OpenID Connect validation settings | -| | ManageApplications | View, add, edit and remove the OpenID Connect applications | -| | ManageScopes | View, add, edit and remove the OpenID Connect scopes | -| Placements (OrchardCore.Placements) | ManagePlacements | Manage placements | -| Queries (OrchardCore.Queries) | ExecuteApiAll | Execute Api - All queries | -| | ExecuteApi_RecentBlogPosts | Execute Api - RecentBlogPosts | -| | ManageQueries | Manage queries | -| ReCaptcha (OrchardCore.ReCaptcha) | ManageReCaptchaSettings | Manage ReCaptcha Settings | -| Recipes (OrchardCore.Recipes) | ManageRecipes (security critical) | Manage Recipes | -| Remote Deployment (OrchardCore.Deployment.Remote) | ExportRemoteInstances | Export to remote instances | -| | ManageRemoteClients | Manage remote clients | -| | ManageRemoteInstances | Manage remote instances | -| Reverse Proxy Configuration (OrchardCore.ReverseProxy) | ManageReverseProxySettings | Manage Reverse Proxy Settings | -| Roles (OrchardCore.Roles) | ManageRoles (security critical) | Managing Roles | -| Search (OrchardCore.Search) | ManageSearchSettings | Manage Search Settings | -| | QuerySearchIndex | Query any index | -| Secure Media (OrchardCore.Media.Security) | ViewMediaContent | View media content in all folders | -| | ViewRootMediaContent | View media content in the root folder | -| | ViewOthersMediaContent | View others media content | -| | ViewOwnMediaContent | View own media content | -| | ViewMediaContent_[FolderName] | View media content in folder '[FolderName]' | -| Security (OrchardCore.Security) | ManageSecurityHeadersSettings | Manage Security Headers Settings | -| SEO (OrchardCore.Seo) | ManageSeoSettings | Manage SEO related settings | -| Settings (OrchardCore.Settings) | ManageSettings | Manage settings | -| Shortcode Templates (OrchardCore.Shortcodes.Templates) | ManageShortcodeTemplates (security critical) | Manage shortcode templates | -| Sitemaps (OrchardCore.Sitemaps) | ManageSitemaps | Manage sitemaps | -| SMS (OrchardCore.Sms) | ManageSmsSettings | Manage SMS Settings | -| SQL Queries (OrchardCore.Queries.Sql) | ManageSqlQueries | Manage SQL Queries | -| Taxonomies (OrchardCore.Taxonomies) | ManageTaxonomy | Manage taxonomies | -| Templates (OrchardCore.Templates) | ManageAdminTemplates (security critical) | Manage admin templates | -| | ManageTemplates (security critical) | Manage templates | -| Themes (OrchardCore.Themes) | ApplyTheme | Apply a Theme | -| Two-Factor Authentication Services (OrchardCore.Users.2FA) | DisableTwoFactorAuthenticationForUsers (security critical) | Disable two-factor authentication for any user | -| URL Rewriting (OrchardCore.UrlRewriting) | ManageUrlRewritingRules | Manage URLs rewriting rules | -| Users (OrchardCore.Users) | AssignRoleToUsers (security critical) | Assign any role to users | -| | AssignRoleToUsers_[RoleName] (security critical) | Assign [RoleName] role to users | -| | DeleteUsers (security critical) | Delete any user | -| | DeleteUsersInRole_[RoleName] (security critical) | Delete users in [RoleName] role | -| | EditUsers (security critical) | Edit any user | -| | ManageOwnUserInformation | Edit own user information | -| | EditUsersInRole_[RoleName] (security critical) | Edit users in [RoleName] role | -| | ListUsers | List all users | -| | ListUsersInRole_[RoleName] | List users in [RoleName] role | -| | ManageUsers (security critical) | Manage security settings and all users | -| | ManageUsersInRole_[RoleName] (security critical) | Manage users in [RoleName] role | -| | View Users | View user profiles | -| Workflows (OrchardCore.Workflows) | ExecuteWorkflows (security critical) | Execute workflows | -| | ManageWorkflowSettings | Manage workflow settings | -| | ManageWorkflows (security critical) | Manage workflows | -| X (Twitter) Integration (OrchardCore.Twitter) | ManageTwitterSignin | Manage Sign in with X (Twitter) settings | -| | ManageTwitter | Manage X (Twitter) settings | +| Permission Group | Permission | Description | +|-----------------------------------------------------------------------------------------------------------|------------------------------------------------------------|------------------------------------------------------------| +| Admin (OrchardCore.Admin) | AccessAdminPanel | Access admin panel | +| | ManageAdminSettings | Manage Admin Settings | +| Admin Menu (OrchardCore.AdminMenu) | ManageAdminMenu | Manage the admin menu | +| | ViewAdminMenu_[MenuName] | View Admin Menu - [MenuName] | +| | ViewAdminMenuAll | View Admin Menu - View All | +| Amazon Media Storage (OrchardCore.Media.AmazonS3) | ViewAmazonS3MediaOptions | View Amazon S3 Media Options | +| Audit Trail (OrchardCore.AuditTrail) | ManageAuditTrailSettings | Manage audit trail settings | +| | ViewAuditTrail | View audit trail | +| Autoroute (OrchardCore.Autoroute) | SetHomepage | Set homepage | +| Azure Media ImageSharp Image Cache (OrchardCore.Media.Azure.ImageSharpImageCache) | ViewAzureMediaOptions | View Azure Media Options | +| Background Tasks (OrchardCore.BackgroundTasks) | ManageBackgroundTasks | Manage background tasks | +| Permissions for each Content Type | Clone_[ContentType] | Clone [ContentType] by others | +| | CloneOwn_[ContentType] | Clone own [ContentType] | +| | DeleteOwn_[ContentType] | Delete [ContentType] | +| | Delete_[ContentType] | Delete [ContentType] for others | +| | EditOwn_[ContentType] | Edit [ContentType] | +| | Edit_[ContentType] | Edit [ContentType] for others | +| | EditContentOwner_[ContentType] | Edit the owner of a [ContentType] content item | +| | ListContent_[ContentType] | List [ContentType] content items | +| | Preview_[ContentType] | Preview [ContentType] by others | +| | PreviewOwn_[ContentType] | Preview own [ContentType] | +| | PublishOwn_[ContentType] | Publish or unpublish [ContentType] | +| | Publish_[ContentType] | Publish or unpublish [ContentType] for others | +| | View_[ContentType] | View [ContentType] by others | +| | ViewOwn_[ContentType] | View own [ContentType] | +| Content Localization (OrchardCore.ContentLocalization) | LocalizeContent | Localize content for others | +| | LocalizeOwnContent | Localize own content | +| | ManageContentCulturePicker | Manage ContentCulturePicker settings | +| Content Types (OrchardCore.ContentTypes) | EditContentTypes (security critical) | Edit content types | +| | ViewContentTypes | View content types | +| Contents (OrchardCore.Contents) | AccessContentApi | Access content via the api | +| | ApiViewContent | Access view content endpoints | +| | CloneContent | Clone content | +| | CloneOwnContent | Clone own content | +| | DeleteContent | Delete content for others | +| | DeleteOwnContent | Delete own content | +| | EditContent | Edit content for others | +| | EditOwnContent | Edit own content | +| | EditContentOwner | Edit the owner of a content item | +| | ListContent | List content items | +| | PreviewContent | Preview content | +| | PreviewOwnContent | Preview own content | +| | PublishContent | Publish or unpublish content for others | +| | PublishOwnContent | Publish or unpublish own content | +| | ViewContent | View all content | +| | ViewOwnContent | View own content | +| Custom Settings (OrchardCore.CustomSettings) | ManageCustomSettings_[CustomSettingsType] | Manage Custom Settings | +| Deployment (OrchardCore.Deployment) | Export | Export Data | +| | Import (security critical) | Import Data | +| | ManageDeploymentPlan | Manage deployment plans | +| Elasticsearch (OrchardCore.Search.Elasticsearch) | ManageElasticIndexes | Manage Elasticsearch Indexes | +| | QueryElasticsearchApi | Query Elasticsearch Api | +| Email (OrchardCore.Email) | ManageEmailSettings | Manage Email Settings | +| Features (OrchardCore.Features) | ManageFeatures | Manage Features | +| GitHub Authentication (OrchardCore.GitHub.Authentication) | ManageGitHubAuthentication | Manage GitHub Authentication settings | +| Google Tag Manager (OrchardCore.Google.TagManager) | ManageGoogleAnalytics | Manage Google Analytics settings | +| | ManageGoogleAuthentication | Manage Google Authentication settings | +| | ManageGoogleTagManager | Manage Google Tag Manager settings | +| GraphQL (OrchardCore.Apis.GraphQL) | ExecuteGraphQLMutations | Execute GraphQL Mutations | +| | ExecuteGraphQL | Execute GraphQL | +| HTTPS (OrchardCore.Https) | ManageHttps | Manage HTTPS | +| Layers (OrchardCore.Layers) | ManageLayers | Manage layers | +| Localization (OrchardCore.Localization) | ManageCultures | Manage supported culture | +| Media (OrchardCore.Media) | ManageMediaFolder | Manage All Media Folders | +| | ManageAttachedMediaFieldsFolder | Manage Attached Media Fields Folder | +| | ManageMediaContent | Manage Media | +| | ManageOthersMediaContent | Manage Media For Others | +| | ManageMediaProfiles | Manage Media Profiles | +| | ManageOwnMediaContent | Manage Own Media | +| | ViewMediaOptions | View Media Options | +| Media Cache (OrchardCore.Media.Cache) | ManageAssetCache | Manage Asset Cache Folder | +| Menu (OrchardCore.Menu) | ManageMenu | Manage menus | +| Meta Core Components (OrchardCore.Facebook) | ManageFacebookApp | View and edit the Facebook app | +| Meta Pixel (OrchardCore.Facebook.Pixel) | ManageFacebookPixel | Manage Facebook Pixel settings | +| Microsoft Entra ID (Azure Active Directory) Authentication (OrchardCore.Microsoft.Authentication.AzureAD) | ManageMicrosoftAuthentication | Manage Microsoft Authentication settings | +| Notifications (OrchardCore.Notifications) | ManageNotifications | Manage notifications | +| OpenID Connect Core Services (OrchardCore.OpenId) | ManageClientSettings | View and edit the OpenID Connect client settings | +| | ManageServerSettings | View and edit the OpenID Connect server settings | +| | ManageValidationSettings | View and edit the OpenID Connect validation settings | +| | ManageApplications | View, add, edit and remove the OpenID Connect applications | +| | ManageScopes | View, add, edit and remove the OpenID Connect scopes | +| Placements (OrchardCore.Placements) | ManagePlacements | Manage placements | +| Queries (OrchardCore.Queries) | ExecuteApiAll | Execute Api - All queries | +| | ExecuteApi_RecentBlogPosts | Execute Api - RecentBlogPosts | +| | ManageQueries | Manage queries | +| ReCaptcha (OrchardCore.ReCaptcha) | ManageReCaptchaSettings | Manage ReCaptcha Settings | +| Recipes (OrchardCore.Recipes) | ManageRecipes (security critical) | Manage Recipes | +| Remote Deployment (OrchardCore.Deployment.Remote) | ExportRemoteInstances | Export to remote instances | +| | ManageRemoteClients | Manage remote clients | +| | ManageRemoteInstances | Manage remote instances | +| Reverse Proxy Configuration (OrchardCore.ReverseProxy) | ManageReverseProxySettings | Manage Reverse Proxy Settings | +| Roles (OrchardCore.Roles) | ManageRoles (security critical) | Managing Roles | +| Search (OrchardCore.Search) | ManageSearchSettings | Manage Search Settings | +| | QuerySearchIndex | Query any index | +| Secure Media (OrchardCore.Media.Security) | ViewMediaContent | View media content in all folders | +| | ViewRootMediaContent | View media content in the root folder | +| | ViewOthersMediaContent | View others media content | +| | ViewOwnMediaContent | View own media content | +| | ViewMediaContent_[FolderName] | View media content in folder '[FolderName]' | +| Security (OrchardCore.Security) | ManageSecurityHeadersSettings | Manage Security Headers Settings | +| SEO (OrchardCore.Seo) | ManageSeoSettings | Manage SEO related settings | +| Settings (OrchardCore.Settings) | ManageSettings | Manage settings | +| Shortcode Templates (OrchardCore.Shortcodes.Templates) | ManageShortcodeTemplates (security critical) | Manage shortcode templates | +| Sitemaps (OrchardCore.Sitemaps) | ManageSitemaps | Manage sitemaps | +| SMS (OrchardCore.Sms) | ManageSmsSettings | Manage SMS Settings | +| SQL Queries (OrchardCore.Queries.Sql) | ManageSqlQueries | Manage SQL Queries | +| Taxonomies (OrchardCore.Taxonomies) | ManageTaxonomy | Manage taxonomies | +| Templates (OrchardCore.Templates) | ManageAdminTemplates (security critical) | Manage admin templates | +| | ManageTemplates (security critical) | Manage templates | +| Themes (OrchardCore.Themes) | ApplyTheme | Apply a Theme | +| Two-Factor Authentication Services (OrchardCore.Users.2FA) | DisableTwoFactorAuthenticationForUsers (security critical) | Disable two-factor authentication for any user | +| URL Rewriting (OrchardCore.UrlRewriting) | ManageUrlRewritingRules | Manage URLs rewriting rules | +| Users (OrchardCore.Users) | AssignRoleToUsers (security critical) | Assign any role to users | +| | AssignRoleToUsers_[RoleName] (security critical) | Assign [RoleName] role to users | +| | DeleteUsers (security critical) | Delete any user | +| | DeleteUsersInRole_[RoleName] (security critical) | Delete users in [RoleName] role | +| | EditUsers (security critical) | Edit any user | +| | ManageOwnUserInformation | Edit own user information | +| | EditUsersInRole_[RoleName] (security critical) | Edit users in [RoleName] role | +| | ListUsers | List all users | +| | ListUsersInRole_[RoleName] | List users in [RoleName] role | +| | ManageUsers (security critical) | Manage security settings and all users | +| | ManageUsersInRole_[RoleName] (security critical) | Manage users in [RoleName] role | +| | View Users | View user profiles | +| Workflows (OrchardCore.Workflows) | ExecuteWorkflows (security critical) | Execute workflows | +| | ManageWorkflowSettings | Manage workflow settings | +| | ManageWorkflows (security critical) | Manage workflows | +| X (Twitter) Integration (OrchardCore.Twitter) | ManageTwitterSignin | Manage Sign in with X (Twitter) settings | +| | ManageTwitter | Manage X (Twitter) settings | ### Writing New Permissions diff --git a/src/docs/reference/modules/Security/README.md b/src/docs/reference/modules/Security/README.md index 6687d79d425..54467d97e87 100644 --- a/src/docs/reference/modules/Security/README.md +++ b/src/docs/reference/modules/Security/README.md @@ -6,12 +6,12 @@ This module adds `HTTP` headers to follow security best practices. Enabling the `OrchardCore.Security` module will allow the user to set the following settings: -| Setting | Description | -| --- | --- | +| Setting | Description | +|-------------------------|---------------------------------------------------------| | `ContentSecurityPolicy` | Gets or sets the `Content-Security-Policy` HTTP header. | -| `ContentTypeOptions` | Gets or sets the `X-Content-Type-Options` HTTP header. | -| `PermissionsPolicy` | Gets or sets the `Permissions-Policy` HTTP header. | -| `ReferrerPolicy` | Gets or sets the `Referrer-Policy` HTTP header. | +| `ContentTypeOptions` | Gets or sets the `X-Content-Type-Options` HTTP header. | +| `PermissionsPolicy` | Gets or sets the `Permissions-Policy` HTTP header. | +| `ReferrerPolicy` | Gets or sets the `Referrer-Policy` HTTP header. | !!! note The `Content-Security-Policy` HTTP header contains the `frame-ancestors` directive which obsoleted the `X-Frame-Options` HTTP header. diff --git a/src/docs/reference/modules/Setup/README.md b/src/docs/reference/modules/Setup/README.md index 25bf75ebbce..61a61270197 100644 --- a/src/docs/reference/modules/Setup/README.md +++ b/src/docs/reference/modules/Setup/README.md @@ -6,16 +6,16 @@ When you begin with an empty site, a start screen allows you to setup the differ During setup, all recipes have access to the setup screen values using these parameters: -| Parameter | Description | -| --- | --- | -| `SiteName` | The name of the site. | -| `AdminUserId` | The user id of the super user. | -| `AdminUsername` | The username of the super user. | -| `AdminEmail` | The email of the super user. | -| `AdminPassword` | The password of the super user. | -| `DatabaseProvider` | The database provider. | -| `DatabaseConnectionString` | The connection string. | -| `DatabaseTablePrefix` | The database table prefix. | +| Parameter | Description | +|----------------------------|---------------------------------| +| `SiteName` | The name of the site. | +| `AdminUserId` | The user id of the super user. | +| `AdminUsername` | The username of the super user. | +| `AdminEmail` | The email of the super user. | +| `AdminPassword` | The password of the super user. | +| `DatabaseProvider` | The database provider. | +| `DatabaseConnectionString` | The connection string. | +| `DatabaseTablePrefix` | The database table prefix. | These parameters can be used in the recipe using a scripted value like `[js: parameters('AdminUserId')]`. @@ -95,10 +95,10 @@ The following configuration values are used by default and can be customized: } ``` -| Key | Description | -| --- | --- | -| `DefaultCulture` | The default culture that will be used for the setup screen. | -| `SupportedCultures` | The list of the supported cultures for the setup screen. | +| Key | Description | +|---------------------|-------------------------------------------------------------| +| `DefaultCulture` | The default culture that will be used for the setup screen. | +| `SupportedCultures` | The list of the supported cultures for the setup screen. | ## CDN disabled by default diff --git a/src/docs/reference/modules/Shortcodes/README.md b/src/docs/reference/modules/Shortcodes/README.md index 61ff2938643..db922079539 100644 --- a/src/docs/reference/modules/Shortcodes/README.md +++ b/src/docs/reference/modules/Shortcodes/README.md @@ -12,32 +12,32 @@ Shortcode templates with [Liquid](../Liquid/README.md) are created through the _ Shortcode templates are designed to be able to override a code based Shortcode of the same name. -| Parameter | Description | -| --------- | ----------- | -| `Name` | The name of your Shortcode, without brackets. | -| `Hint` | The hint to display for your Shortcode. -| `Usage` | An html string to describe the usage and arguments for your Shortcode. | -| `Categories` | The categories your Shortcode falls under. | +| Parameter | Description | +|--------------------|------------------------------------------------------------------------------------------| +| `Name` | The name of your Shortcode, without brackets. | +| `Hint` | The hint to display for your Shortcode. +| `Usage` | An html string to describe the usage and arguments for your Shortcode. | +| `Categories` | The categories your Shortcode falls under. | | `Return Shortcode` | The Shortcode value to return from the Shortcode picker when selected. Defaults to Name. | -| `Content` | The Liquid template for your Shortcode. | +| `Content` | The Liquid template for your Shortcode. | ### Template Arguments -| Parameter | Description | -| --------- | ----------- | -| `Args` | The arguments provided the user, if any. | -| `Content` | The inner content provided by the user, if any. +| Parameter | Description | +|-----------|--------------------------------------------------------------------------------------| +| `Args` | The arguments provided the user, if any. | +| `Content` | The inner content provided by the user, if any. | `Context` | The context made available to the Shortcode from the caller, e.g. an `HtmlBodyPart`. | ### Example Shortcode Templates #### `[display_text]` -| Parameter | Value | -| --------- | ----------- | -| `Name` | display_text | -| `Hint` | Returns the display text of the content item. | -| `Usage` | [display_text] | +| Parameter | Value | +|-----------|---------------------------------------------------------| +| `Name` | display_text | +| `Hint` | Returns the display text of the content item. | +| `Usage` | [display_text] | | `Content` | `{{ Context.ContentItem.DisplayText }}`
`{{ More }}` | !!! note @@ -45,20 +45,20 @@ Shortcode templates are designed to be able to override a code based Shortcode o #### `[site_name]` -| Parameter | Value | -| --------- | ----------- | -| `Name` | site_name | -| `Hint` | Returns the site name. | -| `Usage` | [site_name] | -| `Content` | `{{ Site.SiteName }}` | +| Parameter | Value | +|-----------|------------------------| +| `Name` | site_name | +| `Hint` | Returns the site name. | +| `Usage` | [site_name] | +| `Content` | `{{ Site.SiteName }}` | #### `[primary]` -| Parameter | Value | -| --------- | ----------- | -| `Name` | primary | -| `Hint` | Formats text in the themes primary color. | -| `Usage` | [primary text]<br<[primary]text[/primary] | +| Parameter | Value | +|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `Name` | primary | +| `Hint` | Formats text in the themes primary color. | +| `Usage` | [primary text]<br<[primary]text[/primary] | | `Content` | `{% capture output %}`
`{% if Args.Text != nil %}`
`{{Args.Text}}`
`{% else %}`
`{{Content}}`
`{% endif %}`
`{% endcapture %}`
`{{ output | sanitize | raw }}` | ## Shortcodes via code @@ -67,11 +67,11 @@ Shortcode templates are designed to be able to override a code based Shortcode o Shortcodes can be registered in code via a `ShortcodeDelegate` using the `AddShortcode` extension method. -| Parameter | Type | Description | -| --------- | ---- |------------ | -| `Name` | `string` | The name of the Shortcode. | -| `Shortcode` | `ShortcodeDelegate` | The Shortcode Delegate. | -| `Describe` | `Action` | Optionally a Description of the Shortcode. | +| Parameter | Type | Description | +|-------------|---------------------------|--------------------------------------------| +| `Name` | `string` | The name of the Shortcode. | +| `Shortcode` | `ShortcodeDelegate` | The Shortcode Delegate. | +| `Describe` | `Action` | Optionally a Description of the Shortcode. | In this example, we register a `[bold]` Shortcode Delegate and describe the Shortcode. diff --git a/src/docs/reference/modules/Sms.Azure/README.md b/src/docs/reference/modules/Sms.Azure/README.md index 33f014e884f..20e671e86fc 100644 --- a/src/docs/reference/modules/Sms.Azure/README.md +++ b/src/docs/reference/modules/Sms.Azure/README.md @@ -6,10 +6,10 @@ This feature provides SMS providers for sending SMS through [Azure Communication Enabling this feature will introduce a new tab labeled **Azure Communication Services** within the SMS settings, allowing you to configure the service. To access these settings from the admin dashboard, navigate to `Configuration` → `Settings` → `Sms` and click on the **Azure Communication Services** tab. The following are the available settings. -| Provider | Description | -| --- | --- | -| `Azure` | This provider enables tenant-specific Azure Communication Services for sending SMS. Configure the SMS settings to activate this provider. | -| `DefaultAzure` | This provider sets default Azure Communication Service configurations for all tenants.| +| Provider | Description | +|----------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| `Azure` | This provider enables tenant-specific Azure Communication Services for sending SMS. Configure the SMS settings to activate this provider. | +| `DefaultAzure` | This provider sets default Azure Communication Service configurations for all tenants. | ## **Default Azure Communication Services** Provider Configuration diff --git a/src/docs/reference/modules/Sms/README.md b/src/docs/reference/modules/Sms/README.md index fb90d681a67..49b28b0abaa 100644 --- a/src/docs/reference/modules/Sms/README.md +++ b/src/docs/reference/modules/Sms/README.md @@ -6,10 +6,10 @@ This module provides SMS settings configuration. Enabling the `SMS` feature will add a new settings page under `Configurations` >> `Settings` >> `SMS`. You can utilize these settings to set up the default SMS provider configuration. The following are the providers that are readily accessible. -| Provider | Description | -| --- | --- | -| `Log` | This particular provider is exclusively meant for debugging purposes and should never be used in a production environment. It permits the message to be written to the logs. | -| `Twilio` | Opting for this provider enables the utilization of Twilio service for sending SMS messages. Edit the SMS settings to enable this provider. | +| Provider | Description | +|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `Log` | This particular provider is exclusively meant for debugging purposes and should never be used in a production environment. It permits the message to be written to the logs. | +| `Twilio` | Opting for this provider enables the utilization of Twilio service for sending SMS messages. Edit the SMS settings to enable this provider. | !!! note After enabling the SMS feature, you must configure the default provider in order to send SMS messages. diff --git a/src/docs/reference/modules/Taxonomies/README.md b/src/docs/reference/modules/Taxonomies/README.md index 3e215f1e956..6ff03aeb60f 100644 --- a/src/docs/reference/modules/Taxonomies/README.md +++ b/src/docs/reference/modules/Taxonomies/README.md @@ -54,19 +54,19 @@ You can also specify a `TermContentItemId` to render a part of the term hierarch ``` -| Property | Description | -| --------- | ------------ | -| `Model.TaxonomyContentItemId` | If defined, contains the content item identifier of the taxonomy to render. | -| `Model.Items` | The list of term items shapes for the taxonomy. These are shapes of type `TermItem`. | -| `Model.Differentiator` | If defined, contains the formatted name of the taxonomy (display text). For instance `Categories`. | -| `Model.TermContentItemId` | If defined, contains the content item identifier of the term to start rendering the hierarchy. | +| Property | Description | +|-------------------------------|----------------------------------------------------------------------------------------------------| +| `Model.TaxonomyContentItemId` | If defined, contains the content item identifier of the taxonomy to render. | +| `Model.Items` | The list of term items shapes for the taxonomy. These are shapes of type `TermItem`. | +| `Model.Differentiator` | If defined, contains the formatted name of the taxonomy (display text). For instance `Categories`. | +| `Model.TermContentItemId` | If defined, contains the content item identifier of the term to start rendering the hierarchy. | #### Term Alternates -| Definition | Template | Filename| -| ---------- | --------- | ------------ | +| Definition | Template | Filename | +|--------------------------|--------------------|--------------------------| | `Term__[Differentiator]` | `Term__Categories` | `Term-Categories.cshtml` | -| `Term__[ContentType]` | `Term__Category` | `Term-Category.cshtml` | +| `Term__[ContentType]` | `Term__Category` | `Term-Category.cshtml` | #### Term Examples @@ -106,29 +106,29 @@ You can also specify a `TermContentItemId` to render a part of the term hierarch The `TermItem` shape is used to render a term item. -| Property | Description | -| --------- | ------------ | -| `Model.Term` | The `Term` shape owning this item. | -| `Model.TaxonomyContentItem` | The `TaxonomyContentItem`. | -| `Model.TermContentItem` | The `TermContentItem` for this item. | -| `Model.Level` | The level of the term item. `0` for top level term items. | -| `Model.Items` | The list of sub term items shapes. These are shapes of type `TermItem`. | -| `Model.Terms` | The list of term content items for the lower items in the hierarchy. | -| `Model.Differentiator` | If defined, contains the formatted name of the taxonomy. For instance `Categories`. | +| Property | Description | +|-----------------------------|-------------------------------------------------------------------------------------| +| `Model.Term` | The `Term` shape owning this item. | +| `Model.TaxonomyContentItem` | The `TaxonomyContentItem`. | +| `Model.TermContentItem` | The `TermContentItem` for this item. | +| `Model.Level` | The level of the term item. `0` for top level term items. | +| `Model.Items` | The list of sub term items shapes. These are shapes of type `TermItem`. | +| `Model.Terms` | The list of term content items for the lower items in the hierarchy. | +| `Model.Differentiator` | If defined, contains the formatted name of the taxonomy. For instance `Categories`. | !!! note When rendering a partial hierarchy of terms using the `TermContentItemId` property, the level is always based of the taxonomy root. #### TermItem Alternates -| Definition | Template | Filename| -| ---------- | --------- | ------------ | -| `TermItem__level__[level]` | `TermItem__level__2` | `TermItem-level-2.cshtml` | -| `TermItem__[ContentType]` | `TermItem__Category` | `TermItem-Category.cshtml` | -| `TermItem__[ContentType]__level__[level]` | `TermItem__Category__level__2` | `TermItem-Category-level-2.cshtml` | -| `TermItem__[Differentiator]` | `TermItem__Categories` | `TermItem-Categories.cshtml` | -| `TermItem__[Differentiator]__level__[level]` | `TermItem__Categories__level__2` | `TermItem-Categories-level-2.cshtml` | -| `TermItem__[Differentiator]__[ContentType]` | `TermItem__Categories__Category` | `TermItem-Categories-Category.cshtml` | +| Definition | Template | Filename | +|-------------------------------------------------------------|-----------------------------------------------|-----------------------------------------------| +| `TermItem__level__[level]` | `TermItem__level__2` | `TermItem-level-2.cshtml` | +| `TermItem__[ContentType]` | `TermItem__Category` | `TermItem-Category.cshtml` | +| `TermItem__[ContentType]__level__[level]` | `TermItem__Category__level__2` | `TermItem-Category-level-2.cshtml` | +| `TermItem__[Differentiator]` | `TermItem__Categories` | `TermItem-Categories.cshtml` | +| `TermItem__[Differentiator]__level__[level]` | `TermItem__Categories__level__2` | `TermItem-Categories-level-2.cshtml` | +| `TermItem__[Differentiator]__[ContentType]` | `TermItem__Categories__Category` | `TermItem-Categories-Category.cshtml` | | `TermItem__[Differentiator]__[ContentType]__level__[level]` | `TermItem__Categories__ContentType__level__2` | `TermItem-Categories-Category-level-2.cshtml` | #### TermItem Example @@ -180,26 +180,26 @@ The `TermContentItem` shape is used to render the term content item. This shape is created by morphing a `TermItem` shape into a `TermContentItem`. Hence all the properties available on the `TermItem` shape are still available. -| Property | Description | -| --------- | ------------ | -| `Model.Term` | The `Term` shape owning this item. | -| `Model.TaxonomyContentItem` | The `TaxonomyContentItem`. | -| `Model.TermContentItem` | The `TermContentItem` for this item. | -| `Model.Level` | The level of the term item. `0` for top level term items. | -| `Model.Items` | The list of sub term items shapes. These are shapes of type `TermItem`. | -| `Model.Terms` | The list of term content items for the lower items in the hierarchy. | -| `Model.Differentiator` | If defined, contains the formatted name of the term. For instance `Travel`. | +| Property | Description | +|-----------------------------|-----------------------------------------------------------------------------| +| `Model.Term` | The `Term` shape owning this item. | +| `Model.TaxonomyContentItem` | The `TaxonomyContentItem`. | +| `Model.TermContentItem` | The `TermContentItem` for this item. | +| `Model.Level` | The level of the term item. `0` for top level term items. | +| `Model.Items` | The list of sub term items shapes. These are shapes of type `TermItem`. | +| `Model.Terms` | The list of term content items for the lower items in the hierarchy. | +| `Model.Differentiator` | If defined, contains the formatted name of the term. For instance `Travel`. | #### TermContentItem Alternates -| Definition | Template | Filename| -| ---------- | --------- | ------------ | -| `TermContentItem__level__[level]` | `TermContentItem__level__2` | `TermContentItem-level-2.cshtml` | -| `TermContentItem__[ContentType]` | `TermContentItem__Category` | `TermContentItem-Category.cshtml` | -| `TermContentItem__[ContentType]__level__[level]` | `TermContentItem__Category__level__2` | `TermContentItem-Category-level-2.cshtml` | -| `TermContentItem__[Differentiator]` | `TermContentItem__Categories` | `TermContentItem-Categories.cshtml` | -| `TermContentItem__[Differentiator]__level__[level]` | `TermContentItem__Categories__level__2` | `TermContentItem-Categories-level-2.cshtml` | -| `TermContentItem__[Differentiator]__[ContentType]` | `TermContentItem__Categories__Category` | `TermContentItem-Categories-Category.cshtml` | +| Definition | Template | Filename | +|--------------------------------------------------------------------|---------------------------------------------------|------------------------------------------------------| +| `TermContentItem__level__[level]` | `TermContentItem__level__2` | `TermContentItem-level-2.cshtml` | +| `TermContentItem__[ContentType]` | `TermContentItem__Category` | `TermContentItem-Category.cshtml` | +| `TermContentItem__[ContentType]__level__[level]` | `TermContentItem__Category__level__2` | `TermContentItem-Category-level-2.cshtml` | +| `TermContentItem__[Differentiator]` | `TermContentItem__Categories` | `TermContentItem-Categories.cshtml` | +| `TermContentItem__[Differentiator]__level__[level]` | `TermContentItem__Categories__level__2` | `TermContentItem-Categories-level-2.cshtml` | +| `TermContentItem__[Differentiator]__[ContentType]` | `TermContentItem__Categories__Category` | `TermContentItem-Categories-Category.cshtml` | | `TermContentItem__[Differentiator]__[ContentType]__level__[level]` | `TermContentItem__Categories__Category__level__2` | `TermContentItem-Categories-Category-level-2.cshtml` | #### TermContentItem Example @@ -225,10 +225,10 @@ The shape base class is of type `DisplayTaxonomyFieldViewModel`. The following properties are available on the `TaxonomyField` class. -| Property | Type | Description | -| --------- | ---- |------------ | -| `TaxonomyContentItemId` | `string` | The Content Item id of the taxonomy associated with the field. | -| `TermContentItemIds` | `string[]` | The list of Content Item ids of the terms selected for this field. | +| Property | Type | Description | +|-------------------------|------------|--------------------------------------------------------------------| +| `TaxonomyContentItemId` | `string` | The Content Item id of the taxonomy associated with the field. | +| `TermContentItemIds` | `string[]` | The list of Content Item ids of the terms selected for this field. | ### DisplayTaxonomyFieldViewModel @@ -236,11 +236,11 @@ This class is used when displaying a field. The following properties are available on the `DisplayTaxonomyFieldViewModel` class. -| Property | Type | Description | -| --------- | ---- |------------ | -| `Field` | `TaxonomyField` | The `TaxonomyField` instance| -| `Part` | `ContentPart` | The part this field attached to | -| `PartFieldDefinition` | `ContentPartFieldDefinition` | The part field definition | +| Property | Type | Description | +|-----------------------|------------------------------|---------------------------------| +| `Field` | `TaxonomyField` | The `TaxonomyField` instance | +| `Part` | `ContentPart` | The part this field attached to | +| `PartFieldDefinition` | `ContentPartFieldDefinition` | The part field definition | ## Orchard Helpers @@ -344,14 +344,14 @@ The first argument must be the taxonomy content item or content item id. The `TaxonomyIndex` SQL table contains a list of all content items that are associated with a Taxonomy field. Each record corresponds to a selected term for a field. -| Column | Type | Description | -| --------- | ---- |------------ | -| TaxonomyContentItemId | `string` | The content item id of the Taxonomy | -| ContentItemId | `string` | The content item id of the categorized content | -| ContentType | `string` | The content type of the categorized content | -| ContentPart | `string` | The content part containing the field | -| ContentField | `string` | The name of the field in the content part | -| TermContentItemId | `string` | The content item id of the categorized Term | +| Column | Type | Description | +|-----------------------|----------|------------------------------------------------| +| TaxonomyContentItemId | `string` | The content item id of the Taxonomy | +| ContentItemId | `string` | The content item id of the categorized content | +| ContentType | `string` | The content type of the categorized content | +| ContentPart | `string` | The content part containing the field | +| ContentField | `string` | The name of the field in the content part | +| TermContentItemId | `string` | The content item id of the categorized Term | For instance if a field has two selected terms, there will be two records with all identical column values except for the `TermContentItemId`. diff --git a/src/docs/reference/modules/Templates/README.md b/src/docs/reference/modules/Templates/README.md index 1826ddeaa97..0db8560139d 100644 --- a/src/docs/reference/modules/Templates/README.md +++ b/src/docs/reference/modules/Templates/README.md @@ -26,18 +26,18 @@ This template is called when displaying a content item with the `Detail` display #### Content Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|---------------------|---------------------------| | `Content__BlogPost` | `Content-BlogPost.cshtml` | -| `Content__Article` | `Content-Article.cshtml` | +| `Content__Article` | `Content-Article.cshtml` | #### Content Available properties -| Property | Description | -| --------- | ------------ | -| `Model.Content` | A zone shape that contains all the shapes generated by the content's parts and fields. | -| `Model.ContentItem` | Represents the current content item being rendered by the template. | -| `Model.ContentItem.Content` | A JSON object containing all the data of the content item. | +| Property | Description | +|-----------------------------|----------------------------------------------------------------------------------------| +| `Model.Content` | A zone shape that contains all the shapes generated by the content's parts and fields. | +| `Model.ContentItem` | Represents the current content item being rendered by the template. | +| `Model.ContentItem.Content` | A JSON object containing all the data of the content item. | ### `Content_[DisplayType]__[ContentType]` @@ -46,10 +46,10 @@ For instance, when a content item is displayed in a list, the `Summary` display #### Content with Display Type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|-----------------------------|-----------------------------------| | `Content_Summary__BlogPost` | `Content-BlogPost.Summary.cshtml` | -| `Content_Summary__Article` | `Content-Article.Summary.cshtml` | +| `Content_Summary__Article` | `Content-Article.Summary.cshtml` | ### `Content__Alias__[Alias]` @@ -82,9 +82,9 @@ This template is called when displaying a content item with a specific slug (i.e #### Content with Slug and Display Type Examples -| Template | Filename | -|-----------------------------------|----------------------------------------| -| `Content_Summary__Slug__example` | `Content-Slug-example.Summary.cshtml` | +| Template | Filename | +|-----------------------------------------|--------------------------------------------| +| `Content_Summary__Slug__example` | `Content-Slug-example.Summary.cshtml` | | `Content_Summary__Slug__blog__my__post` | `Content-Slug-blog-my-post.Summary.cshtml` | ## Widget templates @@ -95,19 +95,19 @@ This template is called when a widget is rendered on a page. #### Widget Examples -| Template | Filename| -| --------- | ------------ | -| `Widget__Paragraph` | `Widget-Paragraph.cshtml` | +| Template | Filename | +|----------------------|----------------------------| +| `Widget__Paragraph` | `Widget-Paragraph.cshtml` | | `Widget__Blockquote` | `Widget-Blockquote.cshtml` | #### Widget Available properties -| Property | Description | -| --------- | ------------ | -| `Model.Content` | A zone shape that contains all the shapes generated by the widget's parts and fields. | -| `Model.ContentItem` | Represents the current content item being rendered by the template. | -| `Model.ContentItem.Content` | A JSON object containing all the data of the content item. | -| `Model.Classes` | An array of all the classes attached to the widget. | +| Property | Description | +|-----------------------------|---------------------------------------------------------------------------------------| +| `Model.Content` | A zone shape that contains all the shapes generated by the widget's parts and fields. | +| `Model.ContentItem` | Represents the current content item being rendered by the template. | +| `Model.ContentItem.Content` | A JSON object containing all the data of the content item. | +| `Model.Classes` | An array of all the classes attached to the widget. | ### `Widget__Alias__[Alias]` @@ -115,15 +115,15 @@ This template is called when displaying a widget content item with a specific al #### Widget with Alias Examples -| Template | Filename | -|----------------------------|--------------------------------| +| Template | Filename | +|---------------------------|-------------------------------| | `Widget__Alias__example` | `Widget-Alias-example.cshtml` | | `Widget__Alias__my__page` | `Widget-Alias-my-page.cshtml` | #### Widget with Alias and Display Type Examples -| Template | Filename | -|------------------------------------|----------------------------------------| +| Template | Filename | +|-----------------------------------|---------------------------------------| | `Widget_Summary__Alias__example` | `Widget-Alias-example.Summary.cshtml` | | `Widget_Summary__Alias__my__page` | `Widget-Alias-my-page.Summary.cshtml` | @@ -133,16 +133,16 @@ This template is called when displaying a widget content item with a specific sl #### Widget with Slug Examples -| Template | Filename | -|---------------------------------|------------------------------------| +| Template | Filename | +|--------------------------------|-----------------------------------| | `Widget__Slug__example` | `Widget-Slug-example.cshtml` | | `Widget__Slug__blog__my__post` | `Widget-Slug-blog-my-post.cshtml` | #### Widget with Slug and Display Type Examples -| Template | Filename | -|-----------------------------------|----------------------------------------| -| `Widget_Summary__Slug__example` | `Widget-Slug-example.Summary.cshtml` | +| Template | Filename | +|----------------------------------------|-------------------------------------------| +| `Widget_Summary__Slug__example` | `Widget-Slug-example.Summary.cshtml` | | `Widget_Summary__Slug__blog__my__post` | `Widget-Slug-blog-my-post.Summary.cshtml` | ## Content Part templates @@ -167,8 +167,8 @@ This template is called when a Content Part is rendered. #### Shape Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|----------------|-----------------------| | `HtmlBodyPart` | `HtmlBodyPart.cshtml` | | `ListPartFeed` | `ListPartFeed.cshtml` | @@ -178,8 +178,8 @@ This template is called when a Content Part shape type is rendered in a specific #### Shape with Display Type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|------------------------|-------------------------------| | `HtmlBodyPart_Summary` | `HtmlBodyPart.Summary.cshtml` | ### `[ContentType]_[DisplayType]__[PartType]` @@ -188,11 +188,11 @@ This template is called when a content part type is rendered for a given content #### Content with Part Type Examples -| Template | Filename| -| --------- | ------------ | -| `Blog__HtmlBodyPart` | `Blog-HtmlBodyPart.cshtml` | -| `LandingPage__BagPart` | `LandingPage-BagPart.cshtml` | -| `Blog_Summary__HtmlBodyPart` | `Blog-HtmlBodyPart.Summary.cshtml` | +| Template | Filename | +|--------------------------------|--------------------------------------| +| `Blog__HtmlBodyPart` | `Blog-HtmlBodyPart.cshtml` | +| `LandingPage__BagPart` | `LandingPage-BagPart.cshtml` | +| `Blog_Summary__HtmlBodyPart` | `Blog-HtmlBodyPart.Summary.cshtml` | | `LandingPage_Summary__BagPart` | `LandingPage-BagPart.Summary.cshtml` | ### `[ContentType]_[DisplayType]__[PartName]` @@ -201,9 +201,9 @@ This template is called when a content part name is rendered for a given content #### Content with Part name Examples -| Template | Filename| -| --------- | ------------ | -| `LandingPage__Services` | `LandingPage-Services.cshtml` | +| Template | Filename | +|---------------------------------|---------------------------------------| +| `LandingPage__Services` | `LandingPage-Services.cshtml` | | `LandingPage_Summary__Services` | `LandingPage-Services.Summary.cshtml` | ### `[ContentType]_[DisplayType]__[PartType]__[ShapeType]` @@ -212,9 +212,9 @@ This template is called when a shape type is rendered in a given content part ty #### Content with Part Type and Shape Examples -| Template | Filename| -| --------- | ------------ | -| `Blog__ListPart__ListPartFeed` | `Blog-ListPart-ListPartFeed.cshtml` | +| Template | Filename | +|----------------------------------------|---------------------------------------------| +| `Blog__ListPart__ListPartFeed` | `Blog-ListPart-ListPartFeed.cshtml` | | `Blog_Summary__ListPart__ListPartFeed` | `Blog-ListPart-ListPartFeed.Summary.cshtml` | ### `[ContentType]_[DisplayType]__[PartName]__[ShapeType]` @@ -223,9 +223,9 @@ This template is called when a shape type is rendered in a given content part na #### Content with Part Name and Custom Shape Examples -| Template | Filename| -| --------- | ------------ | -| `LandingPage__Services__CustomShape` | `LandingPage-Services-CustomShape.cshtml` | +| Template | Filename | +|----------------------------------------------|---------------------------------------------------| +| `LandingPage__Services__CustomShape` | `LandingPage-Services-CustomShape.cshtml` | | `LandingPage_Summary__Services__CustomShape` | `LandingPage-Services-CustomShape.Summary.cshtml` | ### Content Parts Display Mode @@ -238,8 +238,8 @@ This template is called when a content part is rendered for a given content part #### Display mode with Shape type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|-----------------------------------------|-----------------------------------------------| | `TitlePart_Summary__CustomMode_Display` | `TitlePart-CustomMode.Display.Summary.cshtml` | ### `[ContentType]_Display__[PartType]__[DisplayMode]` @@ -248,8 +248,8 @@ This template is called when a content part is rendered for a given content type #### Display mode with Part type without Display type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|----------------------------------------------|---------------------------------------------------| | `LandingPage_Display__TitlePart__CustomMode` | `LandingPage-TitlePart-CustomMode.Display.cshtml` | ### `[ContentType]_[DisplayType]__[PartType]__[DisplayMode]_Display` @@ -258,8 +258,8 @@ This template is called when a content part is rendered for a given content type #### Display mode with Part type with Display type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|------------------------------------------------------|-----------------------------------------------------------| | `LandingPage_Summary__TitlePart__CustomMode_Display` | `LandingPage-TitlePart-CustomMode.Display.Summary.cshtml` | ### `[ContentType]_Display__[PartName]__[DisplayMode]` @@ -268,8 +268,8 @@ This template is called when a content part name is rendered for a given content #### Display mode with Part name without Display type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|---------------------------------------------|--------------------------------------------------| | `LandingPage_Display__Services__CustomMode` | `LandingPage-Services-CustomMode.Display.cshtml` | ### `[ContentType]_[DisplayType]__[PartName]__[DisplayMode]_Display` @@ -278,8 +278,8 @@ This template is called when a content part name is rendered for a given content #### Display mode with Part name with Display type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|-----------------------------------------------------|----------------------------------------------------------| | `LandingPage_Summary__Services__CustomMode_Display` | `LandingPage-Services-CustomMode.Display.Summary.cshtml` | ### `[ContentType]_Display__[PartType]__[ShapeType]__[DisplayMode]` @@ -288,8 +288,8 @@ This template is called when a shape type is rendered in a given content part ty #### Display mode with Part Type and Shape without Display type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|----------------------------------------------------|--------------------------------------------------------| | `Blog_Display__ListPart__ListPartFeed__CustomMode` | `Blog-ListPart-ListPartFeed-CustomMode.Display.cshtml` | ### `[ContentType]_[DisplayType]__[PartType]__[ShapeType]__[DisplayMode]_Display` @@ -298,8 +298,8 @@ This template is called when a shape type is rendered in a given content part ty #### Display mode with Part Type and Shape with Display type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|------------------------------------------------------------|----------------------------------------------------------------| | `Blog_Summary__ListPart__ListPartFeed__CustomMode_Display` | `Blog-ListPart-ListPartFeed-CustomMode.Display.Summary.cshtml` | ### `[ContentType]_Display__[PartName]__[ShapeType]__[DisplayMode]` @@ -308,8 +308,8 @@ This template is called when a shape type is rendered in a given content part na #### Display mode with Part Name and Custom Shape without Display type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|----------------------------------------------------|--------------------------------------------------------| | `Blog_Display__Services__ListPartFeed__CustomMode` | `Blog-Services-ListPartFeed-CustomMode.Display.cshtml` | ### `[ContentType]_[DisplayType]__[PartName]__[ShapeType]__[DisplayMode]_Display` @@ -318,8 +318,8 @@ This template is called when a shape type is rendered in a given content part na #### Display mode with Part Name and Custom Shape with Display type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|------------------------------------------------------------|----------------------------------------------------------------| | `Blog_Summary__Services__ListPartFeed__CustomMode_Display` | `Blog-Services-ListPartFeed-CustomMode.Display.Summary.cshtml` | ### Widget parts / Stereotype parts @@ -332,10 +332,10 @@ This template is called when a content part is rendered for a given stereo type, #### Stereotype with Part Name Examples -| Template | Filename| -| --------- | ------------ | -| `Widget__HtmlBodyPart` | `Widget-HtmlBodyPart.cshtml` | -| `Widget_Summary__HtmlBodyPart` | `Widget-HtmlBodyPart.Summary.cshtml` +| Template | Filename | +|--------------------------------|--------------------------------------| +| `Widget__HtmlBodyPart` | `Widget-HtmlBodyPart.cshtml` | +| `Widget_Summary__HtmlBodyPart` | `Widget-HtmlBodyPart.Summary.cshtml` | ### `[Stereotype]_[DisplayType]__[PartType]__[PartName]` @@ -343,9 +343,9 @@ This template is called when a content part is a re-usable named part and render #### Stereotype with Part Type Examples -| Template | Filename| -| --------- | ------------ | -| `Widget__ServicePart__Services` | `Widget-ServicePart-Services.cshtml` | +| Template | Filename | +|-----------------------------------------|----------------------------------------------| +| `Widget__ServicePart__Services` | `Widget-ServicePart-Services.cshtml` | | `Widget_Summary__ServicePart__Services` | `Widget-ServicePart-Services.Summary.cshtml` | ### `[Stereotype]_[DisplayType]__[PartType]__[ShapeType]` @@ -354,9 +354,9 @@ This template is called when a custom shape type is rendered for a given stereo #### Stereotype with Part Name and Shape Examples -| Template | Filename| -| --------- | ------------ | -| `Widget__ListPart__ListPartFeed` | `Widget-ListPart-ListPartFeed.cshtml` | +| Template | Filename | +|------------------------------------------|-----------------------------------------------| +| `Widget__ListPart__ListPartFeed` | `Widget-ListPart-ListPartFeed.cshtml` | | `Widget_Summary__ListPart__ListPartFeed` | `Widget-ListPart-ListPartFeed.Summary.cshtml` | ### `[Stereotype]_[DisplayType]__[PartType]__[PartName]__[ShapeType]` @@ -365,9 +365,9 @@ This template is called for re-usable named content part with custom shape type #### Stereotype with Part Name and Custom Shape Examples -| Template | Filename| -| --------- | ------------ | -| `Widget__ServicePart__Services__CustomShape` | `Widget-ServicePart-Services-CustomShape.cshtml` | +| Template | Filename | +|------------------------------------------------------|----------------------------------------------------------| +| `Widget__ServicePart__Services__CustomShape` | `Widget-ServicePart-Services-CustomShape.cshtml` | | `Widget_Summary__ServicePart__Services__CustomShape` | `Widget-ServicePart-Services-CustomShape.Summary.cshtml` | Following alternates are available to Content parts that supports different display modes and are attached to content type of stereotype. @@ -378,8 +378,8 @@ This template is called when a content part is rendered for a given stereo type, #### Display mode with Part type without Display type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|-----------------------------------------|----------------------------------------------| | `Widget_Display__TitlePart__CustomMode` | `Widget-TitlePart-CustomMode.Display.cshtml` | ### `[Stereotype]_[DisplayType]__[PartType]__[DisplayMode]_Display` @@ -388,8 +388,8 @@ This template is called when a content part is rendered for a given stereo type, #### Display mode with Stereotype with Display type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|-------------------------------------------------|------------------------------------------------------| | `Widget_Summary__TitlePart__CustomMode_Display` | `Widget-TitlePart-CustomMode.Display.Summary.cshtml` | ### `[Stereotype]_Display__[PartType]__[PartName]__[DisplayMode]` @@ -398,8 +398,8 @@ This template is called when a content part name is rendered for a given stereot #### Display mode with Part name without Display type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|-----------------------------------------------------|---------------------------------------------------------| | `Widget_Display__ServicePart__Services__CustomMode` | `Widget-ServicePart-Services-CustomMode.Display.cshtml` | ### `[Stereotype]_[DisplayType]__[PartType]__[PartName]__[DisplayMode]_Display` @@ -408,8 +408,8 @@ This template is called when a content part name is rendered for a given stereot #### Display mode with Part name with Display type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|-------------------------------------------------------------|-----------------------------------------------------------------| | `Widget_Summary__ServicePart__Services__CustomMode_Display` | `Widget-ServicePart-Services-CustomMode.Display.Summary.cshtml` | ### `[Stereotype]_Display__[PartType]__[ShapeType]__[DisplayMode]` @@ -418,8 +418,8 @@ This template is called when a shape type is rendered in a given content part ty #### Display mode with Part Type and Shape without Display type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|------------------------------------------------------|----------------------------------------------------------| | `Widget_Display__ListPart__ListPartFeed__CustomMode` | `Widget-ListPart-ListPartFeed-CustomMode.Display.cshtml` | ### `[Stereotype]_[DisplayType]__[PartType]__[ShapeType]__[DisplayMode]_Display` @@ -428,8 +428,8 @@ This template is called when a shape type is rendered in a given content part ty #### Display mode with Part Type and Shape with Display type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|--------------------------------------------------------------|------------------------------------------------------------------| | `Widget_Summary__ListPart__ListPartFeed__CustomMode_Display` | `Widget-ListPart-ListPartFeed-CustomMode.Display.Summary.cshtml` | ### `[Stereotype]_Display__[PartType]__[PartName]__[ShapeType]__[DisplayMode]` @@ -438,8 +438,8 @@ This template is called when a shape type is rendered in a given content part na #### Display mode with Part Name and Custom Shape without Display type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|----------------------------------------------------------------|-------------------------------------------------------------------| | `Widget_Display__ListPart__Services__ListPartFeed__CustomMode` | `Widget-ListPart-Services-ListPartFeed-CustomMode.Display.cshtml` | ### `[Stereotype]_[DisplayType]__[PartType]__[PartName]__[ShapeType]__[DisplayMode]_Display` @@ -448,8 +448,8 @@ This template is called when a shape type is rendered in a given content part na #### Display mode with Part Name and Custom Shape with Display type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|------------------------------------------------------------------------|---------------------------------------------------------------------------| | `Widget_Summary__ListPart__Services__ListPartFeed__CustomMode_Display` | `Widget-ListPart-Services-ListPartFeed-CustomMode.Display.Summary.cshtml` | ## Content Field templates @@ -470,8 +470,8 @@ This template is called when a content field type is rendered in a given display #### Field And Display Type Examples -| Template | Filename| -| --------- | ------------ | +| Template | Filename | +|---------------------|----------------------------| | `TextField_Summary` | `TextField.Summary.cshtml` | ### `[PartType]__[FieldName]` @@ -480,10 +480,10 @@ This template is called when a content field name is rendered for a given conten #### Part Type and Field Examples -| Template | Filename| -| --------- | ------------ | -| `HtmlBodyPart__Description` | `HtmlBodyPart-Description.cshtml` | -| `HtmlBodyPart_Summary__Description` | `HtmlBodyPart-Description.Summary.cshtml` | +| Template | Filename | +|-------------------------------------|-------------------------------------------| +| `HtmlBodyPart__Description` | `HtmlBodyPart-Description.cshtml` | +| `HtmlBodyPart_Summary__Description` | `HtmlBodyPart-Description.Summary.cshtml` | ### `[ContentType]__[PartName]__[FieldName]` @@ -491,12 +491,12 @@ This template is called when a content field name is rendered for a given conten #### Content Type, Part Name and Field Name Examples -| Template | Filename| -| --------- | ------------ | -| `Blog__HtmlBodyPart__Description` | `Blog-HtmlBodyPart-Description.cshtml` | -| `LandingPage__Services__Image` | `LandingPage-Services-Image.cshtml` | +| Template | Filename | +|-------------------------------------------|------------------------------------------------| +| `Blog__HtmlBodyPart__Description` | `Blog-HtmlBodyPart-Description.cshtml` | +| `LandingPage__Services__Image` | `LandingPage-Services-Image.cshtml` | | `Blog_Summary__HtmlBodyPart__Description` | `Blog-HtmlBodyPart-Description.Summary.cshtml` | -| `LandingPage_Summary__Services__Image` | `LandingPage-Services-Image.Summary.cshtml` | +| `LandingPage_Summary__Services__Image` | `LandingPage-Services-Image.Summary.cshtml` | ### `[ContentType]__[FieldType]` @@ -504,9 +504,9 @@ This template is called when a content field type is rendered for a given conten #### Content Type and Field Type Examples -| Template | Filename| -| --------- | ------------ | -| `Blog__TextField` | `Blog-TextField.cshtml` | +| Template | Filename | +|--------------------------|--------------------------------| +| `Blog__TextField` | `Blog-TextField.cshtml` | | `LandingPage__TextField` | `LandingPage-TextField.cshtml` | ### `[FieldType]__[ShapeType]` @@ -515,9 +515,9 @@ This template is called when a content field shape type is rendered for a given #### Field Type and Shape Type Examples -| Template | Filename| -| --------- | ------------ | -| `CustomField__CustomFieldSummary` | `CustomField-CustomFieldSummary.cshtml` | +| Template | Filename | +|-------------------------------------------|-------------------------------------------------| +| `CustomField__CustomFieldSummary` | `CustomField-CustomFieldSummary.cshtml` | | `CustomField_Summary__CustomFieldSummary` | `CustomField-CustomFieldSummary.Summary.cshtml` | ### `[PartType]__[FieldName]__[ShapeType]` @@ -526,10 +526,10 @@ This template is called when a content field shape type is rendered for a given #### Part Type, Field Name and Shape Type Examples -| Template | Filename| -| --------- | ------------ | -| `HtmlBodyPart__Description__CustomFieldSummary`| `HtmlBodyPart__Description__CustomFieldSummary.cshtml` | -| `HtmlBodyPart_Summary__Description__CustomFieldSummary`| `HtmlBodyPart__Description__CustomFieldSummary.Summary.cshtml` | +| Template | Filename | +|---------------------------------------------------------|----------------------------------------------------------------| +| `HtmlBodyPart__Description__CustomFieldSummary` | `HtmlBodyPart__Description__CustomFieldSummary.cshtml` | +| `HtmlBodyPart_Summary__Description__CustomFieldSummary` | `HtmlBodyPart__Description__CustomFieldSummary.Summary.cshtml` | ### `[ContentType]__[PartName]__[FieldName]__[ShapeType]` @@ -537,11 +537,11 @@ This template is called when a content field shape type is rendered for a given #### Content Type, Part Name, Field Name and Shape Type Examples -| Template | Filename| -| --------- | ------------ | -| `Blog__HtmlBodyPart__Description__CustomFieldSummary` | `Blog-HtmlBodyPart-Description-CustomFieldSummary.cshtml` | -| `LandingPage__Services__Description__CustomFieldSummary` | `LandingPage-Services-Description-CustomFieldSummary.cshtml` | -| `Blog_Summary__HtmlBodyPart__Description__CustomFieldSummary` | `Blog-HtmlBodyPart-Description-CustomFieldSummary.Summary.cshtml` | +| Template | Filename | +|------------------------------------------------------------------|----------------------------------------------------------------------| +| `Blog__HtmlBodyPart__Description__CustomFieldSummary` | `Blog-HtmlBodyPart-Description-CustomFieldSummary.cshtml` | +| `LandingPage__Services__Description__CustomFieldSummary` | `LandingPage-Services-Description-CustomFieldSummary.cshtml` | +| `Blog_Summary__HtmlBodyPart__Description__CustomFieldSummary` | `Blog-HtmlBodyPart-Description-CustomFieldSummary.Summary.cshtml` | | `LandingPage_Summary__Services__Description__CustomFieldSummary` | `LandingPage-Services-Description-CustomFieldSummary.Summary.cshtml` | ### `[ContentType]__[FieldType]__[ShapeType]` @@ -550,9 +550,9 @@ This template is called when a content field shape type is rendered for a given #### Content Type, Field Type and Shape Type Examples -| Template | Filename| -| --------- | ------------ | -| `Blog__TextField__TextFieldSummary` | `Blog-TextField-TextFieldSummary.cshtml` | +| Template | Filename | +|--------------------------------------------|-------------------------------------------------| +| `Blog__TextField__TextFieldSummary` | `Blog-TextField-TextFieldSummary.cshtml` | | `LandingPage__TextField__TextFieldSummary` | `LandingPage-TextField-TextFieldSummary.cshtml` | ## Shape differentiators @@ -625,9 +625,9 @@ This template is called when displaying a Layout zone. #### Zone Examples -| Template | Filename| -| --------- | ------------ | -| `Zone__Footer` | `Zone-Footer.cshtml` | +| Template | Filename | +|-----------------|-----------------------| +| `Zone__Footer` | `Zone-Footer.cshtml` | | `Zone__Content` | `Zone-Content.cshtml` | Which zones are available depends on the current theme. @@ -637,11 +637,11 @@ Which zones are available depends on the current theme. #### Zone Available properties -| Property | Description | -| --------- | ------------ | -| `Model.Items` | While the property is not unique to zone shapes keep in mind that `Model.Items` contains the child shapes that should be displayed from the zone. In Razor but not in Liquid iterating over `Model` directly yields the child shapes too. | -| `Model.Parent` | A zone shape that's the parent of the current zone. For root-level zones this will be the Layout shape. | -| `Model.ZoneName` | The `string` name of the zone, e.g. "Footer" and "Content". | +| Property | Description | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `Model.Items` | While the property is not unique to zone shapes keep in mind that `Model.Items` contains the child shapes that should be displayed from the zone. In Razor but not in Liquid iterating over `Model` directly yields the child shapes too. | +| `Model.Parent` | A zone shape that's the parent of the current zone. For root-level zones this will be the Layout shape. | +| `Model.ZoneName` | The `string` name of the zone, e.g. "Footer" and "Content". | === "Liquid" diff --git a/src/docs/reference/modules/Title/README.md b/src/docs/reference/modules/Title/README.md index dfcca798920..b16a248d280 100644 --- a/src/docs/reference/modules/Title/README.md +++ b/src/docs/reference/modules/Title/README.md @@ -23,7 +23,7 @@ The Pattern has access to the current ContentItem and is executed on ContentItem The following shapes are rendered when the **Title Part** is attached to a content type. | Name | Display Type | Default Location | Model Type | -| ----------- | ------------ | ---------------- | -------------------- | +|-------------|--------------|------------------|----------------------| | `TitlePart` | `Detail` | `Header:5` | `TitlePartViewModel` | | `TitlePart` | `Summary` | `Header:10` | `TitlePartViewModel` | @@ -32,6 +32,6 @@ The following shapes are rendered when the **Title Part** is attached to a conte The following properties are available in the `TitlePartViewModel` class. | Name | Type | Description | -| ----------- | ----------- | ------------------------------- | +|-------------|-------------|---------------------------------| | `Title` | `string` | The title property of the part. | | `TitlePart` | `TitlePart` | The `TitlePart` instance. | diff --git a/src/docs/reference/modules/UrlRewriting/README.md b/src/docs/reference/modules/UrlRewriting/README.md index 02562a3f1a4..685deec57ed 100644 --- a/src/docs/reference/modules/UrlRewriting/README.md +++ b/src/docs/reference/modules/UrlRewriting/README.md @@ -6,9 +6,9 @@ Once enabled, you can manage your rewrite rules by navigating to **Configuration ## Available Rule Sources -| Rule Type | Description | Example | -|---------------|---------------|---------------| -| **Redirect Rule** | The **Redirect Rule** is utilized to send users from one URL to another, which is particularly beneficial for maintaining SEO integrity when URLs change. | Permanently redirect users from `/about-us` to `/about`. | +| Rule Type | Description | Example | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------| +| **Redirect Rule** | The **Redirect Rule** is utilized to send users from one URL to another, which is particularly beneficial for maintaining SEO integrity when URLs change. | Permanently redirect users from `/about-us` to `/about`. | | **Rewrite Rule** | The **Rewrite Rule** allows you to modify the incoming request URL without changing the URL displayed in the browser's address bar, aiding in content organization. | Change requests for media files from `/img/` to `/media/`. | ## Creating Additional Rule Sources diff --git a/src/docs/reference/modules/Widgets/README.md b/src/docs/reference/modules/Widgets/README.md index d582976cf46..6a1d9c33212 100644 --- a/src/docs/reference/modules/Widgets/README.md +++ b/src/docs/reference/modules/Widgets/README.md @@ -21,18 +21,18 @@ for Widgets will treat this content item accordingly. This is how the `Layers` m Because `Widget` is a stereotype, all Widget content items are rendered from a main shape named `Widget`. This main shape's template has access to these properties: -| Property | Description | -| --------- | ------------ | -| `Model.ContentItem` | The Widget content item. | -| `Model.Content` | A list of inner shapes to display. It's populated by all the fields and parts the widget is composed of. | +| Property | Description | +|---------------------|----------------------------------------------------------------------------------------------------------| +| `Model.ContentItem` | The Widget content item. | +| `Model.Content` | A list of inner shapes to display. It's populated by all the fields and parts the widget is composed of. | It also contains these specific zones, which are not used most of the time and can be ignored when creating custom templates for the website front-end. -| Property | Description | -| --------- | ------------ | -| `Model.Header` | The shapes to render in the widget's header. | -| `Model.Meta` | The shapes to render in the widget's metadata zone. | -| `Model.Footer` | The shapes to render in the widget's footer. | +| Property | Description | +|----------------|-----------------------------------------------------| +| `Model.Header` | The shapes to render in the widget's header. | +| `Model.Meta` | The shapes to render in the widget's metadata zone. | +| `Model.Footer` | The shapes to render in the widget's footer. | The shape also contains all the properties common to all shapes like `Classes`, `Id` and `Attributes`. @@ -80,8 +80,8 @@ The actual template for the `Widget` shape can be found in `src/OrchardCore.Modu Alternates are available per Content Type. -| Definition | Template | Filename| -| ---------- | --------- | ------------ | +| Definition | Template | Filename | +|-------------------------|---------------------|---------------------------| | `Widget__[ContentType]` | `Widget__Paragraph` | `Widget-Paragraph.cshtml` | ### Customizing the `Widget_Wrapper` template @@ -106,9 +106,9 @@ A common requirement is to remove these tags, which can be done by creating this Optionally, you can change these alternates: -| Definition | Template | Filename| -| ---------- | --------- | ------------ | -| `Widget_Wrapper__[ContentType]` | `Widget_Wrapper__Paragraph` | `Widget-Paragraph.Wrapper.cshtml` | +| Definition | Template | Filename | +|---------------------------------------|--------------------------------|-------------------------------------| +| `Widget_Wrapper__[ContentType]` | `Widget_Wrapper__Paragraph` | `Widget-Paragraph.Wrapper.cshtml` | | `Widget_Wrapper__Zone__[ContentZone]` | `Widget_Wrapper__Zone__Footer` | `Widget-Zone-Footer.Wrapper.cshtml` | ## Videos diff --git a/src/docs/reference/modules/Workflows/README.md b/src/docs/reference/modules/Workflows/README.md index 0394ff87f79..e6baae2ce30 100644 --- a/src/docs/reference/modules/Workflows/README.md +++ b/src/docs/reference/modules/Workflows/README.md @@ -147,46 +147,46 @@ These type of fields allow you to enter Liquid markup, enabling access to system The following JavaScript functions are available by default to any activity that supports script expressions: -| Function | Description | Signature | -| -------- | ----------- | --------- | -| `workflow` | Returns the `WorkflowExecutionContext` which provides access to all information related to the current workflow execution context. | `workflow(): WorkflowExecutionContext` | -| `workflowId` | Returns the unique workflow ID. | `workflowId(): String` | -| `input` | Returns the input parameter with the specified name. Input to the workflow is provided when the workflow is executed by the workflow manager. | `input(name: string): any` | -| `output` | Sets an output parameter with the specified name. Workflow output can be collected by the invoker of the workflow. | `output(name: string, value: any): void` | -| `property` | Returns the property value with the specified name. Properties are a dictionary that workflow activities can read and write information from and to. | `property(name: string): any` | -| `setProperty` | Stores the specified data in workflow properties. | `setProperty(name: string,data:any):void` | -| `executeQuery` | Returns the result of the query, see [more](../Queries/README.md#scripting). | `executeQuery(name: String, parameters: Dictionary): IEnumerable` | -| `log` | Output logs according to the specified log level. Allowed log levels : `'Trace','Debug','Information','Warning','Error','Critical','None'` | `log(level: string, text: string, param: object): void` | -| `lastResult` | Returns the value that the previous activity provided, if any. | `lastResult(): any` | -| `correlationId` | Returns the correlation value of the workflow instance. | `correlationId(): string` | -| `setCorrelationId` | Set the correlation value of the workflow instance. | `setCorrelationId(id:string): void` | -| `signalUrl` | Returns workflow trigger URL with a protected SAS token into which the specified signal name is encoded. Use this to generate URLs that can be shared with trusted parties to trigger the current workflow if it is blocked on the Signal activity that is configured with the same signal name. | `signalUrl(signal: string): string` | +| Function | Description | Signature | +|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------| +| `workflow` | Returns the `WorkflowExecutionContext` which provides access to all information related to the current workflow execution context. | `workflow(): WorkflowExecutionContext` | +| `workflowId` | Returns the unique workflow ID. | `workflowId(): String` | +| `input` | Returns the input parameter with the specified name. Input to the workflow is provided when the workflow is executed by the workflow manager. | `input(name: string): any` | +| `output` | Sets an output parameter with the specified name. Workflow output can be collected by the invoker of the workflow. | `output(name: string, value: any): void` | +| `property` | Returns the property value with the specified name. Properties are a dictionary that workflow activities can read and write information from and to. | `property(name: string): any` | +| `setProperty` | Stores the specified data in workflow properties. | `setProperty(name: string,data:any):void` | +| `executeQuery` | Returns the result of the query, see [more](../Queries/README.md#scripting). | `executeQuery(name: String, parameters: Dictionary): IEnumerable` | +| `log` | Output logs according to the specified log level. Allowed log levels : `'Trace','Debug','Information','Warning','Error','Critical','None'` | `log(level: string, text: string, param: object): void` | +| `lastResult` | Returns the value that the previous activity provided, if any. | `lastResult(): any` | +| `correlationId` | Returns the correlation value of the workflow instance. | `correlationId(): string` | +| `setCorrelationId` | Set the correlation value of the workflow instance. | `setCorrelationId(id:string): void` | +| `signalUrl` | Returns workflow trigger URL with a protected SAS token into which the specified signal name is encoded. Use this to generate URLs that can be shared with trusted parties to trigger the current workflow if it is blocked on the Signal activity that is configured with the same signal name. | `signalUrl(signal: string): string` | #### JavaScript Functions in HTTP activities The following JavaScript functions are available by default to any HTTP activity that supports script expressions: -| Function | Description | Signature | -| -------- | ----------- | --------- | -| `httpContext` | Returns the `HttpContext` which encapsulates all HTTP-specific information about an individual HTTP request. | `httpContext(): HttpContext` | -| `queryString` | Returns the entire query string (including the leading `?`) when invoked with no arguments, or the value(s) of the parameter name passed in as an argument. | `queryString(): String`
`queryString(name: String): String` or `Array` | -| `responseWrite` | Writes the argument string directly to the HTTP response stream. | `responseWrite(text: String): void` | -| `absoluteUrl` | Returns the absolute URL for the relative path argument. | `absoluteUrl(relativePath: String): String` | -| `readBody` | Returns the raw HTTP request body. | `readBody(): String` | -| `requestForm` | Returns the value(s) of the form field name passed in as an argument. | `requestForm(): String`
`requestForm(name: String): String` or `Array` | +| Function | Description | Signature | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| `httpContext` | Returns the `HttpContext` which encapsulates all HTTP-specific information about an individual HTTP request. | `httpContext(): HttpContext` | +| `queryString` | Returns the entire query string (including the leading `?`) when invoked with no arguments, or the value(s) of the parameter name passed in as an argument. | `queryString(): String`
`queryString(name: String): String` or `Array` | +| `responseWrite` | Writes the argument string directly to the HTTP response stream. | `responseWrite(text: String): void` | +| `absoluteUrl` | Returns the absolute URL for the relative path argument. | `absoluteUrl(relativePath: String): String` | +| `readBody` | Returns the raw HTTP request body. | `readBody(): String` | +| `requestForm` | Returns the value(s) of the form field name passed in as an argument. | `requestForm(): String`
`requestForm(name: String): String` or `Array` | | `deserializeRequestData` | Deserializes the request data automatically for requests that send JSON or form data. Returns the entire request data as a JSON object. Replaces deprecated queryStringAsJson and requestFormAsJson methods | `deserializeRequestData(): { "field1": [ "field1-value1", "field1-value2" ], "field2": [ "field2-value1", "field2-value2" ], ... }` | ### Liquid Expressions The following Liquid tags, properties and filters are available by default to any activity that supports Liquid expressions: -| Expression | Type | Description | Example | -| ---------- | ---- | ----------- | ------- | -| `Workflow.CorrelationId` | Property | Returns the correlation value of the workflow instance. | `{{ Workflow.CorrelationId }}` | -| `Workflow.Input` | Property | Returns the Input dictionary. | `{{ Workflow.Input["ContentItem"] }}` | -| `Workflow.Output` | Property | Returns the Output dictionary. | `{{ Workflow.Output["SomeResult"] }}` | -| `Workflow.Properties` | Property | Returns the Properties dictionary. | `{{ Workflow.Properties["Foo"] }}` | -| `signal_url` | Filter | Returns the workflow trigger URL. You can use the `input("Signal")` JavaScript method to check which signal is triggered. | `{{ 'Approved' \| signal_url }}` | +| Expression | Type | Description | Example | +|--------------------------|----------|---------------------------------------------------------------------------------------------------------------------------|---------------------------------------| +| `Workflow.CorrelationId` | Property | Returns the correlation value of the workflow instance. | `{{ Workflow.CorrelationId }}` | +| `Workflow.Input` | Property | Returns the Input dictionary. | `{{ Workflow.Input["ContentItem"] }}` | +| `Workflow.Output` | Property | Returns the Output dictionary. | `{{ Workflow.Output["SomeResult"] }}` | +| `Workflow.Properties` | Property | Returns the Properties dictionary. | `{{ Workflow.Properties["Foo"] }}` | +| `signal_url` | Filter | Returns the workflow trigger URL. You can use the `input("Signal")` JavaScript method to check which signal is triggered. | `{{ 'Approved' \| signal_url }}` | Instead of using the indexer syntax on the three workflow dictionaries `Input`, `Output` and `Properties`, you can also use dot notation, e.g.: @@ -211,42 +211,42 @@ For more examples of supported content item filters, see the documentation on [L The following activities are available with any default Orchard installation: -| Activity | Type | Description | -| -------- | ---- | ----------- | -| **Workflows** | * | * | -| Correlate | Task | Correlate the current workflow instance with a value. | -| For Each | Task | Iterate over a list. | -| Fork | Task | Fork workflow execution into separate paths of execution. | -| For Loop | Task | Iterates for N times. | -| If / Else | Task | Evaluate a boolean condition and continues execution based on the outcome. | -| Join | Task | Join a forked workflow execution back into a single path of execution. | -| Log | Task | Write a log entry. | -| Notify | Task | Display a notification. | -| Script | Task | Execute script and continue execution based on the returned outcome. | -| Set Output | Task | Evaluate a script expression and store the result into the workflow's output. | -| Set Property | Task | Execute script and continue execution based on the returned outcome. | -| While Loop | Task | Iterate while a condition is true. | -| **HTTP Workflow Activities** | * | * | * | -| HTTP Redirect | Task | Redirect the user agent to the specified URL (301/302). | -| HTTP Request | Task | Perform a HTTP request to a given URL. | -| Filter Incoming HTTP Request | Event | Executes when the specified HTTP request comes in. Similar to an MVC Action Filter. | -| Signal | Event | Executes when a signal is triggered. | -| **Email** | * | * | * | -| Send Email | Task | Send an email. | -| **Timer Workflow Activities** | * | * | * | -| Timer | Event | Executes repeatedly according to a specified CRON expression. | -| **Contents** | * | * | * | -| Content Created | Event | Executes when content is created. | -| Content Deleted | Event | Executes when content is deleted. | -| Content Published | Event | Executes when content is published. | -| Content Unpublished | Event | Executes when content is unpublished. | -| Content Updated | Event | Executes when content is updated. | -| Content Versioned| Event | Executes when content is versioned. | -| Create Content | Task | Create a content item. | -| Delete Content | Task | Delete a content item. | -| Publish Content | Task | Publish a content item. | -**User** | * | * | * | -| ValidateUser | Task | Used to check if the user is logged in and has the specified role(s). | +| Activity | Type | Description | +|-------------------------------|-------|-------------------------------------------------------------------------------------| +| **Workflows** | * | * | +| Correlate | Task | Correlate the current workflow instance with a value. | +| For Each | Task | Iterate over a list. | +| Fork | Task | Fork workflow execution into separate paths of execution. | +| For Loop | Task | Iterates for N times. | +| If / Else | Task | Evaluate a boolean condition and continues execution based on the outcome. | +| Join | Task | Join a forked workflow execution back into a single path of execution. | +| Log | Task | Write a log entry. | +| Notify | Task | Display a notification. | +| Script | Task | Execute script and continue execution based on the returned outcome. | +| Set Output | Task | Evaluate a script expression and store the result into the workflow's output. | +| Set Property | Task | Execute script and continue execution based on the returned outcome. | +| While Loop | Task | Iterate while a condition is true. | +| **HTTP Workflow Activities** | * | * | * | +| HTTP Redirect | Task | Redirect the user agent to the specified URL (301/302). | +| HTTP Request | Task | Perform a HTTP request to a given URL. | +| Filter Incoming HTTP Request | Event | Executes when the specified HTTP request comes in. Similar to an MVC Action Filter. | +| Signal | Event | Executes when a signal is triggered. | +| **Email** | * | * | * | +| Send Email | Task | Send an email. | +| **Timer Workflow Activities** | * | * | * | +| Timer | Event | Executes repeatedly according to a specified CRON expression. | +| **Contents** | * | * | * | +| Content Created | Event | Executes when content is created. | +| Content Deleted | Event | Executes when content is deleted. | +| Content Published | Event | Executes when content is published. | +| Content Unpublished | Event | Executes when content is unpublished. | +| Content Updated | Event | Executes when content is updated. | +| Content Versioned | Event | Executes when content is versioned. | +| Create Content | Task | Create a content item. | +| Delete Content | Task | Delete a content item. | +| Publish Content | Task | Publish a content item. | +| **User** | * | * | * | +| ValidateUser | Task | Used to check if the user is logged in and has the specified role(s). | ## Developing Custom Activities diff --git a/src/docs/releases/1.5.0.md b/src/docs/releases/1.5.0.md index c0432e221ee..a378d892e5d 100644 --- a/src/docs/releases/1.5.0.md +++ b/src/docs/releases/1.5.0.md @@ -44,10 +44,10 @@ The module was renamed from `OrchardCore.Lucene` to `OrchardCore.Search.Lucene`. ### IndexingConstants changes -| Constant | Before | after | -|----------|--------|-------| -| DisplayTextKey | Content.ContentItem.DisplayText | Content.ContentItem.DisplayText.keyword | -| ContainedPartKey + IdsKey (new) | Content.ContentItem.ContainedPart.ListContentItemId | Content.ContentItem.ContainedPart.Ids | +| Constant | Before | after | +|---------------------------------|-----------------------------------------------------|-----------------------------------------| +| DisplayTextKey | Content.ContentItem.DisplayText | Content.ContentItem.DisplayText.keyword | +| ContainedPartKey + IdsKey (new) | Content.ContentItem.ContainedPart.ListContentItemId | Content.ContentItem.ContainedPart.Ids | ### Taxonomies module indexing @@ -63,11 +63,11 @@ ManageIndexes will be now ManageLuceneIndexes ### Lucene indexation -| Before | After | Action | -|--------|--------|--------| -| Indexed | Indexed | Indexed meant "Keyword" in Lucene so we migrated these to "Keyword" in the content index settings. -| Analyzed | Keyword | The Analyzed option is removed. Everything that was set as analyzed doesn't need migration because it is now the default. | -| Stored | Stored | Nothing to do. Should work as before | +| Before | After | Action | +|----------|---------|---------------------------------------------------------------------------------------------------------------------------| +| Indexed | Indexed | Indexed meant "Keyword" in Lucene so we migrated these to "Keyword" in the content index settings. | +| Analyzed | Keyword | The Analyzed option is removed. Everything that was set as analyzed doesn't need migration because it is now the default. | +| Stored | Stored | Nothing to do. Should work as before | ## YesSQL breaking changes diff --git a/src/docs/releases/1.6.0.md b/src/docs/releases/1.6.0.md index 2739ab71daf..355ef7fab78 100644 --- a/src/docs/releases/1.6.0.md +++ b/src/docs/releases/1.6.0.md @@ -14,20 +14,20 @@ In previous versions, the `View Users` permission was enough to show the `Users` Here is a list of the new permissions: -| Permission | Description | -| --- | --- | -| `ListUsers` | allows listing all users. | -| `EditUsers` | allow editing any user. | +| Permission | Description | +|---------------|---------------------------| +| `ListUsers` | allows listing all users. | +| `EditUsers` | allow editing any user. | | `DeleteUsers` | allows deleting any user. | The following permissions will be available if the `OrchardCore.Roles` feature is enabled: -| Permission | Description | -| --- | --- | -| `AssignRoleToUsers` | allows assigning any role to users. | -| `ListUsersInRole_{0}` | allows listing users in a given role. | -| `EditUsersInRole_{0}` | allows editing users in a given role. | -| `DeleteUsersInRole_{0}` | allows deleting users in a given role. | +| Permission | Description | +|-------------------------|-----------------------------------------| +| `AssignRoleToUsers` | allows assigning any role to users. | +| `ListUsersInRole_{0}` | allows listing users in a given role. | +| `EditUsersInRole_{0}` | allows editing users in a given role. | +| `DeleteUsersInRole_{0}` | allows deleting users in a given role. | | `AssignRoleToUsers_{0}` | allows assigning users to a given role. | ### `OrchardCore.Roles` Module @@ -144,16 +144,16 @@ to the following: Here is a list of all added helpers: -| Helper | Description | -| --- | --- | -| `Orchard.GetWrapperCssClasses()` | gets the css classes for the wrapper element. | -| `Orchard.GetLabelCssClasses()` | gets the css classes for a label element. | -| `Orchard.GetStartCssClasses()` | gets the css classes for a starting section. For example, if you want to push your elements to the end to line it up with a label. | -| `Orchard.GetEndCssClasses()` | gets the css classes for the ending section. | -| `Orchard.GetEndCssClasses(bool withOffset)` | gets the css classes for the ending section with optionally an offset. | -| `Orchard.GetOffsetCssClasses()` | gets the offset classes to align the end elements. | -| `Orchard.GetLimitedWidthWrapperCssClasses()` | gets the css classes for the limited width element wrapper element. | -| `Orchard.GetLimitedWidthCssClasses()` | used for a field that has limited width, like the `number` element. For an example, look at the `NumericField.Edit.cshtml` view. | +| Helper | Description | +|----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------| +| `Orchard.GetWrapperCssClasses()` | gets the css classes for the wrapper element. | +| `Orchard.GetLabelCssClasses()` | gets the css classes for a label element. | +| `Orchard.GetStartCssClasses()` | gets the css classes for a starting section. For example, if you want to push your elements to the end to line it up with a label. | +| `Orchard.GetEndCssClasses()` | gets the css classes for the ending section. | +| `Orchard.GetEndCssClasses(bool withOffset)` | gets the css classes for the ending section with optionally an offset. | +| `Orchard.GetOffsetCssClasses()` | gets the offset classes to align the end elements. | +| `Orchard.GetLimitedWidthWrapperCssClasses()` | gets the css classes for the limited width element wrapper element. | +| `Orchard.GetLimitedWidthCssClasses()` | used for a field that has limited width, like the `number` element. For an example, look at the `NumericField.Edit.cshtml` view. | ### `OrchardCore.Search` Module diff --git a/src/docs/releases/1.7.0.md b/src/docs/releases/1.7.0.md index 8212fda6a8a..876bea5d1b4 100644 --- a/src/docs/releases/1.7.0.md +++ b/src/docs/releases/1.7.0.md @@ -209,10 +209,10 @@ A new feature called `Meta Pixel` was added to allow you to easily enable Meta P Due to Facebook's recent rebranding, all of the Facebook features have been renamed to Meta. This only concerns UI labels and documentation, but technical identifiers remain, so you shouldn't expect anything breaking. Here is a list of the naming changes: -| Previous Name | New Name | -| --- | --- | -| `Facebook` | `Meta Core Components` | -| `Facebook Login` | `Meta Login` | +| Previous Name | New Name | +|-----------------------------------|-------------------------------| +| `Facebook` | `Meta Core Components` | +| `Facebook Login` | `Meta Login` | | `Facebook Social Plugins Widgets` | `Meta Social Plugins Widgets` | ### `OrchardCore.Microsoft.Authentication` Module