DokuWiki

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

====== Authorlist Plugin ======

---- plugin ----
description: Displays all contributors/authors of a wikipage.
author     : Martin Schulte, Vladimir Kuzmin
email      : jl.alice@yandex.ru
type       : syntax, action, helper
lastupdate : 2016-12-16
compatible : "Adora Belle", "Weatherwax", "Binky", "Elenor of Tsort"
depends    : 
conflicts  : 
similar    : 
tags       : listing, authors, contributors

downloadurl: https://github.com/jlAlice/dokuwiki-authorlist/archive/master.zip
bugtracker : https://github.com/jlAlice/dokuwiki-authorlist/issues
sourcerepo : https://github.com/jlAlice/dokuwiki-authorlist
----

===== 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 =====
Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download %%URL%% above, which points to the latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.

===== Usage and Syntax=====
To display an authorlist you have to put 
<code>
	~~AUTHORS~~
</code>
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|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|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|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 [[devel:metadata#data_structure|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:

<code>
~~AUTHORS:displaystyle=loginname (fullname)&tooltip=loginname&displayaslist=true~~
</code>

In case of options which only have //true// or //false// as a value, you can use 
<code>
~~AUTHORS:displayaslist~~
</code>
to enable them.

====Disable authorlist manually====
If the authorlist is displayed on every wikipage by default (see option ''automatic'' in [[#configuration_settings|Configuration Settings]]), you can disable automatic generation using 
<code>
~~AUTHORS:off~~
</code>
somewhere in the text.

=====Configuration Settings=====
The plugin can be configured using the DokuWiki [[:plugin:config|configuration manager]] available in the [[:admin_window|admin menu]].

On the one hand, you can set some general options:

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|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 [[https://github.com/jlAlice/dokuwiki-authorlist/issues|Bug tracker]].

==== ChangeLog ====
{{rss>https://github.com/jlAlice/dokuwiki-authorlist/commits/master.atom  5 date 1h }}

=====Discussion=====

Authorlist renders putput before RefNotes plugin.
How to make the Authorlist go after the RefNotes and naturally before the Discussion Plugin putput?

Please fill all the letters into the box to prove you're human. M᠎ U Y D M Please keep this field empty:

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Share Alike 4.0 International