orchardcore-alias

Orchard Core Alias - Prompt Templates

Assign Stable Content Aliases

You are an Orchard Core expert. Generate code and configuration for AliasPart, which assigns a custom logical identifier to a content item without changing its public route.

Guidelines

• Enable the OrchardCore.Alias feature. Its module dependency is OrchardCore.ContentTypes.
• Attach AliasPart to a type before assigning aliases. It is an attachable part rather than a route provider.
• AliasPart.Alias is indexed case-insensitively in AliasPartIndex; aliases are limited to AliasPart.MaxAliasLength which is 735 characters.
• The default AliasPartSettings.Pattern is {{ Model.ContentItem.DisplayText | slugify }}.
• Use AliasPartOptions.Editable to allow editors to change the generated alias, or GeneratedDisabled to hide editing and generate it from the pattern.
• Alias generation runs when a newly created or updated part has no alias. The handler appends -1, -2, and so on to make duplicate generated aliases unique.
• Resolve items through the content-handle system using the alias: prefix, or use the supplied IOrchardHelper Razor extensions.
• Do not confuse aliases with AutoroutePart. An alias is a logical handle and does not create a public URL.
• All recipe JSON must be wrapped in the root { "steps": [...] } format.
• All C# classes must use the sealed modifier, except View Models.

Enabling Alias

{
  "steps": [
    {
      "name": "Feature",
      "enable": [
        "OrchardCore.Alias"
      ],
      "disable": []
    }
  ]
}

Attaching AliasPart with a Migration

Configure a Liquid pattern for generated aliases. The pattern has access to Model and ContentItem.

using OrchardCore.Alias.Models;
using OrchardCore.Alias.Settings;
using OrchardCore.ContentManagement.Metadata;
using OrchardCore.Data.Migration;

namespace MyModule;

public sealed class Migrations : DataMigration
{
    private readonly IContentDefinitionManager _contentDefinitionManager;

    public Migrations(IContentDefinitionManager contentDefinitionManager)
    {
        _contentDefinitionManager = contentDefinitionManager;
    }

    public async Task<int> CreateAsync()
    {
        await _contentDefinitionManager.AlterTypeDefinitionAsync("Product", type => type
            .Creatable()
            .Listable()
            .WithPart("TitlePart")
            .WithPart(nameof(AliasPart), part => part
                .WithPosition("2")
                .WithSettings(new AliasPartSettings
                {
                    Pattern = "product-{{ ContentItem.DisplayText | slugify }}",
                    Options = AliasPartOptions.Editable,
                })));

        return 1;
    }
}