蓝图

条目

条目蓝图是用于定义您网站区域的标准内容结构。内容结构和条目可以通过不同方式组织，正如我们在此处更详细描述的那样。

entry 类型支持多个条目，当没有其他变体适用时应使用。

handle: Team\Member
type: entry
name: Team Member

fields:
    name:
        label: First Name
        type: text

以下属性由条目蓝图支持。

条目变体

虽然条目类型没有特定的行为，但也存在几种可用于组织内容的变体。以下类型是条目的变体。

• 条目 是用于常见目的的基本条目。
• 单例 是一个独立条目，具有专用字段，例如：联系我们页面。
• 结构 是条目的一个定义结构，例如：文档页面。
• 流 是一个时间戳条目流，例如：博客文章。

单个条目

single 类型将强制每个节定义只包含一个条目。这对于一次性内容很有用，例如主页或联系我们页面。下面定义了一个 主页 节，其中包含一个欢迎消息 (welcome_message) 文本字段。

handle: Homepage
type: single
name: Homepage Content

fields:
    welcome_message:
        label: Welcome Message
        type: text

结构条目

该structure类型允许多个结构化条目，允许存在父子关系。这对于嵌套内容很有用，例如文档部分。类型为structure的条目是可排序的。可以通过在列表视图中拖动它们来调整其排序顺序。以下定义了一个文档树形部分，其中包含一个文章内容（article_content）Markdown 字段。

handle: Docs\Article
type: structure
name: Documentation Article

fields:
    content:
        label: Article Content
        type: markdown

默认情况下，结构支持无限嵌套，但是，您可以使用 structure 属性中的 maxDepth 指定树的最大深度。在下一个示例中，只能有一个顶级和第二级。

# ...
type: structure

structure:
    maxDepth: 2
    # ...

以下值受 structure 属性支持。

流条目

stream 类型用于基于时间的条目，这些条目通常按时间顺序排列。这对于发布最新活动很有用，例如博客部分。下面定义了一个 博客 feed 部分，其中包含一个文章内容 (content) 富文本编辑器字段。

handle: Blog\Post
type: stream
name: Blog Post

fields:
    content:
        label: Post Content
        type: richeditor

defaultSort 属性用于设置当蓝图记录以列表形式显示时的默认排序列。这将被默认设置为发布日期。

handle: Blog\Post
type: stream
name: Blog Post

defaultSort:
    column: title
    direction: asc

内容组

所有条目都可选地支持为一个部分定义多个内容组。例如，一个博客部分可能有一个常规帖子和一个特色帖子，这些是两个条目组。

条目组由区段蓝图文件中的 groups 属性定义，并且可以为每种类型指定不同的 字段。选定的组值在记录上作为 content_group 属性可用。

handle: Blog\Post
type: stream
name: Blog Post

groups:
    regular_post:
        name: Regular Post
        fields:
            # ...

    featured_post:
        name: Featured Post
        fields:
            # ...

It is recommended to use mixin blueprints to group common field definitions.
:::

自定义消息

指定 customMessages 属性以覆盖界面使用的默认消息。这些值可以是纯文本，也可以引用一个本地化字符串。

customMessages:
    buttonCreate: Create New Event

以下消息可重写为自定义消息。

::: details 查看可用消息列表

禁用必填字段

条目记录在保存之前需要填充 title 和 slug 字段，此外，slug 字段也必须是唯一的。您可以通过在蓝图中覆盖这些字段来修改此功能。可以通过将 validation 属性设置为 false，或者将 hidden 属性设置为 true 并将其从用户界面中隐藏。以下示例将禁用这两个字段的验证并隐藏 slug 字段。

fields:
    title:
        validation: false

    slug:
        hidden: true

页面查找器配置

默认情况下，所有条目都包含在 页面查找器 查找值。这可以通过将 页面查找器 设置为 false 禁用。

pagefinder: false

您可以限制页面查找器上下文，使其仅允许将页面定位为单个 item （例如，博客文章）或 list 形式的项（例如，所有博客文章），或者当设置为 all 时将同时显示两者。

pagefinder: item
pagefinder: list

页面查找器将自动解析 id、code、slug 和 fullslug 属性，并将其用作 页面 URL 参数 中的替代项。您可以使用 pagefinder 属性，以数组形式指定自定义的 替代项，其中包括上述可选的 上下文。

pagefinder:
    context: list
    replacements: []

每个替换键应与一个 URL 参数名称匹配，并使用点表示法路径来指向属性值。以博客文章页面的以下 URL 示例为例。

url = "/blog/post/:author/:category/:slug/:id"

以下替换将把 :author 参数设置为相关作者的 slug 属性值，并将 :category 参数设置为第一个相关类别的 slug 属性值。

pagefinder:
    replacements:
        author: author.slug
        category: categories.0.slug

全局

全局变量用于定义您网站的全局可用内容。这些字段值常用于CMS 布局并包含设置，例如社交网络链接。

以下定义了一个 页脚配置 全局，包含一个 Facebook 链接 (facebook_link) 文本字段。

handle: Site\Footer
type: global
name: Footer Config

fields:
    facebook_link:
        label: Facebook Link
        type: text

以下属性由全局蓝图支持。

混入

Mixin 是一组字段，用于在定义内容结构时避免重复。例如，一个 Location 字段可能在多个地方使用，但我们可以使用一个 mixin 定义只定义它一次。

以下定义了一个位置集合，其中包含国家（country_code）和州（state_code）文本字段。

handle: Fields\Location
type: mixin
name: Location

fields:
    country_code:
        label: Country
        type: text

    state_code:
        label: State
        type: text

以下属性受 mixin 蓝图支持。

考虑在mixin文件和字段名前加上下划线 (_) 以便蓝图类型易于查找。例如: _location_fields.yaml

使用 Mixin

要在您的条目中包含这些字段，就像任何其他表单字段一样，使用 type 为 mixin 并在 source 属性中引用 UUID 或句柄。

_location_fields:
    type: mixin
    source: Fields\Location

请参阅 Mixin 字段 以获取有关使用 mixin 的更多信息。

另请参阅

• 混入内容字段