Довідник: параметри конфігурації.

Вивчення DXPR BuilderДовідникКонфігурація та API

DXPR Builder зберігає свою конфігурацію в системі конфігурації Drupal. Ця сторінка перелічує кожен ключ, задекларований у config/schema/dxpr_builder.schema.yml, з його типом, допустимими значеннями й стандартом. Вона також перелічує ключ status кожної сутності конфігурації і ключі налаштувань, які код читає без запису схеми. Жирні назви це мітки форм.

Модуль не постачає config/install/dxpr_builder.settings.yml. Стандарти встановлюються hook_install() і хуками оновлення у dxpr_builder.install або застосовуються в коді, коли ключа бракує; стовпець Default указує, як саме.

Загальні налаштування

Об’єкт конфігурації: dxpr_builder.settings

Шлях адміністрування: /admin/dxpr_studio/dxpr_builder/settings (src/Form/DxprBuilderSettingsForm.php)

Ключ Тип Допустимі значення Стандартно Опис
json_web_token string Ключ продукту DXPR (JWT) порожньо Product key, лише коли api_key_storage має значення config. Очищується, коли ключ зберігається в модулі Key; оновлення 9026 очищує залишене там значення.
api_key_storage string config (Configuration storage), key (Key module) не задано (трактується як config); key після того, як dxpr_builder_update_9020() переносить наявний ключ Storage method для ключа продукту.
key_provider string ID сутності Key порожньо; оновлення 9020 установлює 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 По одному запису [label]=[element].[class] на рядок порожньо (редактор тоді використовує стилі, що постачаються з 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)), або ID Entity Browser 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 за відсутності; установлює оновлення 9008 Enable text editing assistant.
ai_page_enabled boolean true, false true за відсутності; установлює оновлення 9012 Enable page creation assistant.
ai_image_enabled boolean true, false true за відсутності; установлює оновлення 9015 Enable image generation.
ai_user_model_selection boolean true, false true за відсутності; установлює оновлення 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 sequence of mappings keyed by provider id Ключі: anthropic, gemini, mistral, openai, xai. Кожен має enabled (boolean), weight (integer) і region (enabled або disabled) порожньо (форма тоді перелічує всі п’ять як увімкнені) Таблиця пріоритетів постачальників для режиму manual. region це розділ таблиці, у якому міститься рядок, а не географічний регіон.
tone_of_voice_vocabulary string ID словника таксономії ai_tone_of_voice (словник створено hook_install(), коли таксономію увімкнено, і оновленням 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(), коли таксономію увімкнено, і оновленням 9007, лише коли ключ порожній) Commands vocabulary.
enable_taxonomy_commands boolean true, false true, щойно задано словник команд Установлюється на true разом зі словником, через hook_install(), оновлення 9007 або форму. Поля форми немає, і жоден код його не читає.
ai_output_allowed_domains text Домени, по одному на рядок (дозволено символи підстановки, як-от *.wikipedia.org); * дозволяє всі; порожньо блокує всі зовнішні 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 Показує сповіщення DXPR у редакторі, коли true.
cloud_url string https://cdn2.dxpr.com/VERSION/ Базовий URL CDN для активів редактора; 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 Машинне ім’я обов’язково Ідентифікатор.
label label Будь-який текст обов’язково Label: ім’я, показане у виборі шаблонів.
status boolean true, false true Enabled. Редактор пропонує й завантажує лише ввімкнені шаблони.
category text Будь-який текст порожньо (форма вимагає його) Category, за якою згруповано шаблон.
template string HTML DXPR Builder порожньо (форма вимагає його) Template: розмітка.
weight integer Будь-яке ціле число порожньо (редактор читає його як 0) Weight: порядок сортування.
date integer Мітка часу Unix установлює форма редагування при кожному збереженні Час останньої зміни.
image string Вміст зображення, закодований Base64 порожньо Image: мініатюра.
uuid string UUID згенеровано Універсально унікальний ідентифікатор.

Модуль постачає п’ять шаблонів сторінок у 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 Машинне ім’я обов’язково Ідентифікатор.
label label Будь-який текст обов’язково Label: ім’я профілю.
uuid string UUID згенеровано Універсально унікальний ідентифікатор.
status boolean true, false true User profile enabled. Вимкнені профілі пропускаються, коли ролі користувача зіставляються.
sidebar boolean true, false не зберігається Застарілий ключ: задекларований у схемі, але не експортується сутністю, тож ніколи не зберігається.
dxpr_editor boolean true, false true; оновлення 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 sequence of strings Машинні імена ролей (форма опускає anonymous і authenticated) порожньо Roles, до яких застосовується профіль.
elements sequence of strings Машинні імена елементів (az_text, az_image, ...) порожньо Дозволені Elements.
all_elements boolean true, false false Check/Uncheck all Elements. Коли true, дозволено кожен елемент, а elements ігнорується.
blocks sequence of strings az_block-<block plugin id>: значення порожньо Дозволені Blocks.
all_blocks boolean true, false false Check/Uncheck all Blocks. Коли true, дозволено кожен блок, включно з доданими пізніше.
views sequence of strings az_view-<view id>-<display id>: значення порожньо Дозволені відображення Views.
all_views boolean true, false false Check/Uncheck all Views. Коли true, дозволено кожне відображення вигляду, включно з доданими пізніше.
page_templates sequence of strings UUID шаблонів сторінок порожньо Дозволені Page templates.
all_page_templates boolean true, false false Check/Uncheck all Page templates. Коли true, дозволено кожен шаблон сторінки.
user_templates sequence of strings UUID глобальних шаблонів користувача порожньо Дозволені Global user templates.
all_user_templates boolean true, false false Check/Uncheck all Global user templates. Коли true, дозволено кожен глобальний шаблон користувача.
icon_sets sequence of strings ID наборів піктограм із файлів *.dxpr_icon_sets.yml. порожньо Дозволені Icon sets.
all_icon_sets boolean true, false не задано (рахується як true) Check/Uncheck all Icon sets. Коли true або відсутнє, дозволено кожен набір піктограм.
inline_buttons sequence of strings Імена кнопок CKEditor 5 порожньо Text editor buttons (inline editing). Оновлення 8036 мігрувало імена CKEditor 4 у цьому списку й у modal_buttons.
modal_buttons sequence of strings Імена кнопок CKEditor 5 порожньо Text editor buttons (modal editing).

Шаблони користувача

Об’єкти конфігурації: dxpr_builder.user_template.* (тип сутності dxpr_builder_user_template)

Шлях адміністрування: /admin/dxpr_studio/dxpr_builder/user_templates

Ключ Тип Допустимі значення Стандартно Опис
id string Машинне ім’я обов’язково Ідентифікатор.
label label Будь-який текст обов’язково Label: ім’я шаблону.
status boolean true, false true Поля форми немає. Лише ввімкнені шаблони можна завантажувати в редакторі або копіювати в шаблон сторінки.
type string Тип елемента data-azb, із якого збережено шаблон, наприклад section, row, az_block, az_view або custom custom Type. Оновлення 9021 дозаповнює його з розмітки; значення az_block_* і az_view_* згортаються до az_block і az_view.
template string HTML DXPR Builder порожньо Template: розмітка. Оновлення 8013 перенесло шаблони користувача з таблиці бази даних у конфігурацію.
uid integer ID користувача вимагається у формі UID: власник.
global boolean true, false true (запит збереження редактора надсилає власне значення) Global: true робить шаблон доступним усім користувачам (залежно від профілів); false лишає його приватним для власника.
image string Вміст зображення, закодований Base64 порожньо Image: мініатюра.
uuid string UUID згенеровано Універсально унікальний ідентифікатор.

Експорт конфігурації

Експортуйте всю конфігурацію DXPR Builder:

drush config:export

Це експортує налаштування, профілі, шаблони сторінок і шаблони користувача як файли YAML у каталозі синхронізації конфігурації. Коли api_key_storage має значення key, ключ продукту не є частиною dxpr_builder.settings. Він живе у вибраній сутності Key і слідує власному постачальнику цього ключа, як-от конфігурація, файл або змінна середовища.

Що далі?