plugin:pagelist
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | |||
plugin:pagelist [2024-05-04 10:32] – removed 47.62.248.59 | plugin:pagelist [2024-05-04 11:07] (current) – old revision restored (2023-08-27 23:50) Aleksandr | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== PageList Plugin ====== | ||
+ | |||
+ | ---- plugin ---- | ||
+ | description: | ||
+ | author | ||
+ | email : freaks@dokuwiki.org | ||
+ | type : syntax, helper | ||
+ | lastupdate : 2023-08-27 | ||
+ | compatible : Rincewind, Adora Belle, Weatherwax, Binky, Ponder Stibbons, Hrun, Detritus, Frusterick Manners, Greebo, Hogfather, Igor, Jack Jackrum | ||
+ | depends | ||
+ | conflicts | ||
+ | similar | ||
+ | tags : formatting, list, tables, page | ||
+ | |||
+ | downloadurl: | ||
+ | sourcerepo : https:// | ||
+ | bugtracker : https:// | ||
+ | donationurl: | ||
+ | ---- | ||
+ | |||
+ | > **Update note**: In August 2023 the css styling is changed a bit. The specific styles for each cell are replaced by more general styles. Also all styles, except '' | ||
+ | |||
+ | ===== Description ===== | ||
+ | |||
+ | The Pagelist Plugin takes a list of wiki pages and provides a nicely formatted table with information about them. The plug-in has a number of flags that can be used to control the information and format of the page list. The user can provide a list of specific page references as can some popular helper plugins such the [[Blog]], [[Discussion]], | ||
+ | |||
+ | ===== Syntax ===== | ||
+ | |||
+ | Just wrap a regular unordered list of internal links with the '' | ||
+ | |||
+ | < | ||
+ | * [[..: | ||
+ | * [[..: | ||
+ | * [[..: | ||
+ | * [[..: | ||
+ | * [[..: | ||
+ | </ | ||
+ | |||
+ | ^ [flags] | ||
+ | |||
+ | ==== Flags ==== | ||
+ | |||
+ | ^ Default flag |^ Alternative flag |^ Setting in\\ [[plugin: | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ | if only '' | ||
+ | ^ '' | ||
+ | |||
+ | |||
+ | |||
+ | The '' | ||
+ | |||
+ | ==== Example ==== | ||
+ | |||
+ | < | ||
+ | //an unordered list of pages to display// | ||
+ | </ | ||
+ | |||
+ | In the example above, pagelist will display information about the provided pages in a table with a header line and a comments column (if the [[plugin: | ||
+ | |||
+ | ===== Configuration ===== | ||
+ | The plugin can be configured using the DokuWiki configuration manager available in the admin menu. The settings also apply to plugins which use the helper component of the pagelist plugin, like for example the archive component of the [[plugin: | ||
+ | |||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | ^ '' | ||
+ | |||
+ | ===== Helper Plugin ===== | ||
+ | |||
+ | You can easily use the functionality of the Pagelist Plugin in your own plugins. Here is a basic code snippet: | ||
+ | |||
+ | <code php> | ||
+ | $pages = [ | ||
+ | [' | ||
+ | [' | ||
+ | ]; | ||
+ | $pagelist = $this-> | ||
+ | if (!$pagelist) return false; // failed to load plugin | ||
+ | $pagelist-> | ||
+ | foreach ($pages as $page){ | ||
+ | $pagelist-> | ||
+ | } | ||
+ | $renderer-> | ||
+ | </ | ||
+ | |||
+ | Since release '' | ||
+ | |||
+ | <code php> | ||
+ | $pagelist-> | ||
+ | </ | ||
+ | |||
+ | For more details, see [[plugin: | ||
+ | |||
+ | ===== Bugs / Feature Requests ===== | ||
+ | |||
+ | Please report bugs or feature requests at the [[https:// | ||
+ | |||
+ | |||
+ | |||
+ | ===== Changes ===== | ||
+ | |||
+ | {{rss> | ||
+ | |||
+ | ===== Localization ===== | ||
+ | Submit translation via the translation tool: https:// | ||
+ | |||
+ | |||
+ | |||
+ | |||
plugin/pagelist.txt · Last modified: 2024-05-04 11:07 by Aleksandr