====== Labeled Plugin ======

---- plugin ----
description: Add labels to wiki pages
author     : Dominik Eckelmann
email      : dokuwiki@cosmocode.de
type       : action, admin
lastupdate : 2016-07-06
compatible : Hrun
depends    : sqlite
conflicts  : 
similar    : tagging
tags       : tags

downloadurl: https://github.com/cosmocode/dokuwiki-plugin-labeled/archive/master.zip
bugtracker : https://github.com/cosmocode/dokuwiki-plugin-labeled/issues
sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-labeled
donationurl: 

screenshot_img : 
----

[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ https://www.cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]

===== Installation =====

:!: **External requirements:** This plugin requires the following additional components that must be installed separately: 
  * [[plugin:sqlite|SQLite plugin]]

Install the plugin using the [[plugin:extension|Extension Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.

===== Examples/Usage =====

Available Labels can be defined admin-page of the labeled plugin.

==== Embed in Template ====

You can add the labeled component directly into your template's ''main.php'':

<code php>
<?php
    //show labels only if user has access to page. Works on wikis with disabled acl too.
    if (auth_quickaclcheck(getID()) >= AUTH_READ) {
        //check if sqlite plugin exists, labeled plugin requires it.
        if (!plugin_isdisabled('sqlite')) {
            //Labeled
            $labeled = plugin_load('helper','labeled');
            if($labeled) echo $labeled->tpl_labels();
        }
    }
?>
</code>

Users of the [[template:dokuwiki]] template could also put above code in a newly created file ''conf/sidebarfooter.html''.

=== Using with Vector Template ===

Users of the [[template:vector]] template could also put following to ''dokuwiki/lib/tpl/vector/**user**/boxes.php'' (**NOT** ''dokuwiki/lib/tpl/vector/**conf**/boxes.php''):

<code php>
//show labels only if user has access to page. Works on wikis with disabled acl too.
if (auth_quickaclcheck(getID()) >= AUTH_READ) {
    //check if sqlite plugin exists, labeled plugin requires it. if it doesn't exist or is disabled, vector template won't render
    if (!plugin_isdisabled('sqlite')) {
        $labeled = plugin_load('helper','labeled');
        if($labeled ) {
    	    $_vector_boxes["labeled"]["headline"] = "Labeled";
	    $_vector_boxes["labeled"]["xhtml"] = $labeled->tpl_labels();
        }
    }
}
</code>

===== Development =====

{{rss>https://github.com/cosmocode/dokuwiki-plugin-labeled/commits/master.atom date}}

=== Known Bugs and Issues ===

Please refer to the [[https://github.com/cosmocode/dokuwiki-plugin-labeled/issues|issue tracker]] for reporting issues.