WT View PDF

Описание

WT View PDF — бесплатный контентный плагин для просмотра PDF на сайте Joomla. Он заменяет шорткод в тексте встроенным документом или кнопкой, которая открывает PDF в модальном окне. Для вывода можно использовать просмотрщик браузера через HTML5 <object> либо JavaScript-библиотеку PDF.js.

Шесть макетов для просмотра PDF

• html5object — встроенный просмотрщик браузера. Отдельная библиотека PDF.js не требуется; возможности интерфейса зависят от браузера.
• default — вывод страниц PDF прямо в тексте через PDF.js.
• bootstrap-modal — кнопка, которая открывает документ в модальном окне Bootstrap 5.
• uikit-modal — кнопка и модальное окно UIkit 3.
• bootstrap-pdfjs-preload — полный просмотрщик PDF.js с прелоадером и оформлением Bootstrap 5.
• uikit-pdfjs-preload — полный просмотрщик PDF.js с прелоадером и оформлением UIkit 3.

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

Как вставить PDF в материал Joomla

1. Установите WT View PDF и убедитесь, что контентный плагин включён.
2. Загрузите PDF на сайт, например в каталог images.
3. Укажите путь к файлу относительно корня сайта в шорткоде и выберите макет параметром tmpl.

{ PDF tmpl=html5object}images/document.pdf{/PDF}

В примере оставлен пробел после открывающей фигурной скобки, чтобы сайт показывал код. Перед использованием уберите этот пробел. Если параметр tmpl отсутствует или файл указанного макета не найден, применяется макет, выбранный в настройках плагина.

В Joomla-компонентах шорткод работает там, где текст обрабатывается контентными плагинами. Разработчики могут добавить свой файл макета в plugins/content/wtviewpdf/tmpl и указать его имя без расширения в tmpl.

Зависимости и требования

Минимальные требования установщика: Joomla 5.0 и PHP 8.1. Учитывайте также требования установленной версии Joomla.

Для макетов на PDF.js установите и включите WT PDF.js. Макетам с прелоадером нужен пакет с полными локальными просмотрщиками modern и legacy: одного подключения библиотеки с CDN недостаточно. Переключатель поддержки старых браузеров выбирает сборку PDF.js.

Шаблон сайта должен подключать CSS Bootstrap 5 или UIkit 3 для соответствующего макета. Макеты с прелоадером не требуют JavaScript этих фреймворков. Модальные макеты используют JavaScript соответствующего фреймворка для открытия окна.

Настройки просмотрщика PDF.js

В обоих макетах с прелоадером можно задать тему, начальный масштаб и другие параметры полного просмотрщика через файл media/plg_system_wtpdfjs-config/default.json. Например:

{
    "viewerCssTheme": 2,
    "defaultZoomValue": "page-width",
    "sidebarViewOnLoad": 0
}

Профиль должен быть корректным JSON-объектом без комментариев. Его параметры применяются при новом открытии просмотрщика; история просмотра документа также может влиять на начальное состояние. Подробности — в инструкции по JSON-конфигам WT PDF.js. Библиотечные макеты default, bootstrap-modal и uikit-modal эти профили не читают.

Вопросы о просмотре PDF

Нужен ли WT PDF.js для HTML5 object?

Нет. Макет html5object передаёт документ встроенному просмотрщику браузера. Для остальных макетов используется PDF.js.

Нужно ли ждать загрузки всего файла?

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

Что произойдёт, если просмотрщик не откроется?

В макетах с прелоадером остаётся ссылка на скачивание PDF: при ошибке, недоступном просмотрщике или отключённом JavaScript.

Демо

Кнопка Bootstrap 5

PDF внутри страницы: HTML5 object

Просмотрщик PDF.js с прелоадером