Форматированный текст

Введение

В NocoBase форматированный текст (Rich text) используется для хранения форматированного содержимого.

Поле форматированного текста подходит для основного текста объявлений и статей, шаблонов электронных писем, справочных документов и других материалов. Оно обеспечивает интерфейс, максимально приближенный к редактированию в режиме WYSIWYG.

Если команда привыкла к Markdown или требуется контролируемое форматирование в обычном тексте, выберите Markdown или Markdown Vditor.

Сценарии использования

Форматированный текст подходит для следующих бизнес-сценариев:

  • Основной текст объявлений и статей
  • Шаблоны электронных писем и уведомлений
  • Описание продукта и инструкции по эксплуатации
  • Содержимое, требующее изображений, ссылок и стилей

Создание и настройка

На странице «Configure fields» таблицы данных нажмите «Add field» и выберите «Форматированный текст», чтобы создать поле форматированного текста.

20240512181002

НастройкаОписание
Field interfaceИнтерфейсный тип поля. Форматированному тексту соответствует richText, определяющий способ ввода и отображения данных на странице.
Field display nameНазвание поля, отображаемое в интерфейсе, например «Основной текст объявления», «Шаблон электронного письма» или «Описание продукта». Рекомендуется использовать название, понятное бизнес-пользователям.
Field nameИдентификатор поля, используемый для внутренних ссылок в API, полях связей, правах доступа, рабочих процессах и других компонентах. После создания обычно не изменяется; допускаются только буквы, цифры и символы подчёркивания, при этом название должно начинаться с буквы.
Field typeТип поля на уровне данных. Для хранения содержимого поля форматированного текста обычно используется text.
Default valueЗначение по умолчанию. При создании записи оно может подставляться автоматически, если пользователь ничего не ввёл.
Validation rulesПравила проверки. Можно ограничить длину или сделать поле обязательным.
DescriptionОписание поля. Здесь удобно указывать назначение поля, требования к заполнению, источник данных или ответственное лицо.
Внимание

После создания имя поля будет использоваться блоками страниц, правами доступа, рабочими процессами и API. Перед созданием проверьте название, чтобы избежать дополнительных затрат на изменение конфигурации в будущем.

Особенности поля

Поле форматированного текста по умолчанию ведёт себя следующим образом:

ОсобенностьОписание
Интерфейс Field interface по умолчаниюrichText.
Тип Field type по умолчаниюtext.
Доступный тип Field typetext.
Компонент страницыВ режиме редактирования используется редактор форматированного текста.
ФильтрацияПоддерживаются фильтры для текстовых данных, например «содержит», «пусто» и «не пусто».
СортировкаОбычно не используется для сортировки.
ПроверкаПоддерживаются проверки текста, например ограничение длины и обязательность заполнения.

Редактирование настроек

После создания нажмите «Edit» справа от поля, чтобы изменить настройки поля форматированного текста. Редактирование поля в основном используется для настройки способа его отображения и использования в NocoBase, например для изменения отображаемого названия, описания, значения по умолчанию, правил проверки или специальных параметров поля.

Если поле получено из таблицы, уже синхронизированной с основной базой данных, его редактирование обычно означает настройку сопоставления поля — преобразование поля базы данных в Field type и Field interface NocoBase.

НастройкаМожно редактироватьОписание
Field display nameДаИзменение отображаемого в интерфейсе названия поля без изменения его идентификатора.
Field nameНетИдентификатор поля обычно нельзя изменить в форме редактирования после создания.
Field interfaceВ зависимости от условийИнтерфейс основного поля базы данных или синхронизированного поля можно изменить при сопоставлении. Это повлияет на способ ввода, отображения и проверки данных на странице.
Field typeВ зависимости от условийТип основного поля базы данных или синхронизированного поля можно изменить при сопоставлении. Перед изменением необходимо убедиться, что существующие данные можно использовать с новым типом.
Default valueДаИзменение значения по умолчанию для новых записей.
Validation rulesДаИзменение правил проверки поля.
DescriptionДаДобавление назначения поля, требований к заполнению, источника данных или ответственного лица.
Внимание

Переключение Field type или Field interface — это не простое изменение отображаемого названия. Оно влияет на способ хранения данных, компонент ввода, правила проверки, условия фильтрации и способ использования переменных в рабочих процессах. При наличии большого объёма данных сначала убедитесь, что формат данных совместим.

Удаление поля

Нажмите «Delete» справа от поля, чтобы удалить поле форматированного текста. В основной базе данных можно также выбрать несколько полей и удалить их одновременно.

При удалении созданного в основной базе данных поля форматированного текста обычно одновременно удаляются соответствующий физический столбец базы данных и хранящиеся в нём данные. При удалении поля, синхронизированного с базой данных или сопоставленного с внешним источником данных, область воздействия зависит от соответствующего источника данных и происхождения поля.

Предупреждение

Удаление поля может повлиять на блоки страниц, формы, фильтры, права доступа, рабочие процессы, API, импорт и экспорт, а также существующие данные. Перед удалением убедитесь, что поле больше не используется в бизнес-конфигурации.

Использование в настройках страниц

Поле форматированного текста подходит для сценариев редактирования и отображения содержимого. 20260709231418

СценарийНазначение
Блок формыРедактирование содержимого форматированного текста.
Блок подробной информацииОтображение содержимого с сохранением форматирования.
Шаблон письма или уведомленияИспользование в качестве источника основного текста шаблона.
Блок таблицыОтображение краткого или упрощённого содержимого.

Связанные ссылки

  • Поля — сведения о назначении, категориях и логике сопоставления полей
  • Обычная таблица — создание и управление полями в обычной таблице
  • Markdown — сохранение содержимого Markdown
  • Markdown Vditor — редактирование Markdown с помощью Vditor