Различия

Показаны различия между двумя версиями страницы.

--- wiki:plugin:pagelist [2023/08/30 10:59] – внешнее изменение 127.0.0.1
+++ wiki:plugin:pagelist [Дата неизвестна] (текущий) – внешнее изменение (Дата неизвестна) 127.0.0.1
@@ Строка 9: / Строка 9: @@
 Сообщайте об ошибках или просьбах о новых функциях в [[https://github.com/dokufreaks/plugin-pagelist/issues|системе отслеживания ошибок]]
+**Примечание по обновлению** : в августе 2023 года стиль CSS немного изменился. Конкретные стили для каждой ячейки заменяются более общими стилями. Также все стили, кроме **simplelist**, получили дополнительный класс **plgn__pglist**, позволяющий лучше настроить этот плагин с помощью вашего собственного стиля.
 =====Монтаж=====
@@ Строка 35: / Строка 37: @@
 {{tablelayout?rowsHeaderSource=Auto&colwidth=""}}
-^Флаг по умолчанию^^Альтернативный флаг^^Настройка в диспетчере конфигураций^
+^ Флаг по умолчанию                                                                     |^ Альтернативный флаг                                                                                                                                                            |^ Настройка в диспетчере конфигураций  ^
-|default|	таблица с горизонтальными линиями	|table, list или simplelist|	стандартный стиль таблицы или списка «ДокуВики»	|style|
+| default            | таблица с горизонтальными линиями                                 | table, list или simplelist  | стандартный стиль таблицы или списка «ДокуВики»                                                                                                   | style                                |
-|firsthl|	покажи первый заголовок	|nofirsthl|	покажи название страницы	|showfirsthl|
+| firsthl            | покажи первый заголовок                                           | nofirsthl                   | покажи название страницы                                                                                                                          | showfirsthl                          |
-|date|	показать дату создания или последней модификации	|nodate|	скрыть дату	|showdate|
+| date               | показать дату создания или последней модификации                  | nodate                      | скрыть дату                                                                                                                                       | showdate                             |
-|user|	создатель шоу или участники	nouser	скрыть пользователя	|showuser|
+| user               | создатель шоу или участники	nouser	скрыть пользователя            | showuser                    |                                                                                                                                                   |                                      |
-|noheader|	скрыть строку заголовка таблицы списка страниц	|header|	покажи заголовок	|showheader|
+| noheader           | скрыть строку заголовка таблицы списка страниц                    | header                      | покажи заголовок                                                                                                                                  | showheader                           |
-|nodesc|	скрыть описание	|desc|	показать описание (из метаданных)	|showdesc|
+| nodesc             | скрыть описание                                                   | desc                        | показать описание (из метаданных)                                                                                                                 | showdesc                             |
-|nocomments|	скрыть количество комментариев	|comments|	показать количество комментариев (если установлен дискуссионный плагин )	|showcomments|
+| nocomments         | скрыть количество комментариев                                    | comments                    | показать количество комментариев (если установлен дискуссионный плагин )                                                                          | showcomments                         |
-|notags|	скрыть теги	tags	показывать теги (если установлен плагин тегов )	|showtags|
+| notags             | скрыть теги	tags	показывать теги (если установлен плагин тегов )  | showtags                    |                                                                                                                                                   |                                      |
-|nosort|	нет сортировки страниц	|rsort/sort|	сортирует страницы (в обратном порядке) в алфавитном порядке по имени страницы	|rsort/sort|
+| nosort             | нет сортировки страниц                                            | rsort/sort                  | сортирует страницы (в обратном порядке) в алфавитном порядке по имени страницы                                                                    | rsort/sort                           |
-|nodiff|	нет отображения столбца различий	|showdiff|	отображает столбец различий со значком различий, ссылающимся на соответствующую страницу различий для каждой строки	|showdiff|
+| nodiff             | нет отображения столбца различий                                  | showdiff                    | отображает столбец различий со значком различий, ссылающимся на соответствующую страницу различий для каждой строки                               | showdiff                             |
-|noimage|	показать изображение страницы	|image|	требуется установленный плагин Pageimage . Может быть определено на странице или будет использовано изображение с тем же именем, что и страница.	|showimage|
+| noimage            | показать изображение страницы                                     | image                       | требуется установленный плагин Pageimage . Может быть определено на странице или будет использовано изображение с тем же именем, что и страница.  | showimage                            |
@@ Строка 65: / Строка 67: @@
   * [[wiki:plugin:cookiebanner|]]
 </pagelist>
+В приведенном выше примере список страниц будет отображать информацию о предоставленных страницах в таблице со строкой заголовка и столбцом комментариев (если установлен плагин обсуждений ). Пользователь (или плагин) должен указать конкретные страницы для отображения в списке.
 ===== Конфигурация и настройки =====
+Плагин можно настроить с помощью менеджера конфигурации DokuWiki, доступного в меню администратора. Эти настройки также применяются к плагинам, которые используют вспомогательный компонент плагина списка страниц, например, архивный компонент плагина блога .
+|style|Стиль списка (по умолчанию, таблица, таблица/список, простой список)|
+|showheader|Показать заголовок таблицы|
+|showdate|Показывает/скрывает столбец даты (скрыть, дата создания, дата изменения)|
+|showuser|Показывает/скрывает столбец пользователя (скрыть, создатель, участники)|
+|showdesc|Показывает/скрывает краткое описание, взятое из первого абзаца страницы (скрыть, максимум 160 символов, максимум 500 символов)|
+|showcomments|Показывает/скрывает комментарии страницы (требуется плагин  [[https://www.dokuwiki.org/plugin:discussion|обсуждения]] )|
+|showlinkbacks|Показывает/скрывает обратные ссылки на странице (требуется плагин обратных ссылок )|
+|showtags|Показывает/скрывает теги страницы (требуется плагин тегов )|
+|sort|Сортирует страницы в алфавитном порядке по имени страницы.|
+|showdiff|Отображает столбец различий со значком различий, ссылающимся на соответствующую страницу различий для каждой строки.|
+|showimage|Показывает/скрывает столбец изображения (требуется плагин [[https://www.dokuwiki.org/plugin:pageimage|Pageimage]] ).|
+=====Вспомогательный плагин=====
+Вы можете легко использовать функциональность плагина Pagelist в своих собственных плагинах. Вот базовый фрагмент кода:
+<code php>
+$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();
+</code>
+С момента выпуска 2017-08-24 функция startList() имеет дополнительный параметр для указания класса CSS для добавления его в класс элемента таблицы:
+<code php>
+$pagelist->startList('myclass');
+</code>
+Подробнее см. в разделе [[wiki:plugin:pagelist_development|«Как использовать Pagelist в вашем плагине»]] .
 =====Обновление=====
 Для обновления удалите исходную папку lib/plugins/displaywikipage и установите новую версию, как указано выше.
 =====Файл для загрузки=====
-{{ :wiki:plugin:htmlmetatags-master.zip |}}
+{{ :wiki:plugin:plugin-pagelist-master.zip |}}
 =====Лицензия=====
-  * **Author:** [[info@soft2c.de|Soft2C.de]]
+  * **Author:** [[freaks@dokuwiki.org|Dokufreaks (previous authors: Matthias Schulte, Michael Hamann, Esther Brunner, Gina Häußge, Michael Klier)]]
   * **License:** [[http://www.opensource.org/licenses/gpl-license.php|GNU GPL v2]]
-Это не обязательно, но, пожалуйста, рассмотрите возможность ссылки на [[https://www.dokuwiki.org/plugin:htmlmetatags#htmlmetatags_plugin|эту страницу]] с вашего сайта, если вам нравится этот продукт.
+Это не обязательно, но, пожалуйста, рассмотрите возможность ссылки на [[https://www.dokuwiki.org/plugin:pagelist#pagelist_plugin|эту страницу]] с вашего сайта, если вам нравится этот продукт.