• Русский

      • Markdown

      Введение

      В NocoBase Markdown（Markdown） используется для хранения содержимого в формате Markdown.

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

      Если нужен редактор с возможностью визуального редактирования, можно выбрать форматированный текст или Markdown Vditor。

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

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

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

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

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

      20240512181311

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

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

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

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

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

      Редактирование конфигурации

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

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

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

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

      Использование в конфигурации страниц

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

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

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