====== Clacks Plugin ======

---- plugin ----
description: Pay your respects by sending a Clacks overhead across the internet.
author     : Luis Machuca Bezzaza
email      : lambalicious [at] tuta [dot] io
type       : action
lastupdate : 2018-11-13
compatible : 
depends    : 
conflicts  : 
similar    : 
tags       : headers, meta

downloadurl: https://chiselapp.com/user/lmachucab/repository/dokuwiki-plugin-clacks/zip/trunk/clacks.zip
bugtracker : https://chiselapp.com/user/lmachucab/repository/dokuwiki-plugin-clacks/reportlist
sourcerepo : https://chiselapp.com/user/lmachucab/repository/dokuwiki-plugin-clacks/
donationurl: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=T44AQDXJQJTJQ&source=url
----

**Press [download] to pay respects**

The **clacks plugin** allows a DokuWiki provider to pay their respects for a fallen figure by sending a [[http://www.gnuterrypratchett.com|"GNU" Clacks Overhead]] from their installation and across the internet.

A Clacks Overhead is a single HTTP header sent by a server which tags a given person's name. The overhead is delivered to all clients who connect to the DokuWiki installation, and if they have the adequate software they will be notified about the message.

Similar plugins exist for eg.: MediaWiki, Drupal and other content management installations. DokuWiki was a bit late in this regard and since I saw a commentary from an acquaintance that I interpreted as a RFI, I decided to give it a try.

For more information please see the page linked above.

===== Usage =====
Install the plugin via the Plugin Manager, and in the configuration set the ''overhead'' field to the name you wish to memorialize. The field defaults to //[[wp>Terry Pratchett]]//.

The plugin works by registering an action to use with the [[doku>devel:event:action_headers_send]] event.

===== Demo =====

For seeing the plugin in action you can visit eg.: [[http://ryan.gulix.cl]], and if you have your browser's Inspector ready or you have any of the various browser plugins that present Clacks notifications, you will see a notice. In the browser inspector you'll want to head over to Headers and look for ''X-Clacks-Overhead''.