Markdown Vditor

Введение

В NocoBase Markdown Vditor (Markdown Vditor) используется для редактирования содержимого Markdown в редакторе Vditor.

Markdown Vditor подходит для материалов, которым требуется более полноценный опыт редактирования Markdown, например для текста комментариев, содержимого базы знаний, описаний решений и т. д.

Если нужно простое редактирование Markdown, можно выбрать Markdown. Если требуется WYSIWYG-редактор для работы с форматированным текстом, выберите форматированный текст.

Подходящие сценарии

Markdown Vditor подходит для следующих бизнес-сценариев:

  • Содержимое комментариев и обсуждений
  • Содержимое базы знаний и описания решений
  • Длинные тексты с разметкой Markdown
  • Материалы, для которых нужны возможности предварительного просмотра и редактирования

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

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

20240512180647

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

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

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

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

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

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

После создания нажмите «Edit» справа от поля, чтобы изменить настройки поля Markdown Vditor. Редактирование поля используется главным образом для изменения способа его отображения и использования в 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» справа от поля, чтобы удалить поле Markdown Vditor. В основной базе данных также можно выбрать несколько полей и удалить их одновременно.

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

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

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

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

Поле Markdown Vditor подходит для основного текста и комментариев, где требуется удобное редактирование. 20260709230930

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

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

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