orphoMan - менеджер ошибок
Компонент для борьбы с орфографическими ошибками и опечатками на сайте.
Начало работы
После установки нужно в системных настройках указать email администратора, которому будет высылаться уведомление. Нет email — нет уведомления. Это самая важная настройка. Остальное можно не менять.
Чтобы компонент заработал, нужно куда-нибудь пристроить сниппет Orphoman. Можно в конкретный ресурс, тогда только в нем можно править ошибки. А можно в шаблон, тогда работать будет во всех ресурсах, у которых используется данный шаблон.
Пример вызова
[[!Orphoman? &min=`3` &max=`50`]]
Работает компонент очень просто. Нашли ошибку, выделили и нажали Ctrl+Enter. Если сообщение успешно отправлено, то появится соответствующее уведомление. Если пользователь авторизован в админке, то ошибки на странице будут подсвечены (см. картинку). Эту возможность можно выключить в системных настройках.
Использование на мобильных устройствах
На мобильных устройствах логика работы следующая - сначала нужно выделить слово, а затем тапнуть на выделение. Появится кнопочка с предложением отправить сообщение.
Дальше как описано выше - диалог->отправить->сообщение о результате.
Также реализована адаптация для мобильных - диалог сообщения об ошибке в зависимости от разрешения и ориентации телефона меняет размер и положение на странице.
Управление ошибками
Список всех ошибок можно посмотреть в менеджере в меню Приложения. Для того, чтобы перейти на страницу ресурса, в котором найдена ошибка, нужно в таблице кликнуть на ссылку.
Двойной клик на строке открывает диалог для просмотра информации об ошибке.
Системные настройки
| Ключ | По-умолчанию | Описание |
|---|---|---|
| highlight | true | Включает выделение слов с ошибками в контенте. Работает только для пользователя, авторизованного в админке. |
| tpl | <span class="error-text" title="{comment}">{text}</span> | Шаблон для выделения слов. Должен содержать строку "{text}". |
| mail_to | Email пользователя, которому будет отправлено уведомление об ошибке. | |
| email_subject | 'На сайте обнаружена орфографическая ошибка' | Заголовок письма об ошибке. Не обязательно. |
| email_body | Текст письма об ошибке. Не обязательно. | |
| auto_delete | true | Автоматическое удаление исправленных (не найденных в контенте) слов. Т.е. ошибку исправили, страницу сайта обновили, ошибка из таблички удалилась автоматически. |
| frontend_css | {assets_url}components/orphoman/css/orphoman.min.css' | Путь к файлу со стилями. Если оставить пустым, то загрузки не будет. |
| frontend_js | {assets_url}components/orphoman/js/orphoman.js | Путь к файлу со скриптами. Если оставить пустым, то загрузки не будет. |
Параметры сниппета orphoMan
| Ключ | По-умолчанию | Описание |
|---|---|---|
| min | 5 | Минимально разрешенное количество символов. |
| max | 100 | Максимально разрешенное количество символов. |
| tpl | orphoman.confirm.dlg | Шаблон диалога. |
| tplButton | orphoman.foundMistake.btn | шаблон кнопки "Нашли ошибку", которая отображается внизу страницы. Если не указан, то кнопка не покажется. |
| loadjGrowl | true | Управляет загрузкой библиотеки jGrowl для отображения сообщений. Если она уже загружается на сайте, то её можно отключить. |