DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:credits

credits Plugin

Compatible with DokuWiki

  • 2016-06-26 "Elenor Of Tsort" yes
  • 2015-08-10 "Detritus" yes
  • 2014-09-29 "Hrun" yes
  • 2014-05-05 "Ponder Stibbons" unknown

plugin Display Credits for installed plugins

Last updated on
2016-07-31
Provides
Syntax
Repository
Source

Similar to info

Tagged with listing, plugins

Download and Installation

Download and install the plugin using the Plugin Manager using the URL given above. Refer to Plugins on how to install plugins manually. If the above url does not load from your plugin manager, use this one: http://www.mturner.org/userfiles/credits.tar.gz

Syntax and Usage

Credits is a highly configurable plugin for displaying credits for DokuWiki plugins. Using the configuration manager, all of the CSS settings can be changed, as well as the title (Plugins) and subtitle (Credits) strings.

The syntax is one of the following:

<<CREDITS:>>
<<CREDITS:~nodesc~>>
<<CREDITS:user_defined_function>>

The first form will use the default rendering, subject to any changes in settings made in the Configuration Manager.

The second form will turn off the printing of the plugin descriptions. This is the desc field returned by the plugin’s getInfo() method. The descriptions can also be turned off in the Configuration Manager.

The third form will invoke a user-defined function for formatting the the output. There is a sample user-defined function in the syntax.php file:

  function alt_credits(&$renderer,$info)

$info has access to all of the fields returned by the getInfo() function of each plugin; alt_credits() will print out the following information for each plugin on your system:

author: Jack Smith
email: jsmith@mysite.orf date: 2010-11-24
name: My plugin
desc: Does my Stuff
url: http://dokuwiki.org/plugin:myplugin

The default credits page displays the plugin name and author (as email link). When running mouse cursor over the author, the year of the plugin is displayed in a tooltip. In the cases of plugin descriptions which are too long for a single line, the description will be truncated and an arrow placed at the end of the line. Running the mouse cursor over the author or over the the arrow will cause the rest of the description to appear below the truncated description line. This is illustrated in the example linked to below.

Sample Credits Display

Change Log

Discussion

:?: I think a link to the page of the plugin on SplitBrain would be cool too. And to me the mailto: seems a bit useless. Great plugin!!! — Christophe Gragnic 2007-11-10 13:40

plugin/credits.txt · Last modified: 2017-01-06 23:35 by turnermm