Referência de configuração.

Aprender DXPR BuilderReferênciaConfiguração e API

O DXPR Builder guarda a sua configuração no sistema de configuração do Drupal. Esta página lista todas as chaves declaradas em config/schema/dxpr_builder.schema.yml com o seu tipo, valores permitidos e predefinição. Também lista a status chave de cada entidade de configuração e as chaves de definições que o código lê sem entrada de esquema. Os nomes em negrito são os rótulos do formulário.

O módulo não traz config/install/dxpr_builder.settings.yml. As predefinições são definidas por hook_install() e pelos update hooks em dxpr_builder.install, ou aplicadas em código quando falta uma chave; a Default coluna indica qual.

Definições gerais

Configuration object: dxpr_builder.settings

Admin path: /admin/dxpr_studio/dxpr_builder/settings (src/Form/DxprBuilderSettingsForm.php)

Chave Tipo Valores permitidos Predefinição Descrição
json_web_token string Uma chave de produto DXPR (JWT) vazio Product key, apenas quando api_key_storage é config. Apagado quando a chave é guardada no módulo Key; a atualização 9026 limpa um valor lá deixado.
api_key_storage string config (Configuration storage), key (Key module) não definido (tratado como config); key depois de dxpr_builder_update_9020() move uma chave existente Storage method for the product key.
key_provider string Um id de entidade Key vazio; update 9020 sets dxpr_builder_jwt quando it move uma chave existente Key entidade que guarda a chave de produto quando api_key_storage é key.
bootstrap string 0, bs5 não definido (sem ficheiros Bootstrap carregados) Sideload Bootstrap ficheiros: 0 = None (theme provides Bootstrap), bs5 = Bootstrap 5. A atualização 8040 reescreve os removidos 1 e bs4 valores para bs5.
cke_stylesset string Uma [label]=[element].[class] entrada por linha vazio (o editor usa então os estilos fornecidos com o DXPR Builder) Custom styles para o editor de texto, por exemplo Sassy Title=h1.sassy-title.
editor_assets_source integer 0, 1, 2 não definido (0) Asset source: 0 = Cloud, 1 = Local (minified), 2 = Local (unminified). O campo só aparece quando existe uma compilação local no dxpr_builder/ pasta. Com 0 guardado, essa compilação continua a ser usada, primeiro a não minificada.
format_filters boolean true, false não definido (desligado) 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)), ou um id de Entity Browser media_library quando o módulo Media Library está instalado, senão dxpr_builder_media_modal quando dxpr_builder_media está instalado, senão '' (definido por hook_install()) Browser type usado pelos campos de imagem.
offset_selector string Um seletor CSS .dxpr-theme-header--sticky, .dxpr-theme-header--fixed (aplicado quando vazio) Scroll offset selector para cabeçalhos fixos.
controls_layout string element (On each element), breadcrumb (Uma row) element (aplicado quando vazio) Control bars no modo de edição: uma barra em cada elemento, ou uma fila por cima do elemento para onde aponta. Um perfil e a definição própria do utilizador sobrepõem-se. A definição do utilizador não é configuração: é guardada com a conta de utilizador (user.data, módulo dxpr_builder, nome controls_layout).

Definições de IA

Guardado no mesmo dxpr_builder.settings objeto.

Admin path: /admin/dxpr_studio/dxpr_builder/ai_settings (src/Form/DxprBuilderAiSettingsForm.php)

Chave Tipo Valores permitidos Predefinição Descrição
ai_enabled boolean true, false true quando em falta; definido pela atualização 9008 Enable text editing assistant.
ai_page_enabled boolean true, false true quando em falta; definido pela atualização 9012 Enable page creation assistant.
ai_image_enabled boolean true, false true quando em falta; definido pela atualização 9015 Enable image generation.
ai_user_model_selection boolean true, false true quando em falta; definido pela atualização 9016 Allow users to choose model. Só mostrado quando ai_provider_dxpr não está instalado.
ai_model string dxai_kavya_m1, dxai_kavya_m1_eu, dxai_kavya_m1_fast dxai_kavya_m1 (AiModelConstants::getDefaultModel()) Default model. Os nomes de API são kavya-m1, kavya-m1-eu e kavya-m1-fast. Só mostrado e guardado quando ai_provider_dxpr não está instalado.
ai_provider_selection_mode string automatic (Automatic), manual (Manual priority) automatic Service providers modo. manual usa a ordem em ai_providers. Só guardado quando ai_provider_dxpr não está instalado.
ai_providers sequência de mapeamentos por id de fornecedor Chaves: anthropic, gemini, mistral, openai, xai. Cada um tem enabled (booleano), weight (inteiro) e region (enabled ou disabled) vazio (o formulário lista então as cinco como ativadas) Tabela de prioridade de fornecedores para o modo manual modo. region é a secção da tabela onde a linha fica, não uma região geográfica.
tone_of_voice_vocabulary string Um id de vocabulário de taxonomia ai_tone_of_voice (vocabulário criado por hook_install() quando Taxonomy está ativado, e pela atualização 9007) Tone of voice vocabulary. A atualização 9025 repõe o valor para ai_tone_of_voice quando o vocabulário guardado já não existe.
enable_taxonomy_tones boolean true, false true quando um vocabulário de tons é definido Definido como true com o vocabulário, por hook_install(), as atualizações ou o formulário. Sem campo de formulário e nenhum código o lê.
commands_vocabulary string Um id de vocabulário de taxonomia ai_agent_commands (created by hook_install() quando Taxonomy é enabled, e by update 9007, apenas quando the key é vazio) Commands vocabulary.
enable_taxonomy_commands boolean true, false true quando um vocabulário de comandos é definido Definido como true com o vocabulário, por hook_install(), a atualização 9007 ou o formulário. Sem campo de formulário e nenhum código o lê.
ai_output_allowed_domains text Domínios um por linha (curingas como *.wikipedia.org permitidos); * permite tudo; vazio bloqueia todos os URLs externos unsplash.com, images.unsplash.com, pexels.com, images.pexels.com, pixabay.com, promptahuman.com (definido por hook_install() e update 9013) Allowed domains. Desmarcar Filter AI output no formulário guarda *.
ai_output_allowed_tags text Nomes de etiquetas HTML um por linha Uma lista de etiquetas comuns de texto, lista, tabela, em linha, média e formulário (div a rp) aplicada no formulário quando a chave falta Allowed HTML tags; as etiquetas não listadas perdem a marcação mas mantêm o texto.
ai_output_stripped_tags text Nomes de etiquetas HTML um por linha script, style Blocked tags, removed with their contents. Desmarcar Filter AI output guarda a predefinição script e style.

Chaves lidas pelo código sem campo de formulário

Estas chaves não estão no esquema mas o módulo lê-as de dxpr_builder.settings. Defina-as com drush config:set ou uma substituição de configuração em settings.php.

Chave Tipo Predefinição quando falta Descrição
record_analytics boolean true Envia análises de uso do editor para tuur.dxpr.com quando verdadeiro.
notifications boolean true Mostra notificações DXPR no editor quando verdadeiro.
cloud_url string https://cdn2.dxpr.com/VERSION/ URL base da CDN para recursos do editor; VERSION é substituído pela versão do módulo.
license_endpoint string https://dxpr.com/api/central-user-storage/ Ponto de extremidade para sincronização de utilizadores licenciados.

Modelos de página

Objetos de configuração: dxpr_builder.page_template.* (tipo de entidade dxpr_builder_page_template)

Admin path: /admin/dxpr_studio/dxpr_builder/page_template

Chave Tipo Valores permitidos Predefinição Descrição
id string Nome de máquina obrigatório Identificador.
label label Qualquer texto obrigatório Label: nome mostrado no seletor de modelos.
status boolean true, false true Enabled. O editor só oferece e carrega modelos ativados.
category text Qualquer texto vazio (o formulário exige-o) Category the template é grouped under.
template string HTML do DXPR Builder vazio (o formulário exige-o) Template marcação.
weight integer Qualquer inteiro vazio (the editor reads it as 0) Weight: ordem de ordenação.
date integer Unix timestamp definido pelo formulário de edição a cada gravação Hora da última modificação.
image string Conteúdo de imagem codificado em Base64 vazio Image: miniatura.
uuid string UUID gerado Id único universal.

O módulo traz cinco modelos de página em config/install: about_me, about_us, homepage_basic, split_content_and_buttons and text_columns.

Perfis de utilizador

Objetos de configuração: dxpr_builder.dxpr_builder_profile.* (tipo de entidade dxpr_builder_profile)

Admin path: /admin/dxpr_studio/dxpr_builder/profile

Num perfil novo, o formulário marca todos os elementos, blocos, apresentações de vistas, modelos de página ativados, modelos globais de utilizador ativados e conjuntos de ícones, além de um conjunto predefinido de botões do editor de texto. As predefinições abaixo são os valores próprios da entidade.

Chave Tipo Valores permitidos Predefinição Descrição
id string Nome de máquina obrigatório Identificador.
label label Qualquer texto obrigatório Label: nome do perfil.
uuid string UUID gerado Id único universal.
status boolean true, false true User profile enabled. Perfis desativados são saltados quando as funções de um utilizador são associadas.
sidebar boolean true, false not stored Chave legada: declarada no esquema mas não exportada pela entidade, por isso nunca é guardada.
dxpr_editor boolean true, false true; update 8008 set it on existing profiles Start editor quando page loads. When false, os controlos só aparecem depois de o utilizador clicar no ícone de olho nos controlos do contentor principal.
controls_layout string default (Same as the site), element (On each element), breadcrumb (Uma row) default Control bars no modo de edição para este perfil. A definição própria do utilizador sobrepõe-se.
weight integer -10 a 10 no formulário 0 Weight: quando as funções de um utilizador correspondem a vários perfis ativados, vence o peso mais baixo.
roles sequence of strings Nomes de máquina de funções (o formulário exclui anonymous e authenticated) vazio Roles o perfil aplica-se.
elements sequence of strings Nomes de máquina de elementos (az_text, az_image, ...) vazio Allowed Elements.
all_elements boolean true, false false Check/Uncheck all Elements. When true, todos os elementos são permitidos e elements é ignorado.
blocks sequence of strings az_block-<block plugin id> valores vazio Allowed Blocks.
all_blocks boolean true, false false Check/Uncheck all Blocks. When true, todos os blocos são permitidos, incluindo os adicionados mais tarde.
views sequence of strings az_view-<view id>-<display id> valores vazio Allowed Views displays.
all_views boolean true, false false Check/Uncheck all Views. When true, todas as apresentações de vistas são permitidas, incluindo as adicionadas mais tarde.
page_templates sequence of strings UUIDs de modelos de página vazio Allowed Page templates.
all_page_templates boolean true, false false Check/Uncheck all Page templates. When true, todos os modelos de página são permitidos.
user_templates sequence of strings UUIDs de modelos globais de utilizador vazio Allowed Global user templates.
all_user_templates boolean true, false false Check/Uncheck all Global user templates. When true, todos os modelos globais de utilizador são permitidos.
icon_sets sequence of strings Ids de conjuntos de ícones de *.dxpr_icon_sets.yml ficheiros vazio Allowed Icon sets.
all_icon_sets boolean true, false não definido (conta como true) Check/Uncheck all Icon sets. When true ou em falta, todos os conjuntos de ícones são permitidos.
inline_buttons sequence of strings Nomes de botões de CKEditor 5 vazio Text editor buttons (inline editing). A atualização 8036 migrou nomes de CKEditor 4 nesta lista e em modal_buttons.
modal_buttons sequence of strings Nomes de botões de CKEditor 5 vazio Text editor buttons (modal editing).

Modelos de utilizador

Objetos de configuração: dxpr_builder.user_template.* (tipo de entidade dxpr_builder_user_template)

Admin path: /admin/dxpr_studio/dxpr_builder/user_templates

Chave Tipo Valores permitidos Predefinição Descrição
id string Nome de máquina obrigatório Identificador.
label label Qualquer texto obrigatório Label: nome do modelo.
status boolean true, false true Sem campo de formulário. Só modelos ativados podem ser carregados no editor ou copiados para um modelo de página.
type string O data-azb tipo de elemento a partir do qual o modelo foi guardado, por exemplo section, row, az_block, az_view, ou custom custom Type. A atualização 9021 preenche-o a partir da marcação; az_block_* e az_view_* valores colapsam para az_block e az_view.
template string HTML do DXPR Builder vazio Template marcação. A atualização 8013 mudou os modelos de utilizador de uma tabela da base de dados para configuração.
uid integer Id de utilizador obrigatório no formulário UID: o dono.
global boolean true, false true (o pedido de gravação do editor envia o seu próprio valor) Global: true disponibiliza o modelo a todos os utilizadores (sujeito a perfis); false mantém-no privado do dono.
image string Conteúdo de imagem codificado em Base64 vazio Image: miniatura.
uuid string UUID gerado Id único universal.

Exportar configuração

Exporte toda a configuração do DXPR Builder:

drush config:export

Isto exporta definições, perfis, modelos de página e modelos de utilizador como ficheiros YAML no diretório de sincronização de configuração. Quando api_key_storage é key, a chave de produto não faz parte de dxpr_builder.settings. Vive na entidade Key selecionada e segue o fornecedor próprio dessa chave, como configuração, um ficheiro ou uma variável de ambiente.

E a seguir?