Установка и обновление

Установка

1. Откройте в менеджере Пакеты → Установщик.
2. Загрузите пакет tiptapeditor-<версия>.transport.zip (кнопка загрузки пакета) или найдите его в подключённом репозитории.
3. Нажмите Установить и дождитесь окончания.

После установки откройте любой ресурс — в поле «Содержимое» уже будет визуальный редактор.

Что делает установка

• Создаёт пространство имён tiptapeditor, плагин TipTapEditor и системные настройки tiptapeditor.* со значениями по умолчанию (справочник — в разделе Системные настройки).

• Плагин подключается к событиям OnRichTextEditorRegister, OnRichTextEditorInit, OnRichTextBrowserInit и OnManagerPageBeforeRender.

• Устанавливает системные настройки MODX:

  • which_editor = TipTapEditor — редактор выбран для всего сайта;
  • use_editor = Да — визуальный редактор включён.

  Прежние значения записываются в журнал установки, так что их легко вернуть.

Настройки контекста и пользователя не меняются

Установка меняет только системные настройки. Если which_editor переопределён в настройках контекста, группы пользователей или пользователя, это значение остаётся, и там будет работать выбранный ранее редактор. Чтобы включить TipTapEditor и там, поправьте или удалите эти переопределения.

Вернуть другой редактор можно в любой момент: выберите его в which_editor. Если use_editor выключен или выбран другой редактор, файлы TipTapEditor на страницы менеджера не подключаются.

Визуальный редактор у ресурса

У поля «Содержимое» редактор работает, когда у ресурса включён флажок визуального редактора (Rich Text) на вкладке «Настройки». Если флажок снять, поле станет обычным текстовым, а при повторном включении редактор вернётся. На TV этот флажок не влияет.

Дополнительные поля (TV)

Редактор получает каждое TV с типом ввода Rich Text (richtext):

1. Создайте или откройте TV, на вкладке «Параметры ввода» выберите тип Rich Text.
2. Привяжите TV к шаблону.
3. Откройте ресурс с этим шаблоном — у каждого такого TV будет свой редактор.

Как это работает:

• Каждое TV синхронизируется и помечает форму изменённой отдельно от других полей.
• TV на скрытой вкладке или в свёрнутой категории запускается, когда становится видимым.
• TV, которые появились позже (смена шаблона, Form Customization, другие дополнения), подхватываются автоматически. Редактор удалённого поля закрывается.
• TV только для чтения получает редактор только для чтения, отключённое TV остаётся обычным текстовым полем.
• Изображения и файлы для TV берутся из источника файлов, назначенного этому TV в контексте ресурса (см. Media Source).
• Для отдельных TV можно задать свою панель инструментов через tiptapeditor.tv_profiles (см. Профили).

Обновление

Новую версию ставьте поверх старой через Пакеты → Установщик.

• Значения системных настроек tiptapeditor.* не сбрасываются. Новые настройки добавляются со значениями по умолчанию.
• Файл внешней конфигурации и содержимое ресурсов не меняются.
• which_editor и use_editor при обновлении не трогаются.

Новые кнопки добавьте сами

Значение tiptapeditor.toolbar при обновлении сохраняется, поэтому кнопки, которые появились в новой версии, на панели не появятся сами. Сравните свою панель с панелью по умолчанию (она есть в разделе Панель инструментов) и допишите нужные имена, например gallery, file или embed.

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

Переход с TiptapRTE

До версии 0.1.0-alpha15 включительно дополнение называлось TiptapRTE. В 0.1.0-alpha16 оно переименовано в TipTapEditor: другое пространство имён, префикс настроек tiptapeditor.*, папки core/components/tiptapeditor и assets/components/tiptapeditor, плагин, категория и имя в which_editor. Поэтому новая версия ставится как отдельный пакет, а не как обновление.

1. Запишите свои настройки tiptaprte.* (панель, профили, классы и т. д.) — они понадобятся.
2. Удалите пакет TiptapRTE в установщике.
3. Установите TipTapEditor.
4. Задайте настройки заново под новым префиксом tiptapeditor.* — они не переносятся сами.

Что переносится автоматически:

• Значение which_editor со старым именем «Tiptap RTE» переименовывается в «TipTapEditor» в системных настройках, а также в настройках контекстов, групп пользователей и пользователей.
• Галереи, сохранённые старой версией (с атрибутом data-tiptaprte-gallery), по-прежнему открываются как галереи. При следующем сохранении у них появится новый атрибут data-tiptapeditor-gallery.

TIP

Если старый пакет TiptapRTE ещё установлен, установщик TipTapEditor напишет предупреждение в журнал установки. Старый пакет больше не используется — удалите его.

Удаление

При удалении пакета через установщик:

• удаляются файлы, плагин, системные настройки tiptapeditor.* и пространство имён;
• везде, где which_editor указывал на TipTapEditor (системные настройки, контексты, группы пользователей, пользователи), значение очищается — менеджер возвращается к обычному текстовому полю, а не пытается загрузить отсутствующий редактор;
• содержимое ресурсов и значения TV не меняются — весь HTML, теги и галереи остаются как были.

Файл внешней конфигурации (если вы его создавали) удаление не трогает.