Differences

This shows you the differences between two versions of the page.

--- plugin:pagelist [2023-08-14 14:39] – [PageList Plugin] Updated compatibility: Seems to work fine on Jack Jackrum fiwswe
+++ plugin:pagelist [2024-05-04 11:07] (current) – old revision restored (2023-08-27 23:50) Aleksandr
@@ Line 6: / Line 6: @@
 email      : freaks@dokuwiki.org
 type       : syntax, helper
-lastupdate : 2023-07-12
+lastupdate : 2023-08-27
 compatible : Rincewind, Adora Belle, Weatherwax, Binky, Ponder Stibbons, Hrun, Detritus, Frusterick Manners, Greebo, Hogfather, Igor, Jack Jackrum
 depends    :
@@ Line 18: / Line 18: @@
 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 ''simplelist'', got an additional class ''plgn__pglist'' to target better this plugin with your own styling.
 ===== Description =====
@@ Line 39: / Line 41: @@
 ==== Flags ====
-^ Default flag                                                  |^ Alternative flag                                                                                                                                                    |^ Setting in\\ [[plugin:config|Config Manager]]  ^
+^ Default flag                                                      |^ Alternative flag                                                                                                                                                    |^ Setting in\\ [[plugin:config|Config Manager]]  ^
-^ ''default''     | table with horizontal lines                  ^ ''table'', ''list'' or ''simplelist''  | standard DokuWiki table or list style                                                                                       | ''style''                                      |
+^ ''default''     | table with horizontal lines                      ^ ''table'', ''list'' or ''simplelist''  | standard DokuWiki table or list style                                                                                       | ''style''                                      |
-^ ''firsthl''     | show the first headline                      ^ ''nofirsthl''                          | show the page name                                                                                                          | ''showfirsthl''                                |
+^ ''noheader''    | hide the heading row of the pagelist table       ^ ''header''                             | show the header                                                                                                             | ''showheader''                                 |
-^ ''date''        | show the creation or last modification date  ^ ''nodate''                             | hide the date                                                                                                               | ''showdate''                                   |
+^ ''firsthl''     | show the first headline                          ^ ''nofirsthl''                          | show the page name                                                                                                          | ''showfirsthl''                                |
-^ ''user''        | show creator or contributors                 ^ ''nouser''                             | hide the user                                                                                                               | ''showuser''                                   |
+^ ''date''        | show the creation or last modification date      ^ ''nodate''                             | hide the date                                                                                                               | ''showdate''                                   |
-^ ''noheader''    | hide the heading row of the pagelist table   ^ ''header''                             | show the header                                                                                                             | ''showheader''                                 |
+^ ''user''        | show creator or contributors                     ^ ''nouser''                             | hide the user                                                                                                               | ''showuser''                                   |
-^ ''nodesc''      | hide the description                         ^ ''desc''                               | show the description (from metadata)                                                                                        | ''showdesc''                                   |
+^ ''nodesc''      | hide the description                             ^ ''desc''                               | show the description (from metadata)                                                                                        | ''showdesc''                                   |
-^ ''nocomments''  | hide the number of comments                  ^ ''comments''                           | show the number of comments (if [[discussion|Discussion Plugin]] is installed)                                              | ''showcomments''                               |
+^ ''nodiff''      | no displaying of differences column              ^ ''showdiff''                           | displays the differences column with the diff icon linking to the corresponding diff page for each row                      | ''showdiff''                                   |
-^ ''notags''      | hide the tags                                ^ ''tags''                               | show the tags (if [[tag|Tag Plugin]] is installed)                                                                          | ''showtags''                                   |
+^ ''nosummary''   | no summary of last edit                          ^ ''summary''                            | show summary of the last page edit                                                                                          | no setting                                     |
-^ ''nosort''      | no sortation of pages                        ^ ''rsort/sort''                         | sorts the pages (reverse) alphabetically by pagename                                                                        | ''rsort/sort''                                 |
+^ ''nocomments''  | hide the number of comments                      ^ ''comments''                           | show the number of comments (if [[discussion|Discussion Plugin]] is installed)                                              | ''showcomments''                               |
-^ ''nodiff''      | no displaying of differences column          ^ ''showdiff''                           | displays the differences column with the diff icon linking to the corresponding diff page for each row                      | ''showdiff''                                   |
+^ ''notags''      | hide the tags                                    ^ ''tags''                               | show the tags (if [[tag|Tag Plugin]] is installed)                                                                          | ''showtags''                                   |
-^ ''noimage''     | show image of the page                       ^ ''image''                              | needs [[pageimage|Pageimage Plugin]] installed. Can either be defined on page or image with same name as page will be used  | ''image''                                      |
+^ ''noimage''     | show image of the page                           ^ ''image''                              | needs [[pageimage|Pageimage Plugin]] installed. Can either be defined on page or image with same name as page will be used  | ''showimage''                                  |
+^ ''nosort''      | no sortation of pages                            ^ ''rsort/sort''                         | sorts the pages (reverse) alphabetically by pagename                                                                        | ''rsort/sort''                                 |
+^                 | if only ''sort'' is set it will sorts by ''id''  ^ ''sortby=<property>''                  | sort by the requested property. Info should be provided with ''addPage()'' or some info can be retrieved form metadata.     | ''sortby''                                     |
+^ ''limit=0''     | list all given entries                           ^ ''limit=<number>''                     | Limits the number of entries to <number>. 0 = list all given items.                                                         | no setting                                     |
+The ''sortby=<property>'' flag uses the info directly from the data supplied (e.g. if used in another plugin), or tries to compile or retrieve it from metadata. It sorts default by ''id''. Next to the column names as used internally in the provided data, you can use ''pagename'' for using only the pagename part of the ''id'' thus ignoring the namespace part, or ''ns'' for sorting pages before equal named namespaces. ''title'' uses the first headline of a page. Other property names are: ''date'', ''user'', ''desc'', ''summary'', and if the respectively plugin is available: ''comments'', ''linkbacks'', ''tags'' and ''image''. If called in other plugins these can eventually add their own columns as well.
 ==== Example ====
@@ Line 65: / Line 74: @@
 ^ ''style'' | List style (default, table, table/list, simplelist) |
 ^ ''showheader'' | Show table header |
+^ ''showfirsthl''| Show the first headline instead of the page name |
 ^ ''showdate'' | Shows/hides the date column (hide, creation date, modification date) |
 ^ ''showuser'' | Shows/hides the user column (hide, creator, contributors) |
 ^ ''showdesc'' | Shows/hides a short description taken from the first paragraph of a page (hide, max. 160 characters, max. 500 characters) |
+^ ''showdiff'' | Displays a differences column with the diff icon linking to the corresponding diff page for each row |
 ^ ''showcomments'' | Shows/hides comments of a page (requires the [[plugin:discussion]] plugin) |
 ^ ''showlinkbacks'' | Shows/hides linkbacks of a page (requires the [[plugin:linkback]] plugin) |
 ^ ''showtags'' | Shows/hides tags of a page (requires the [[plugin:tag]] plugin) |
+^ ''showimage'' | Shows/hides the image column (requires the [[pageimage|Pageimage Plugin]]) |
 ^ ''sort''     | Sorts the pages alphabetically by pagename |
-^ ''showdiff'' | Displays a differences column with the diff icon linking to the corresponding diff page for each row |
+^ ''sortby''   | Sort the page by the given property, e.g. ''id'', ''pagename'', ''ns'', ''title'', ''date'', ''desc'', ''user'' etc or columns from plugins |
-^ ''showimage'' | Shows/hides the image column (requires the [[pageimage|Pageimage Plugin]]) |
 ===== Helper Plugin =====