FCKeditor - WYSIWYG HTML editor

Модуль FCKeditor служит для взаимодействия с редактором FCKeditor и позволяет заменить все формы для набора текста формой редактора WYSIWYG, т.е. редактора, в котором, во-первых, редактируемый текст отображается в той форме, в которой он будет опубликован, и, во-вторых, используются визуальные средства форматирования. Редактор, предоставляемый модулем FCKeditor используется, кроме Drupal, в значительном количестве других CMS.

Перед подключением модуля FCKeditor нужно скачать с сайта fckeditor.net последнюю версию редактора и распаковать содержимое архива в каталог модуля FCKeditor в подкаталог fckeditor/ (в составе модуля FCKeditor этот каталог содержит файл COPY_HERE.txt, название которого переводится как «копировать_сюда.txt»). После осуществления этой операции можно подключать модуль FCKeditor на странице управления модулями.

На следующем шаге следует назначить права доступа к редактору FCKeditor:

•access fckeditor — использование FCKeditor.
•administer fckeditor — управление FCKeditor.
•allow fckeditor file uploads — загрузка файлов при использовании FCKeditor.

Далее можно перейти к настройке FCKeditor на странице Administer | Site configuration | FCKeditor. На этой странице перечислены профили, использующиеся для ограничения доступа к различным функциям FCKeditor. Автоматически создаются (если назначены соответствующие права доступа) профили для анонимных пользователей (профиль Default) и для зарегистрированных пользователей (профиль Advanced). Каждый профиль можно отредактировать (edit) или удалить (delete). Здесь же можно создать новый профиль (Create new profile) и отредактировать глобальный профиль (FCKeditor Global Profile), настройки которого объединяются со всеми остальными профилями.

Если для каких-то ролей отсутствует профиль в настройках FCKeditor, то показывается предупреждение “Not all roles with access fckeditor permission are associated with FCKeditor profiles” и перечисляются такие роли. В этом случае можно создать для таких ролей новый профиль или добавить роли в уже существующие профили.

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

•Basic setup — основные настройки.
•Security — настройки безопасности.
•Visibility settings — настройки отображения.
•Editor appearance — настройки состояния редактора.
•Cleanup and output — настройки форматирования при вводе текста.
•CSS — настройки CSS.
•File browser settings — настройки загрузки файлов.
•Advanced options — дополнительные опции.

В этих блоках перечислены не все настройки, доступные для FCKeditor. Часть настроек доступна только через редактирование файла fckeditor/fckeditor/fckeditor.config.js. Для добавления панелей инструментов и дополнительных функций можно отменить комментирование соответствующих строк в файле. Кроме того, в файл можно добавить собственный код.

В блоке основных настроек (Basic setup) на странице редактирования профиля указываются наименование профиля (Profile name) и роли, для которых используется профиль (Roles allowed to use this profile). Пользователям можно разрешить изменять настройки состояния редактора, выбрав true в меню Allow users to customize FCKeditor appearance. Если пользователь может изменять настройки FCKeditor, то на странице My account | Edit для этого пользователя появляется блок Rich Text Editor, в котором можно изменить настройки состояния редактора (на странице редактирования профиля FCKeditor этот блок называется Editor appearance).

В блоке настроек безопасности (Security) выбираются фильтры, применяемые к вводимым данным. Эти фильтры необходимы для того, чтобы предотвратить опасность исполнения вредоносного кода при обработке его с помощью FCKeditor. Фактически в стандартной установке FCKeditor можно использовать только один фильтр: встроенный в Drupal фильтр HTML filter, который применяется по умолчанию только к формату ввода Filtered HTML и настраивается на странице Configure для этого формата. Соответственно, вводимые данные фильтруются только если на странице редактирования содержания выбран формат ввода Filtered HTML. Именно поэтому обычным пользователям должен быть предоставлен доступ только к тем форматам ввода, которые используют фильтр HTML filter или аналогичный (который может быть установлен в результате подключения каких-то дополнительных модулей). Опция HTML corrector включает не фильтр, а корректор HTML-кода, который может исправить и запустить как безвредный, так и вредоносный код.

В поле Security settings можно выбрать условия использования выбранных фильтров: Always run security filters for FCKeditor (всегда использовать фильтры для FCKeditor) или Run security filters only when FCKeditor is set to start automatically (использовать фильтры только при автоматическом запуске FCKeditor). Последняя опция не рекомендуется для использования на работающих сайтах.

В блоке настроек отображения (Visibility settings) редактируются следующие настройки:

•Minimum rows — минимальное количество строк в текстовой области, при котором используется FCKeditor.
•Use inclusion or exclusion mode — использовать режим исключения (exclude) или включения (include) для следующих двух полей. При режиме исключения FCKeditor не используется только для перечисленных полей и страниц, при режиме включения FCKeditor используется только для перечисленных полей и страниц.
•Fields to exclude/include — список идентификаторов исключаемых/включаемых полей, разделённых запятыми, пробелами или символами новой строки. Идентификатор поля, для которого может использоваться FCKeditor, показывается ниже поля в информационном сообщении. Например, для формы редактирования основного текста на странице создания статьи: «The ID for excluding or including this element is: edit-body - the path is: node/add/story». В этом сообщении говорится, что идентификатор поля edit-body, а адрес страницы (используется в следующем поле настроек) node/add/story.
•Paths to exclude/include — список адресов исключаемых/включаемых страниц, разделённых запятыми, пробелами или символами новой строки. Можно использовать символ «*» при указании группы адресов.
•Force simplified toolbar on the following fields — перечень идентификаторов полей, для которых используется упрощённая панель задач.
•Force simplified toolbar on the following paths — перечень адресов страниц, для которых используется упрощённая панель задач.

В блоке настроек состояния редактора (Editor appearance) редактируются следующие опции:

•Default state — состояние по умолчанию. Если по умолчанию FCKeditor не включён (disabled), то его можно включить с помощью переключателя Switch to rich text editor, отображаемого под текстовым полем, или с помощью окна редактирования текста, открываемого при нажатии на ссылку Open rich editor.
•Show disable/enable rich text editor toggle — показывать (true) или не показывать (false) переключатель между FCKeditor и стандартным редактированием. Если включено отображение FCKeditor в отдельном окне (true в меню Use FCKeditor in a popup window), то отображение переключателя должно быть отключено (false).
•Use FCKeditor in a popup window — показывать (true) или не показывать (false) ссылку, открывающую FCKeditor в новом окне. Если в меню Show disable/enable rich text editor toggle включено отображение переключателя (true), то отображение ссылки должно быть отключено (false).
•Skin — способ оформления панели инструментов FCKeditor. Можно выбрать Default (стандартный), Office2003 (в стиле MS Office 2003) или Silver (с использованием стиля Silver).
•Toolbar — отображаемый набор инструментов FCKeditor. В зависимости от выбранного значения параметра в панели инструментов может отображаться различное количество кнопок, соответствующих различным функциям FCKedit. Параметр может принимать следующие значения: Basic (показываются минимальный набор инструментов), Default (показывается стандартный набор инструментов FCKedit), DrupalBasic (минимальный набор инструментов, оптимизированный для Drupal), DrupalFiltered (стандартный набор инструментов, оптимизированный для Drupal), DrupalFull (полный набор инструментов, оптимизированный для Drupal).
•Start the toolbar expanded — отображение панели инструментов в раскрытом виде (enabled) или в свёрнутом виде (disabled).
•Width — ширина панели инструментов в пикселях или в процентах относительно столбца.
•Language — используемый язык. Можно выбрать сокращение, соответствующее языку. Например, для русского это RU. Но эта настройка будет использоваться только если отключено автоопределение языка (в меню Auto-detect language выбрано false).
•Auto-detect language — включение (true) и выключение (false) автоопределения языка.

В блоке настроек форматирования при вводе текста (Cleanup and output) выбираются теги, вставляемые в текст при нажатии клавиши «Enter» (Enter mode) и комбинации клавиш «Shift»+«Enter» (Shift + Enter mode). В поле Font formats указываются теги, используемые для форматирования текста (выпадающий список Format на панели инструментов FCKedit).

В поле Apply source formatting можно включить (true) вставку символов новой строки в XHTML-код после некоторых тегов при его просмотре после нажатия на кнопку «Источник». В поле Format output можно включить (true) вставку символов новой строки в сохраняемый после редактирования XHTML-код.

В настройках CCS (CSS) редактируются следующие параметры:

•Editor CSS — определения каскадных таблиц стиля, использующиеся в области редактирования. Можно выбрать файл CSS, определённый темой Drupal (use theme css), стандартные CSS FCKeditor (FCKeditor default) или определить путь к пользовательскому файлу CSS (define css).
•CSS path — путь к пользовательскому файлу CSS или пути к файлам CSS, разделённые запятыми. Используется только при выборе в качестве CSS пользовательского файла в поле Editor CSS. Можно использовать переменные %h (путь к корневому каталогу сайта, например, /Drupal/) и %t (путь к каталогу темы, например, /Drupal/themes/garland/).
•Predefined styles — местонахождение используемого файла fckstyles.xml, в котором определены стили, показываемые в списке Стиль панели инструментов FCKeditor. Возможные варианты: use theme fckstyles.xml (использовать файл, расположенный в каталоге темы), FCKeditor default (использовать стандартный файл FCKeditor) и define path to fckstyles.xml (определить путь к файлу fckstyles.xml). В последнем случае путь к файлу указывается в поле Predefined styles path.

К настройкам загрузки файлов относятся следующие:

•File browser type — используемый механизм загрузки файлов и обзора файлов, хранящихся на сервере. По умолчанию механизм обзора файлов не выбран (None). Для использования встроенного в FCKeditor механизма обзора файлов (Built-in filebrowser) требуется дополнительная настройка FCKeditor. Также можно использовать механизмы, предоставляемые дополнительными модулями, например, IMCE).
•Allow quick uploads — разрешить (true) или запретить (false) быструю загрузку, т.е. загрузку файлов из определённого в следующих полях каталога. Функционирование быстрой загрузки не зависит от выбранного механизма обзора файлов.
•Path to uploaded files — путь к загруженным файлам относительно корневого каталога сайта. Могут использоваться следующие подстановки: %b (корневой каталог сайта, /Drupal/), %f (стандартный путь к каталогу загружаемых файлов, sites/default/files), %u (идентификатор пользователя).
•Absolute path to uploaded files — локальный путь на сервере, ведущий к каталогу, указанному в предыдущем поле. Дополнительно можно использовать подстановку %d (локальный путь к корневому каталогу веб-сервера, например, c:/xampp/htdocs).

В блоке дополнительных опций можно включить (true в меню Load fckeditor.config.js from theme path) загрузку файла fckeditor.config.js не из каталога FCKeditor, а из каталога с файлами темы. Здесь же можно указать директивы, дополняющие этот файл и применяющиеся для редактируемого профиля (Custom javascript configuration).

При редактировании глобального профиля FCKeditor (FCKeditor Global Profile) в блоке основных настроек (Main setup) указывается ряд старшинства ролей пользователей, применяющийся для определения применяемого профиля FCKeditor в том случае, когда пользователю назначено несколько ролей. Для таких пользователей применяется профиль, соответствующий главной роли в ряду Role precedence. Каждой роли назначается число, и эти соответствия перечисляются ниже поля Role precedence. Ряд старшинства ролей включает в себя перечень чисел, соответствующих ролям, разделённых знаками «>». Ряд начинается с самой старшей роли.

Блок настроек отображения (Visibility settings) соответствует такому же блоку на страницах редактирования не глобальных профилей, но в глобальном профиле автоматически установлены наиболее важные ограничения. Пример окна редактирования FCKeditor: