配置参考.

Learn DXPR BuilderReferenceConfiguratie en API

DXPR Builder 将其配置存储在 Drupal 配置系统中。本页列出以下位置声明的每个键 config/schema/dxpr_builder.schema.yml 带其类型、允许值和默认值。它还列出 status 每个配置实体的键,以及代码读取但无架构条目的设置键。粗体名称是表单标签。

该模块不随附 config/install/dxpr_builder.settings.yml。默认值由 hook_install() 和 dxpr_builder.install 中的更新钩子设置,或在缺少键时由代码应用;默认值列说明是哪种情况。

常规设置

配置对象: dxpr_builder.settings

管理路径: /admin/dxpr_studio/dxpr_builder/settings (src/Form/DxprBuilderSettingsForm.php)

键 类型 可选值 默认值 描述
json_web_token string DXPR 产品密钥(JWT) empty Product key,仅当 api_key_storage 为 config。密钥存入 Key 模块时清除;update 9026 清除遗留的值。
api_key_storage string config (Configuration storage), key (Key module) 未设置(视为 config); key 之后 dxpr_builder_update_9020() 移动现有密钥 Storage method 用于产品密钥。
key_provider string Key 实体 ID empty; update 9020 sets dxpr_builder_jwt 当它移动现有密钥时 Key 持有产品密钥的实体,条件为 api_key_storage 为 key.
bootstrap string 0, bs5 未设置(未加载 Bootstrap 文件) Sideload Bootstrap files: 0 = None (theme provides Bootstrap), bs5 = Bootstrap 5。更新 8040 重写已移除的 1 和 bs4 值为 bs5.
cke_stylesset string One [label]=[element].[class] 每行一个条目 empty(此时编辑器使用 DXPR Builder 自带的样式) Custom styles 用于文本编辑器,例如 Sassy Title=h1.sassy-title.
editor_assets_source integer 0, 1, 2 未设置(0) Asset source: 0 = Cloud, 1 = Local (minified), 2 = Local (unminified)。仅当模块的以下位置存在本地构建时字段出现 dxpr_builder/ 文件夹。当 0 已存储,仍使用此类构建,优先未压缩版。
format_filters boolean true, false 未设置(关闭) Apply text format filters to frontend content.
media_browser string '' (Basic file upload), media_library (Media Library), media_library_acquia_dam (Media Library (Acquia DAM)),或一个 Entity Browser ID media_library(已安装 Media Library 模块时),否则 dxpr_builder_media_modal(已安装 dxpr_builder_media 时),否则 ''(由 hook_install() 设置) Browser type 图像字段使用。
offset_selector string CSS 选择器 .dxpr-theme-header--sticky, .dxpr-theme-header--fixed(为空时应用) Scroll offset selector 用于固定页头。
controls_layout string element (On each element), breadcrumb (One row) element(为空时应用) Control bars 编辑模式:每个元素上的条,或所指元素上方的一行。资料和用户自己的设置覆盖它。用户设置不是配置:它与用户账户一起存储(user.data,模块 dxpr_builder,名称 controls_layout).

AI 设置

存储在相同位置 dxpr_builder.settings 对象。

管理路径: /admin/dxpr_studio/dxpr_builder/ai_settings (src/Form/DxprBuilderAiSettingsForm.php)

键 类型 可选值 默认值 描述
ai_enabled boolean true, false true 缺失时;由 update 9008 设置 Enable text editing assistant.
ai_page_enabled boolean true, false true 缺失时;由 update 9012 设置 Enable page creation assistant.
ai_image_enabled boolean true, false true 缺失时;由 update 9015 设置 Enable image generation.
ai_user_model_selection boolean true, false true 缺失时;由 update 9016 设置 Allow users to choose model。仅在以下情况显示 ai_provider_dxpr 未安装。
ai_model string dxai_kavya_m1, dxai_kavya_m1_eu, dxai_kavya_m1_fast dxai_kavya_m1 (AiModelConstants::getDefaultModel()) Default model。API 名称为 kavya-m1, kavya-m1-eu 和 kavya-m1-fast。仅在以下情况显示和保存 ai_provider_dxpr 未安装。
ai_provider_selection_mode string automatic (Automatic), manual (Manual priority) automatic Service providers 模式。 manual 使用以下位置的顺序 ai_providers。仅在以下情况保存 ai_provider_dxpr 未安装。
ai_providers 以提供方 ID 为键的映射序列 键: anthropic, gemini, mistral, openai, xai。每个有 enabled (布尔值), weight (整数)与 region (enabled 或 disabled) empty(此时表单将五个全部列为已启用) 以下内容的提供方优先级表 manual 模式。 region 是行所在的表格分区,而非地理区域。
tone_of_voice_vocabulary string 分类词汇表 ID ai_tone_of_voice (词汇表由 hook_install() 当 Taxonomy 启用时,以及通过更新 9007) Tone of voice vocabulary。更新 9025 将值指回 ai_tone_of_voice 当存储的词汇表不再存在时。
enable_taxonomy_tones boolean true, false true 设置语气词汇表后 设为 true 带词汇表,通过 hook_install(),更新或表单。没有表单字段,也没有代码读取它。
commands_vocabulary string 分类词汇表 ID ai_agent_commands (由 hook_install() 当 Taxonomy 启用时,以及通过更新 9007,仅当键为空时) Commands vocabulary.
enable_taxonomy_commands boolean true, false true 设置命令词汇表后 设为 true 带词汇表,通过 hook_install(),更新 9007 或表单。没有表单字段,也没有代码读取它。
ai_output_allowed_domains text 每行一个域名(允许 *.wikipedia.org 等通配符);* 允许所有;empty 阻止所有外部 URL unsplash.com, images.unsplash.com, pexels.com, images.pexels.com, pixabay.com, promptahuman.com (由 hook_install() 和更新 9013) Allowed domains。取消勾选 Filter AI output 在表单上存储 *.
ai_output_allowed_tags text 每行一个 HTML 标签名 常见文本、列表、表格、内联、媒体和表单标签列表(div 到 rp),在键缺失时应用于表单 Allowed HTML tags;未列出的标签去掉标记但保留文本。
ai_output_stripped_tags text 每行一个 HTML 标签名 script, style Blocked tags,连同其内容一起移除。取消勾选 Filter AI output 存储默认值 script 和 style.

代码读取但无表单字段的键

这些键不在架构中,但模块从以下位置读取 dxpr_builder.settings。通过以下方式设置它们 drush config:set 或以下位置的配置覆盖 settings.php.

键 类型 缺失时的默认值 描述
record_analytics boolean true 向以下位置发送编辑器使用分析 tuur.dxpr.com 为 true 时。
notifications boolean true 为 true 时在编辑器中显示 DXPR 通知。
cloud_url string https://cdn2.dxpr.com/VERSION/ 编辑器资源的 CDN 基础 URL;VERSION 替换为模块版本。
license_endpoint string https://dxpr.com/api/central-user-storage/ 许可用户同步端点。

页面模板

配置对象: dxpr_builder.page_template.* (实体类型 dxpr_builder_page_template)

管理路径: /admin/dxpr_studio/dxpr_builder/page_template

键 类型 可选值 默认值 描述
id string 机器名 required 标识符。
label label Any text required Label:模板选择器中显示的名称。
status boolean true, false true Enabled。编辑器仅提供和加载已启用的模板。
category text Any text empty(表单中必填) Category 模板分组所属的类别。
template string DXPR Builder HTML empty(表单中必填) Template 标记。
weight integer 任何整数 empty(编辑器将其读为 0) Weight:排序。
date integer Unix 时间戳 编辑表单每次保存时设置 上次修改时间。
image string Base64 编码的图像内容 empty Image:缩略图。
uuid string UUID generated 全局唯一 ID。

该模块随附五个页面模板,位于 config/install: about_me, about_us, homepage_basic, split_content_and_buttons 和 text_columns.

用户资料

配置对象: dxpr_builder.dxpr_builder_profile.* (实体类型 dxpr_builder_profile)

管理路径: /admin/dxpr_studio/dxpr_builder/profile

在新资料上,表单勾选每个元素、区块、视图显示、已启用的页面模板、已启用的全局用户模板和图标集,以及一组默认文本编辑器按钮。以下默认值是实体自己的值。

键 类型 可选值 默认值 描述
id string 机器名 required 标识符。
label label Any text required Label:资料名称。
uuid string UUID generated 全局唯一 ID。
status boolean true, false true 用户资料已启用。匹配用户角色时跳过禁用的资料。
sidebar boolean true, false 不存储 遗留键:在架构中声明但实体不导出,因此从不保存。
dxpr_editor boolean true, false true;update 8008 已在现有资料上设置该值 Start editor when page loads。当 false,控件只在用户点击主容器控件上的眼睛图标后出现。
controls_layout string default (Same as the site), element (On each element), breadcrumb (One row) default Control bars 此资料的编辑模式。用户自己的设置覆盖它。
weight integer -10 到 10 表单中 0 Weight:当用户的角色匹配多个启用的资料时,最低权重获胜。
roles 字符串序列 角色机器名(表单省略 anonymous 和 authenticated) empty Roles 资料适用的角色。
elements 字符串序列 元素机器名(az_text, az_image, ...) empty Allowed Elements.
all_elements boolean true, false false Check/Uncheck all Elements。当 true,允许所有元素,并且 elements 被忽略。
blocks 字符串序列 az_block-<block plugin id> 值 empty 允许的 Blocks.
all_blocks boolean true, false false Check/Uncheck all Blocks。当 true,允许所有区块,包括后来添加的。
views 字符串序列 az_view-<view id>-<display id> 值 empty 允许的 Views 显示。
all_views boolean true, false false Check/Uncheck all Views。当 true,允许所有视图显示,包括后来添加的。
page_templates 字符串序列 页面模板 UUID empty 允许的 Page templates.
all_page_templates boolean true, false false Check/Uncheck all Page templates。当 true,允许所有页面模板。
user_templates 字符串序列 全局用户模板 UUID empty 允许的 Global user templates.
all_user_templates boolean true, false false Check/Uncheck all Global user templates。当 true,允许所有全局用户模板。
icon_sets 字符串序列 图标集 ID 来自 *.dxpr_icon_sets.yml 文件 empty 允许的 Icon sets.
all_icon_sets boolean true, false 未设置(计为 true) Check/Uncheck all Icon sets。当 true 或缺失时,允许每个图标集。
inline_buttons 字符串序列 CKEditor 5 按钮名称 empty Text editor buttons (inline editing)。更新 8036 迁移了此列表及以下位置中的 CKEditor 4 名称 modal_buttons.
modal_buttons 字符串序列 CKEditor 5 按钮名称 empty Text editor buttons (modal editing)。

用户模板

配置对象: dxpr_builder.user_template.* (实体类型 dxpr_builder_user_template)

管理路径: /admin/dxpr_studio/dxpr_builder/user_templates

键 类型 可选值 默认值 描述
id string 机器名 required 标识符。
label label Any text required Label:模板名称。
status boolean true, false true 无表单字段。只有已启用的模板才能在编辑器中加载或复制到页面模板。
type string 该 data-azb 模板所保存的元素类型,例如 section, row, az_block, az_view,或 custom custom 类型。Update 9021 从标记回填该值;az_block_* 和 az_view_* 值合并为 az_block 和 az_view。
template string DXPR Builder HTML empty Template 标记。更新 8013 将用户模板从数据库表移到配置中。
uid integer 用户 ID 表单中必填 UID:所有者。
global boolean true, false true (编辑器的保存请求发送自己的值) Global:true 使模板对所有用户可用(受资料限制);false 仅对其所有者保持私有。
image string Base64 编码的图像内容 empty Image:缩略图。
uuid string UUID generated 全局唯一 ID。

导出配置

导出所有 DXPR Builder 配置:

drush config:export

这将设置、资料、页面模板和用户模板导出为配置同步目录中的 YAML 文件。当 api_key_storage 为 key,产品密钥不属于 dxpr_builder.settings。它位于所选 Key 实体中,遵循该键自己的提供方,如配置、文件或环境变量。

接下来做什么?