====== Starred Plugin ======

---- plugin ----
description: Allows users to remember pages
author     : Andreas Gohr
email      : dokuwiki@cosmocode.de
type       : action, syntax
lastupdate : 2023-06-13
compatible : Frusterick Manners
depends    : sqlite
conflicts  : 
similar    : 
tags       : favorites, remember

downloadurl: https://github.com/cosmocode/starred/archive/master.zip
bugtracker : https://github.com/cosmocode/starred/issues
sourcerepo : https://github.com/cosmocode/starred

screenshot_img : https://trello.com/1/cards/6446cca859a5e18cb08220b3/attachments/6446cd25212f488c8404ca0e/download/dokuwiki-plugin-starred.png
----

[[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]]

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

Several templates (like e.g., [[template:sprintdoc]]) support this plugin right out of the box.

In other cases after installation you should include a link for users to save a page as favourite. Put the following into your template's main.php:

    <?php
        //Starred
        $starred = plugin_load('action','starred');
        if ($starred) $starred->tpl_starred();
    ?>

Already some legacy templates, like the [[template:icke|icke template]] (now //outdated//) already included this link on every page by default.

=== 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 starred 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"] = "toggle favorite";
	    $_vector_boxes["labeled"]["xhtml"] = $labeled->tpl_labels(false, false); //prevent printing
        }
    }
}
</code>

===== Usage =====

To list the current user's saved pages, add ''%%{{starred}}%%'' to a page. An optional minimal mode gives no text if the current user has starred no pages and leaves out the saving date: ''%%{{starred>min}}%%''. Finally, you might limit the number of shown pages: ''%%{{starred>min|5}}%%'' and ''%%{{starred|5}}%%'', respectively.

===== Development =====

=== Change Log ===

{{rss>https://github.com/cosmocode/starred/commits/master.atom date}}

=== Known Bugs and Issues ===

Please report bugs and issues at: https://github.com/cosmocode/starred/issues