Содержание
PageList для «ДокуВики»
Перечисляет страницы в красивой таблице или неупорядоченном списке. Плагин Pagelist берет список вики-страниц и предоставляет красиво отформатированную таблицу с информацией о них. Плагин имеет ряд флагов, которые можно использовать для управления информацией и форматом списка страниц. Пользователь может предоставить список ссылок на конкретные страницы, а также некоторые популярные вспомогательные плагины, такие как плагины «Блог », «Обсуждение» , «Редактор », «Тег» , «Задача» и «Директор» .
- Релиз: 2023-07-12.
- Репозиторий:https://github.com/dokufreaks/plugin-pagelist
- Совместимость с «Докувики»: 04.04.2023 «Джек Джекрам»
Совместимость
Сообщайте об ошибках или просьбах о новых функциях в системе отслеживания ошибок
Примечание по обновлению : в августе 2023 года стиль CSS немного изменился. Конкретные стили для каждой ячейки заменяются более общими стилями. Также все стили, кроме simplelist, получили дополнительный класс plgn__pglist, позволяющий лучше настроить этот плагин с помощью вашего собственного стиля.
Монтаж
Используйте менеджер плагинов для установки или…
- скачать zip-файл
- распаковать его в<dokuwiki>/lib/plugins/
- войдите как администратор и измените плагин в менеджере конфигурации
Применение
Просто оберните тегом обычный неупорядоченный список внутренних ссылок <pagelist>. Вы можете предоставить конкретные внутренние ссылки на страницы или попросить плагины предоставить их, как показано в примере ниже:
<pagelist&[флаги]> * [[..:blog:|Плагин блога]] * [[..:discussion:|Плагин обсуждения]] * [[..:editor:|Плагин редактора]] * [[.. :tag:|Плагин тега]] * [[..:wrap|Плагин переноса|Это показано в ячейке описания]] </pagelist>
| [флаги] | флаги можно использовать для изменения внешнего вида списка страниц, флаги | необязательный |
Флаги
| Флаг по умолчанию | Альтернативный флаг | Настройка в диспетчере конфигураций | ||
|---|---|---|---|---|
| default | таблица с горизонтальными линиями | table, list или simplelist | стандартный стиль таблицы или списка «ДокуВики» | style |
| firsthl | покажи первый заголовок | nofirsthl | покажи название страницы | showfirsthl |
| date | показать дату создания или последней модификации | nodate | скрыть дату | showdate |
| user | создатель шоу или участники nouser скрыть пользователя | showuser | ||
| noheader | скрыть строку заголовка таблицы списка страниц | header | покажи заголовок | showheader |
| nodesc | скрыть описание | desc | показать описание (из метаданных) | showdesc |
| nocomments | скрыть количество комментариев | comments | показать количество комментариев (если установлен дискуссионный плагин ) | showcomments |
| notags | скрыть теги tags показывать теги (если установлен плагин тегов ) | showtags | ||
| nosort | нет сортировки страниц | rsort/sort | сортирует страницы (в обратном порядке) в алфавитном порядке по имени страницы | rsort/sort |
| nodiff | нет отображения столбца различий | showdiff | отображает столбец различий со значком различий, ссылающимся на соответствующую страницу различий для каждой строки | showdiff |
| noimage | показать изображение страницы | image | требуется установленный плагин Pageimage . Может быть определено на странице или будет использовано изображение с тем же именем, что и страница. | showimage |
<pagelist&default&nodate&nouser&sort> * [[wiki:plugin:backuptool:|]] * [[wiki:plugin:autotooltip:|]] * [[wiki:plugin:codeprettify:|]] * [[wiki:plugin:citations:|]] * [[wiki:plugin:cookiebanner|]] </pagelist>
В приведенном выше примере список страниц будет отображать информацию о предоставленных страницах в таблице со строкой заголовка и столбцом комментариев (если установлен плагин обсуждений ). Пользователь (или плагин) должен указать конкретные страницы для отображения в списке.
Конфигурация и настройки
Плагин можно настроить с помощью менеджера конфигурации DokuWiki, доступного в меню администратора. Эти настройки также применяются к плагинам, которые используют вспомогательный компонент плагина списка страниц, например, архивный компонент плагина блога .
| style | Стиль списка (по умолчанию, таблица, таблица/список, простой список) |
| showheader | Показать заголовок таблицы |
| showdate | Показывает/скрывает столбец даты (скрыть, дата создания, дата изменения) |
| showuser | Показывает/скрывает столбец пользователя (скрыть, создатель, участники) |
| showdesc | Показывает/скрывает краткое описание, взятое из первого абзаца страницы (скрыть, максимум 160 символов, максимум 500 символов) |
| showcomments | Показывает/скрывает комментарии страницы (требуется плагин обсуждения ) |
| showlinkbacks | Показывает/скрывает обратные ссылки на странице (требуется плагин обратных ссылок ) |
| showtags | Показывает/скрывает теги страницы (требуется плагин тегов ) |
| sort | Сортирует страницы в алфавитном порядке по имени страницы. |
| showdiff | Отображает столбец различий со значком различий, ссылающимся на соответствующую страницу различий для каждой строки. |
| showimage | Показывает/скрывает столбец изображения (требуется плагин Pageimage ). |
Вспомогательный плагин
Вы можете легко использовать функциональность плагина Pagelist в своих собственных плагинах. Вот базовый фрагмент кода:
$pages = [ ['id' => 'wiki:dokuwiki'], ['id' => 'wiki:syntax'], ]; $pagelist = $this->loadHelper('pagelist'); if (!$pagelist) return false; // failed to load plugin $pagelist->startList(); foreach ($pages as $page){ $pagelist->addPage($page); } $renderer->doc .= $pagelist->finishList();
С момента выпуска 2017-08-24 функция startList() имеет дополнительный параметр для указания класса CSS для добавления его в класс элемента таблицы:
$pagelist->startList('myclass');
Подробнее см. в разделе «Как использовать Pagelist в вашем плагине» .
Обновление
Для обновления удалите исходную папку lib/plugins/displaywikipage и установите новую версию, как указано выше.
Файл для загрузки
Лицензия
- License: GNU GPL v2
Это не обязательно, но, пожалуйста, рассмотрите возможность ссылки на эту страницу с вашего сайта, если вам нравится этот продукт.
Обсуждение