Установка модуля «Мибок: Версия для слабовидящих» на сайт

1. Активная лицензия CMS 1С-Битрикс
2. Версия 1С-Битрикс не ниже 20.0 (для более ранних версий 1С-Битрикс могут потребоваться корректировки)
3. Редакции 1С-Битрикс: «Первый сайт», «Старт», «Стандарт», «Малый бизнес», «Эксперт»,«Бизнес»
4. Минимальные технические требования:
   • UNIX или Windows-платформа
   • PHP 7.4 и выше
   • Расширения PHP: GD, PHP XML, FreeType, Поддержка регулярных выражений (POSIX и Perl-compatible), Zlib compression, PHP-акселератор OPcache или XCache (рекомендуется), cURL (рекомендуется)
   • Apache 2.0 и выше (рекомендуется) или IIS (потребуется дополнительная настройка)
   • MySQL 5.6 и выше

Внимание. Перед установкой рекомендуем проверить корректность работы сайта и настройки системы с помощью штатных инструментов CMS. Для этого в системе администрирования сайтом 1С-Битрикс зайдите в Настройки → Инструменты → Проверка системы, вкладка "Тестирование конфигурации". Также проверьте права доступа на файлы и папки во вкладке "Проверка доступа", выбрав вариант "Полная проверка".

1. Купить модуль на сайте
2. Купить модуль в маркетплейсе 1С-Битрикс
3. Обратиться в компанию "Мибок" или к любому партнеру 1С-Битрикс

1. На странице "Система обновлений сторонних решений" (Marketplace → Обновление решений → Вкладка "Активация купона") введите купон, полученный при покупке. После чего во вкладке "Список обновлений" у вас появится модуль "Мибок: Версия для слабовидящих (модуль на сайт)" доступный для скачивания.
2. Загрузите модуль из Маркетплейс
3. Нажмите кнопку Установить
4. После стандартной установки модуля перейдите на страницу списка мастеров (Настройки → Настройки продукта → Список мастеров) и выберите мастер "Мибок: Версия для слабовидящих". Затем нажмите на "Установить" в контекстном меню выбранного мастера
   
5. В новом окне откроется приветственная страница мастера, являющаеся первым шагом мастера
   

   
   

6. На втором шаге необходимо выбрать сайт из существующих в системе, для которого необходимо произвести генерацию шаблонов
   

   
   

7. На третьем шаге необходимо выбрать шаблоны, для которых будет сгенерированы шаблоны для версии слабовидящих
   

   
   

8. На четвертом шаге необходимо заполнить поля (название сайта, контактные данные), которые будут отображаться в шапке и подвале сгенерированных шаблонов. Для ввода нескольких телефонов и/или email-адресов в качестве разделителя используйте запятую или точку с запятой (, или ;). В случае наличия добавочного номера - указывайте его в скобках.
   

   
   

9. На пятом шаге производится генерация шаблонов версии для слабовидящих, основанная на настройках, выбранных на предыдущих шагах.
10. После успешной генерации шаблонов на шестом шаге доступна ссылка для перехода на версию для слабовидящих.
    

    
    

1. Ссылки на справочную информацию: описание решения, инструкцию по настройке и установке, а также ознакомиться с развернутой демо-версией модуля.
2. Форма обратной связи для заказа доработки решения под Ваши нужды. Кнопка "Оставить заявку" отправит Вас на страницу с контактами дял связи и формой обратной связи
3. Форма создания запроса в службе технической поддержки. Кнопка "Создать обращение" отправит Вас на страницу службы поддержки. Ссылки на полезную информацию об оказываемых услугах.

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

1. Отключение/Включение использования адаптивной сетки на Bootstrap 3. Данная настройка будет работать для сайтов, которые написаны на Bootstrap 3 с использованием адаптивности.
2. Отключение/Включение вывода заголовка в теге H1 шаблона для слабовидящих. В некоторых сайтах, разработчики поместили тег H1 не в шаблон сайта, а на страницу — для таких сайтов и реализована данная настройка, чтобы не выводить несколько раз заголовок.
3. Подключение js-библиотеки для корректной работы на bitrix.gossite. Данная настройка требуется только для сайтов, разработанных на основе типового решения "1С-Битрикс: Официальный сайт государственной организаци" (bitrix.gossite)
4. Отключение/Включение озвучивания текста. При отключении данной опции на страницах сайта пропадут кнопки "Озвучить всё" и "Озвучить", а также соответствующие настройки по работе со звуком в панели настроек.
5. Отключение/Включение озвучивание действий в панели настроек (появилось с версии 3.3). При включенной опции переход как в версию для слабовидящих, так и в обычную версию сайта, а также все действия в панели настроек будут озвучиваться.
6. Дисковая квота (мегабайт). Определяет размер папки, в котором будут храниться уже озвученные тексты с вашего сайта (/upload/mibok.glaza/voice/), при достижении лимита будут удаляться наиболее старые файлы. По умолчанию установлено значение в 50 мегабайт.
7. Озвучить

   Максимальный размер отправляемого на синтез текста (килобайт). Определяет максимальный размер текста, который может быть отправлен на обработку для озвучивания на внешний ресурс. При достижении лимита пользователю вместо текста, будет проиграно сообщение об этом.
   По умолчанию установлено значение в 16 килобайт. Максимально допустимое значение - 50 килобайт (при введении в настройке большего значения, автоматически будет установлено максимальное допустимое значение)

8. Отключение/Включение отслеживания отличий в шаблонах. В некоторых случаях на сайте необходимо отключить возможность отслеживания изменений в шаблонах сайта обычной версии (см. подробнее о функционале отслеживания). При включении данной опции администратор сайта должны самостоятельно следить за тем, чтобы шаблон версии для слабовидящих был актуален.
9. Отключение/Включение композитного режима. При включении данной опции версия для слабовидящих отображается в обычном режиме, без использования композита.
10. Запрет индексации поисковиками страниц в версии для слабовидящих. При включении данной опции страницы в версии для слабовидящих станут недоступными для индексации поисковыми машинами. По умолчанию включено.
11. Разрешить языковую версию продукта. Отображается список доступных языковых версий модуля, которые можно подключить для использования в системе. По умолчанию, включен только русский язык.
    Примечания:
    
    • Данный функционал доступен, начиная с версии модуля 4.0.0. Если у Вас была сгенерирована версия для слабовидящих ранее, то для корректной работы функционала необходимо перегенерировать версию для слабовидящих
    • Если включен язык, то он становится доступным для сайтов, у которых в региональных настройках указан соответствующий язык либо при переходе по ссылке с get-параметром lang, например, ?lang=en. При отключении языка, языковая версия становится недоступной для использования.
    • На данный момент доступны следующие языки:
      • en - английский
      • ua - украинский
      • by - белорусский

Помимо установки модуля и корректировки его настроек, также вам необходимо отредактировать меню и разместить ссылку на версию для слабовидящих:

1. В шаблонах версии для слабовидящих добавлено дополнительное меню (.glazamibok.menu.php), в котором необходимо отредактировать пункты, с учетом реальных путей разделов "Обратная связь", "Карта сайта", "Поиск", "Авторизация" вашего сайта:
   
2. В шаблонах обычной версии сайта в шапке на видном месте, необходимо добавить ссылку, при переходе по которой будет открываться версия для слабовидящих - параметр в строке special_version=Y. Например, /?special_version=Y
   Рекомендуем для этих целей использовать специально подготовленный в поставке компонент Кнопка "Версия для слабовидящих" (mibok:special_link) с различными шаблонами отображения
   Здесь представлен специально разработанный набор кнопок для перехода на версию для слабовидящих, а также список вариантов шаблонов компонента mibok:special_link.

Если после перехода в версию для слабовидящих по адресу ваш_домен/?special_version=Y продолжает отображаться обычная версия сайта, необходимо изменить сортировку шаблонов. Для этого необходимо перейти на страницу Настройки → Настройки продукта → Сайты → Список сайтов → Страница сайта, на который установлен модуль → Блок "Шаблон сайта". В данном блоке отображается список шаблонов сайта и здесь необходимо расставить значение сортировки так, чтобы значение сортировки шаблона версии для слабовидящих было меньше, чем у соответствующего ему шаблона обычной версии:

Композитный режим сайта

На версиях Битрикс 18.0 и выше во включенном композитном режиме (особенно в режиме "Автокомпозит") может наблюдаться сбой отображения страниц. Если на сайте возникает такая проблема, зайдите в настройки модуля и отключите композитный режим в версии для слабовидящих (см. подробнее описание настроек модуля)

В обновлении 5.2.0 реализовано условие доступности нетекстовой информации и нетекстовых материалов согласно приказу Минкомсвязи России № 931 от 12.12.2022 «Об установлении Порядка обеспечения условий доступности для инвалидов по зрению официальных сайтов федеральных органов государственной власти, органов государственной власти субъектов Российской Федерации и органов местного самоуправления в сети "Интернет"».

На странице "Мибок → Мибок: Версия для слабовидящих (модуль на сайт) → Текстовые представления материалов" производится непосредственная работа с текстовыми представлениями документов.

Для начала работы необходимо добавить текстовые версии файлов. Обязательные поля отмечены «*». Возможно добавить текстовое представление как для файлов и ссылок, размещенных на сайте, так и для внешних ссылок.

Примечание. Добавить текстовые представления можно для следующих типов файлов:

• графические файлы, размещенные в виде картинок (тег <img>) на странице сайта (.png, .jpg, .jpeg, .gif, .webp);
• видеофайлы, размещенные как через тег <video> или <object> на странице сайта, так и с помощью компонента bitrix.player;
• аудиофайлы, размещенные как через тег <audio> или <object> на странице сайта, так и с помощью компонента bitrix.player;
• встроенные в страницы сайта документы, видео и интерактивные медиафайлы с других сайтов, оформленных тегами <iframe>, <embed>;
• ссылки на любые мультимедиафайлы, документы или другие сайты, оформленные тегом <a>.

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

Во время добавления представления файла текст можно обработать в визуальном редакторе Битрикс:

В работе с таблицей с текстовыми представлениями файлов доступен фильтр по всем столбцам:

Запись можно отредактировать отдельно или группой. Кроме того, каждую запись можно временно деактивировать, а неактивную активировать.

В публичной части сайта, ссылка на текстовое представление появляется автоматически, если создан элемент в таблице и если он активен:

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

Примечание. Так как в корневой папке создается новая страница для корректной работы блоков, которые должны работать на главной необходимо добавить код в footer.php и header.php шаблона сайта для слабовидящих.

В footer.php везде, где указан код:

<?if ($APPLICATION->GetCurDir() == '/'):?>

Необходимо добавить проверку на подключение новой страницы "slabovid_view.php". Для приведенного примера выше корректировка выглядит так:

<?if ($APPLICATION->GetCurDir() == '/' && $APPLICATION->GetCurPage() != '/slabovid_view.php')?>

В header.php в строке, где указан код:

<?if ($APPLICATION->GetCurDir() != '/' && COption::GetOptionString("mibok.glaza", "view_h1") == 'Y'){?>

Вместо текущей строки необходимо внести следующий код:

<?if ($APPLICATION->GetCurPage() == SITE_DIR . 'slabovid_view.php') 
$APPLICATION->ShowViewContent('filelink');?>
<?if (($APPLICATION->GetCurDir() != '/' && COption::GetOptionString("mibok.glaza", "view_h1") == 'Y') || ($APPLICATION->GetCurPage() == SITE_DIR . 'slabovid_view.php' && COption::GetOptionString("mibok.glaza", "view_h1") == 'Y')) {?>

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

• Разработчики в программном коде допустили ошибку, котоаря была незаметна в обычной версии сайта, но стала заметна в версии для слабовидящих
• Используется сторонний компонент, не входящий в стандартную поставку ядра Битрикс
• В шаблоне компонента в стандартной версии компонента вызываются другие компоненты (за исключением случаем комплексных компонент) или производится дополнительная обработка данных, выборка данных из базы данных.

Для каждой конкретной ситуации можно найти решение возникшей проблемы, обратившись в нашу техподдержку. Также вы можете сами решить некоторые из проблем, путем исключения вывода компонента или блока на странице.

Исключение компонент можно производить двумя способами:

1. Стандартный способ. Для того, чтобы компонент на странице не выполнялся достаточно перед его подключением добавить условие для шаблона версии для слабовидящих, например:

                   <?if (SITE_TEMPLATE_ID != 'special_mibok_new'):
                      $APPLICATION->IncludeComponent("bitrix:news.list", "slides", array(...), false);
                   endif;?>
               

   Данный способ подходит как для исключения компонент, так и для исключения любых других блоков, включая html-код.
2. Используя функционал исключения, реализованный в модуле. На странице "Управление исключениями" добавить запись:
   • Компонент (пространство_имен: название_компонента) - bitrix:news.list
   • Шаблон компонента - slides

   
   

На сложных и объемных проектах могут возникать следующие проблемы:

• Проблема: Некорректное отображение самописных компонент или смешанного кода (использующего и API Битрикса, и вывод на html одновременно).
  Решение: стилизовать вывод, используя подготовленные нами классы и обертки.
• Проблема: В настройках подключаемого компонента добавлен вывод служебных свойств, которые не должны выводиться, но в версии для слабовидящих все равно выводятся.
  Решение: Вручную в шаблоне компонента версии для слабовидящих убрать вывод этих служебных свойств.
• Проблема: В основной версии сайта есть шаблоны компонент, содержащие result_modifier.php и component_epilog.php, влияющие на выборку данных или вывод данных в шаблоне.
  Решение: Вручную скопировать эти файлы в соотв. шаблон компонента версии для слабовидящих и если необходимо отредактировать сам шаблон компонента (например, для вывода полученных данных в result_modifier.php).
• Проблема: Блоки служащие для визуального представления (например, баннеры) некорректно выводятся.
  Решение: Убрать их вывод в версии для слабовидящих, в версии для слабовидящих рекомендуется использовать минимальное количество графики.
• Проблема: Отсутствуют всплывающие, диалоговые окна (например, с веб-формами), которые есть на основной версии сайта.
  Решение: Здесь есть 2 пути решения
  1. добавить всплывающие формы в версию для слабовидящих (что не очень рекомендуется, т.к. излишний интерактив может усложнять восприятие сайта). Для этого необходимо добавить соотв. js-код и саму форму из основной версии сайта;
  2. создать разделы-дублеры, которые будут содержать эти формы и в версии для слабовидящих вместо вывода всплывающего окна - направлять на соотв. раздел (рекомендуемый способ).
• Проблема: Отсутствует вывод основного меню в шапке сайта
  Решение: Скорее всего основное меню или не типа "top", или подключение компонента происходит не напрямую в шаблоне сайта, а из файла. Необходимо вручную скопировать подключение компонента меню в шаблон версии для слабовидящих.
• Проблема: Главная страница сайта отображается пустой
  Решение: В некоторых случаях сайт разработан таким образом, что главная страница (файл index.php) не содержит никакой информации (текст, подключением компонент и т.д.), а весь контент расположен в шаблоне сайта (файлы header.php или footer.php). В таких случаях нужно поступить аналогичным образом и в версии для слабовидящих, т.е. вручную в шаблоне разместить код, отвечающий за подключение требуемого контента.

Модуль "Мибок: Версия для слабовидящих" остлеживает изменения, которые будут в дальнейшем производиться в обычных шаблонах сайта, речь идет о:

• изменении параметров покдлючения компонентов;
• новое подключение вызова компонент;
• удаление подключения вызова компонент

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

Данный стикер содержит ссылку на страницу "Перегенерация шаблонов". При переходе на эту страницу отображается информация, в каких шаблонах есть отличие в подключении компонент. Необходимо выбрать для какого шаблона обычного сайта необходимо перегенерировать шаблон версии для слабовидящих и нажать на кнопку "Сгенерировать":

Данная информация касается только тех веб-сайтов, на которых уже был ранее установлен модуль

• На странице "Система обновлений сторонних решений" (Marketplace → Обновление решений → Вкладка "Список обновлений") доступно обновление модуля:
  
• Нажмите кнопку "Загрузить"
• После удачной загрузки обновления, должен появиться стикер, содержащий ссылку для перегенерации (ссылка на страницу Настройки → Мибок: модуль для слабовидящих → Генерация):
  
• Перейдя на страницу "Генерация шаблонов", выберите шаблоны вашего сайта, которые нужно перегенерировать.
  
  Внимание! Теперь после перегенерации шаблонов, создается бекап старой версии шаблонов для версии слабовидящих (для возможности отката, а также во избежание правок в шаблонах, если вы их производили). Бекапы старых шаблонов находятся там же, где и лежат все шаблоны вашего сайта (/bitrix/templates/) и в своем названии содержат следующий префикс: backup_mibok_

Внимание! Любые изменения в сгенерированном шаблоне версии для слабовидящих вы должны делать аккуратно, чтобы не повредить работоспособность шаблона, а также отдавать себе отчет, что если вы в будущем захотите перегенерировать шаблон, все ваши изменения будут утеряны и останутся только в шаблоне с префиксом backup_mibok_

В редких случаях бывает необходимость подключать компонент в шаблоне сайта версии для слабовидящих так, чтобы при этом этот компонент не использовался в обычной версии сайта и не вызывал сообщения о перегенерации версии для слабовидящих. Для этого, при подключении компонента необходимо в массив параметров подключаемого компонента прописать следующий параметр: "MIBOK_SPECIAL_COMPARE" => "N"

Рассмотрим одну из нетипичных ситуаций.
На сайте уровень вложенности меню больше двух. Третий и более уровень вложенности меню в версии для слабовидящих не отображается по причине неудобства использования такого меню лицам с ограниченными возможностями. Однако, необходимо осуществить возможность у пользователя использовать меню третьей вложенности. Для решения проблемы с навигацией требуется подключить вывод меню нужной вложенности (например, третьей вложенности) в шаблоне сайта.

Внимание! Описанные ниже действия не нужно производить, если у вас в обычной версии сайта подключается дополнительный вывод меню 3-й вложенности еще и как отдельный блок меню. Как например, тут:

Например, меню 3-го уровня имеет тип "left" и его нужно разместить после заголовка h1. Тогда размещаем в шаблоне версии для слабовидящих следующий код:

 <?$APPLICATION->IncludeComponent("bitrix:menu", ".default", Array("ROOT_MENU_TYPE"	=>	"left",
                "MENU_CACHE_TYPE"	=>	"A",
                "MENU_CACHE_TIME"	=>	"3600",
                "MENU_CACHE_USE_GROUPS"	=>	"Y",
                "MENU_CACHE_GET_VARS"	=>	"",
                "MAX_LEVEL"	=>	"2",
                "CHILD_MENU_TYPE"	=>	"left",
                "USE_EXT"	=>	"Y",
                "DELAY"	=>	"N",
                "ALLOW_MULTI_SELECT"	=>	"Y",
                "MIBOK_SPECIAL_COMPARE" => "N"));?>
            

В итоге, должно получиться так:

После чего, в версии для слабовидящих в тех разделах, в которых расположено меню "left" оно будет выводиться после заголовка:

Таким образом можно организовать вывод меню третьего, четвертого и других уровней вложенности (однако, нужно понимать, что такие уровни вложенности не являются нормальным для использования даже для обычных пользователей и вам следует пересмотреть структуру своего сайта в сторону оптимизации). Также, с помощью параметра MIBOK_SPECIAL_COMPARE можно отображать прочие элементы, отсутствующие в обычной версии сайта.

В шаблонах версии для слабовидящих сознательно убрана возможность "кликабельности" верхних пунктов меню, при условии если они содержат подуровни. Это реализовано для повышения удобности использования меню с помощью клавиатуры. Однако, в некоторых случаях, необходимо, чтобы все-таки эти пункты меню были "кликабельны".

Внимание! Любые изменения в сгенерированном шаблоне версии для слабовидящих вы должны делать аккуратно, чтобы не повредить работоспособность шаблона, а также отдавать себе отчет, что если вы в будущем захотите перегенерировать шаблон, все ваши изменения будут утеряны и останутся только в шаблоне с префиксом backup_mibok_

Если все-таки вам нужен такой функционал и вы готовы пренебречь некоторой удобностью использования меню с клавиатуры, то вам необходимо сделать следующее: зайти во всем шаблоны меню, и в ветке "если пункт меню является родителем" убрать у ссылки атрибут data-toggle:
В итоге должно получиться так:
Сделать это нужно во всех шаблонах меню, которые сгенерировались на сайте. И конечно, потом сбросить кеш сайта

Начиная с версии модуля 2.4 в сгенерированных шаблонах доступен специальный файл стилей css/custom.css и файл скриптов js/custom.js. Данные файлы уже подключены в шаблоне и в них можно размещать все необходимые стили и скрипты, не боясь, что обновение модуля может их "перезатереть".