DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:changes

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:changes [2016-11-18 08:11] – Translation Accuracy 40.76.203.95plugin:changes [2024-02-06 08:06] (current) – [Output renderer] Aleksandr
Line 2: Line 2:
    
 ---- plugin ---- ---- plugin ----
-description: List the most recent changes of the wiki+description: List the most recently changed pages and media-files of the wiki
 author     : Andreas Gohr author     : Andreas Gohr
 email      : dokuwiki@cosmocode.de email      : dokuwiki@cosmocode.de
 type       : syntax type       : syntax
-lastupdate : 2016-01-24 +lastupdate : 2023-12-14 
-compatible : 2008-05-05LemmingAnteaterRincewindAnguaAdora Belle, Weatherwax, Binky,Ponder Stibbons, Hrun, Detrius, Elenor Of Tsort+compatible : Elenor Of TsortFrusterick MannersGreeboHogfatherIgorJack Jackrum
 depends    :  depends    : 
 conflicts  conflicts 
Line 18: Line 18:
 ---- ----
  
-This plugin allows you to embed list of recent changes as a simple list into any page.+This plugin allows you to embed the list of recent changes as a simple list into any page.
  
 ===== Download and Installation ===== ===== Download and Installation =====
-[[http://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ http://cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]+ 
 +[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ https://www.cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]
  
 Download and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually. Download and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
Line 31: Line 32:
   {{changes>}}   {{changes>}}
  
-Optionally you can specify a number of parameters that control the scope of the shown changes and the way the list is rendered. By default plugin shows the changes in the entire wiki. To restrict the list of changes to a given namespace and its sub-namespaces you can specify its name either directly or using ''ns'' parameter:+Optionally you can specify a number of parameters that control the scope of the shown changes and the way the list is rendered. 
 + 
 +:!: The plugin always displays only the most recent change for every page / media file! 
 + 
 +==== Allowlist/blocklist by namespace ==== 
 +By default plugin shows the changes in the entire wiki. To restrict the list of changes to a given namespace and its sub-namespaces you can specify its name either directly or using ''ns'' parameter:
  
   {{changes>foo}}   {{changes>foo}}
Line 42: Line 48:
  
 The first example will show the changes in all namespaces except of "foo", the second one will include "foo" and "bar" namespaces except of "bar:baz" sub-namespace. The first example will show the changes in all namespaces except of "foo", the second one will include "foo" and "bar" namespaces except of "bar:baz" sub-namespace.
 +
 +You can also exclude specific pages:
 +  {{changes>foo&excludedpages=bar}}
 +
 +==== Number of changes displayed ====
  
 The number of changes that are presented in the list is controlled with ''count'' parameter (defaults to 10). The count can also be specified as just a number: The number of changes that are presented in the list is controlled with ''count'' parameter (defaults to 10). The count can also be specified as just a number:
Line 47: Line 58:
   {{changes>15}}   {{changes>15}}
   {{changes>count=15}}   {{changes>count=15}}
 +
 +==== Type(s) of changes displayed ====
  
 It is also possible to control the type of changes shown in the list. By default all types are shown but with ''type'' parameter you can restrict the shown changes to a given type. The supported types are ''create'', ''edit'', ''minor'' and ''delete''. Multiple types can be specified separated by a comma: It is also possible to control the type of changes shown in the list. By default all types are shown but with ''type'' parameter you can restrict the shown changes to a given type. The supported types are ''create'', ''edit'', ''minor'' and ''delete''. Multiple types can be specified separated by a comma:
Line 52: Line 65:
   {{changes>type = create}}   {{changes>type = create}}
   {{changes>type = edit, minor}}   {{changes>type = edit, minor}}
-   + 
-You can also filter by user. Multiple users are also separated by comma:+==== Allowlist/blocklist changes by user ==== 
 + 
 +To show only changes by particular users, the ''user'' parameter takes a comma-separated list of usernames:
  
   {{changes>user = rauschen}}    {{changes>user = rauschen}} 
   {{changes>user = rauschen, andi}}   {{changes>user = rauschen, andi}}
 +  
 +Exclusion of particular users is also possible using the ''excludedusers'' parameter, which also takes a comma-separated list of usernames:
 +
 +  {{changes>excludedusers = FosseWay}}
 +  {{changes>excludedusers = FosseWay, andi}}
 +
 +==== Maximum age of change displayed ====
  
-Filtering by age is possible, too. Just specify the maximum age in seconds (or configure a default in the config).+Filtering by age is possible, too. Just specify the maximum age in seconds. However, please note that this plugin can not display changes older than [[config:recent_days]].
  
   {{changes>maxage = 500}}   {{changes>maxage = 500}}
  
 +==== Output renderer ====
  
 The changes can be rendered either as a simple list (default) or using [[:plugin:pagelist|Pagelist]] plugin. You have to install the Pagelist plugin separately, if it's not available the simple list is used instead. The renderer is selected with the "render" parameter: The changes can be rendered either as a simple list (default) or using [[:plugin:pagelist|Pagelist]] plugin. You have to install the Pagelist plugin separately, if it's not available the simple list is used instead. The renderer is selected with the "render" parameter:
Line 68: Line 91:
   {{changes>render = pagelist}}   {{changes>render = pagelist}}
  
-The renderers can have extra parameters (a.k.a. flags), which can be passed within parenthesis as a comma-separated list:+The renderers can have extra parameters (a.k.a. [[plugin:pagelist#flags]]), which can be passed within parenthesis as a comma-separated list:
  
   {{changes>render = list(signature)}}   {{changes>render = list(signature)}}
Line 85: Line 108:
  
 By default only the summary is shown. For the list of parameters supported by Pagelist plugin refer to its [[:plugin:pagelist#flags|documentation]]. By default only the summary is shown. For the list of parameters supported by Pagelist plugin refer to its [[:plugin:pagelist#flags|documentation]].
 +
 +==== Multiple parameter syntax ====
  
 If you want to pass a number of parameters to the plugin they should be separated with an ampersand, for example: If you want to pass a number of parameters to the plugin they should be separated with an ampersand, for example:
Line 91: Line 116:
  
 The above syntax would display the last 15 pages created by user rauschen inside the "foo" namespace.  The above syntax would display the last 15 pages created by user rauschen inside the "foo" namespace. 
 +
 +==== ACL compatability ====
  
 Note: The plugin respects [[:ACL]] permissions but output is cached with the page it is in until a new change was made. If you're listing ACL dependent changes use the %%~~NOCACHE~~%% macro in the page you're using this plugin. Note: The plugin respects [[:ACL]] permissions but output is cached with the page it is in until a new change was made. If you're listing ACL dependent changes use the %%~~NOCACHE~~%% macro in the page you're using this plugin.
  
 +==== Username fallback ====
 +
 +The plugin attempts to describe the user who made each change in the following order:
 +  - If possible, the descriptive username is displayed, e.g. ''Joanna Schmidt''
 +  - If descriptive username is unavailable((Under certain circumstances, some auth methods may be unable to provide descriptive username. For instance, authentication against a corporate AD server, where the AD server may return minimal details, and this is outside the control of the wiki administrator.)), login ID is displayed, e.g. ''joanna.schmidt''
 +  - If no user information is provided to the Changes plugin by auth, the IP address the change was made from is displayed. This will likely be the case for an anonymous edit.
  
 ===== Development ===== ===== Development =====
Line 106: Line 139:
  
 Please report issues in the bug tracker at https://github.com/cosmocode/changes/issues Please report issues in the bug tracker at https://github.com/cosmocode/changes/issues
- 
- 
- 
- 
  
plugin/changes.1479453105.txt.gz · Last modified: 2016-11-18 08:11 by 40.76.203.95 · Currently locked by: 213.180.203.98

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki