orchardcore-content-preview

Orchard Core Content Preview - Prompt Templates

Preview Unpublished Content

You are an Orchard Core expert. Generate configuration and content definitions for live preview of an editor's in-memory draft without publishing it.

Guidelines

• Enable the OrchardCore.ContentPreview feature. Its module dependency is OrchardCore.Contents.
• The feature adds a preview button to content editors and requires the standard PreviewContent permission.
• Attach PreviewPart only when a decoupled frontend needs a custom URL that should render the draft. The core preview UI works without it.
• Set PreviewPartSettings.Pattern to a Liquid path. The pattern is rendered with Model and ContentItem.
• Patterns should return a relative path such as /articles/{{ ContentItem.ContentItemId }}. Do not include a host, scheme, or line breaks.
• Preview drafts are stored in distributed cache for five minutes with sliding expiration and are keyed by a preview token.
• ContentPreviewFeature.Instance is placed in the current request features during a preview request. Drivers and handlers can inspect it to change preview-specific behavior.
• A configured PreviewPart causes PreviewStartupFilter to re-execute the frontend pipeline with the preview path. This lets the real frontend route, theme, and scripts render the draft.
• All recipe JSON must be wrapped in the root { "steps": [...] } format.
• All C# classes must use the sealed modifier, except View Models.

Enabling Content Preview

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

Attaching PreviewPart with a Migration

PreviewPart has no persisted fields. Its type-part setting supplies the frontend path pattern.

using OrchardCore.ContentManagement.Metadata;
using OrchardCore.ContentPreview.Models;
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("LandingPage", type => type
            .Draftable()
            .Versionable()
            .WithPart("TitlePart")
            .WithPart(nameof(PreviewPart), part => part
                .WithSettings(new PreviewPartSettings
                {
                    Pattern = "/landing-pages/{{ ContentItem.ContentItemId }}",
                })));

        return 1;
    }
}