Документация InstantCMS

для администраторов и разработчиков

Инструменты пользователя

Инструменты сайта


manual:components:typograph

Компонент "Типограф"

Панель управленияКомпонентыТипограф

Описание

Компонент позволяет создавать пресеты (группы настроек) для типографирования текста. Управление пресетами типографа появилось с версии InstantCMS 2.16.2.

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

Компонент логически тесно связан с Wysiwyg редакторами. Учитывайте разрешённые теги в пресетах типографа с настройками пресетов Wysiwyg редакторов. Например, для комментариев вы создали пресет редактора, где для тулбара вы разрешили выделение жирным/курсивом и вставку изображений. Хорошей практикой будет создание пресета для типографа, где будут разрешены теги <strong>, <b>, <i> и <img>. А в настройках компонента «Комментарии» выберите созданный вами пресет типографа. Аналогично стоит поступать и с другими разделами InstantCMS, где используются HTML редакторы, например для стены, поля «Текст HTML» и других.

Создание пресета

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

Опция «Автоматический перенос строк» включает автоматическое преобразование символа переноса строки \n на тег <br>.

Опция «Автоматически определять ссылки» автоматически определяет HTTP ссылку и преобразует в тег <a>.

Опция «Внешние ссылки через редирект» автоматически определяет в тексте внешние ссылки и заворачивает их через промежуточную страницу. Должен быть включен компонент Редиректы.

Опция «Включить обработку тегов заданными колбэками» включает обработку тегов, в настройках которых указаны колбэки.

Опция «Автозамена» позволяет заменять в тексте один набор символов на другой.

Набор опций "Атрибуты для тега"

Опция «Колбэк тега» позволяет указать обработчик тега в формате контроллер|метод. Эта опция скорее для разработчиков и указывать её стоит, когда точно знаете, что делаете. Базовый набор колбэков вы найдёте в файле system/controllers/typograph/frontend.php. Все они использованы в пресете по умолчанию.

Опция «Тип атрибута» указывает тип атрибута тега.

В опции «Имя атрибута» вы указываете название атрибута тега, например src, width, height и т.д. Обратите внимание, атрибуты, начинающиеся с on, указать нельзя.

В опции «Возможные значения атрибута» указывается список возможных значений, каждый с новой строки. Если пользователь укажет в значении атрибута иное значение, атрибут не будет выведен. Эта опция актуальна для типов атрибутов «Список доменов» и «Список значений».

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


Назад к разделу Компоненты

manual/components/typograph.txt · Последнее изменение: 25.12.2023 00:13 — fuze