Table of Contents
Authorlist Plugin
Compatible with DokuWiki
"Adora Belle", "Weatherwax", "Binky", "Elenor of Tsort"
Displays all contributors/authors of a wikipage
This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.
Description
The authorlist plugin adds a list with all authors to the corresponding wikipage. You can add manually the pattern ~~AUTHORS~~ to a wikipage or enable a authorlist for every page.
Installation
Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.
Usage and Syntax
To display an authorlist you have to put
~~AUTHORS~~
into the text of a wikipage. A list of all authors will be shown at this place. By default, this looks like
- arthur
- ford
- zaphod
The default behaviour is managed by the wiki admin through the Configuration Settings. Some default settings can be altered by using the following options.
| Option | Description | Possible values |
|---|---|---|
displayaslist | Displays the authors in a list instead (in 1 row). | true/false |
displaystyle | Defines the displaystyle for an author. It is possible to show his login name, his fullname or both. | loginname, fullname, loginname (fullname), fullname (loginname) |
tooltip | The tooltip should be displayed, if the mouse is over the corresponding author (If linkto=email by default, the email-address is the tooltip). | loginname, fullname |
showcreator | Should the creator shown separate before or below the authorlist? (You can choose a templatetext for this in the Configuration Settings). | none before below |
printempty | If there is no author (e. g. you have a public site, and only unregistered authors contributed sth.), the introtext (see intro in the Configuration Settings) is displayed, but no author. If you want to avoid this, you can choose this option. | true/false |
creatorisauthor | If the creator of a page never edit the page later, he is not listed in the contributorslist in the Dokuwiki metadata and therefore not listed in authorlist generated through this plugin. There may be situations where this is necessary, e. g. if your user only have rights to edit pages, but not to create pages. In this case a admin creates the page, but contributes nothing to the content. | true/false |
You can apply this options using option=value. Several options are joined with &.
E. g. this looks like:
~~AUTHORS:displaystyle=loginname (fullname)&tooltip=loginname&displayaslist=true~~
In case of options which only have true or false as a value, you can use
~~AUTHORS:displayaslist~~
to enable them.
Disable authorlist manually
If the authorlist is displayed on every wikipage by default (see option automatic in Configuration Settings), you can disable automatic generation using
~~AUTHORS:off~~
somewhere in the text.
Configuration Settings
The plugin can be configured using the DokuWiki configuration manager available in the admin menu.
On the one hand, you can set some general options:
| Option | Description | Default value |
|---|---|---|
automatic | Display the authorlist on every wikipage by default. | no |
showheading | Show a heading above the list. | no |
heading | The heading that appears above the list, if you enabled this. You can use html-syntax. | Authors |
intro | A introducing text above the list. | <p><b>Contributing authors:</b></p> |
creatortext | Text, in which the name of the creator and the date will be embedded (use %CREATOR% and %DATE% as wildcard for the creatorname and the date, you can use html-syntax. The date will displayed in the format specified by DokuWiki's dformat). | <p>Created by <i>%CREATOR%</i> on %DATE%.</p> |
linkto | You can link each author to his userhomepage or with his email-adress | none |
userpageid | The template for the link to the userhomepage (use %USER% as wildcard for the username (loginname)). | :user:%USER% |
Also you can set the default style for the authorlist in the configuration menu, while setting the values for options displayed under Usage and Syntax.
Change the layout
There is a css-file (all.css) under lib/plugins/authorlist which provides some classes which named author, authoruserpage and authoremail. This classes control the layout of authorlist. You can change them or integrate them into your template-css.
Bugs / Feature Requests
Please report bugs or feature requests at the Bug tracker.
ChangeLog
- recovering the first author's email in INFO (2017-01-04 12:19)
- update info (2017-01-04 12:15)
- update info (2017-01-04 12:04)
- adding HTML attributes to the userhomepage links (2017-01-04 11:59)
- Update README.md (2016-12-17 15:58)
Discussion
Authorlist renders putput before RefNotes plugin. How to make the Authorlist go after the RefNotes and naturally before the Discussion Plugin putput?