DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:starred

Starred Plugin

Compatible with DokuWiki

  • 2017-02-19 "Frusterick Manners" yes
  • 2016-06-26 "Elenor Of Tsort" unknown
  • 2015-08-10 "Detritus" unknown
  • 2014-09-29 "Hrun" unknown

plugin allows users to remember pages

Last updated on
2017-04-20
Provides
Syntax, Action
Repository
Source
Requires
sqlite

Tagged with favorites, remember

A CosmoCode Plugin

Installation

:!: External requirements: This plugin requires the following additional components that must be installed separately:

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

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();
  ?>

Some templates, like the icke template already include this link on every page by default.

Using with Vector Template

Users of the vector template could also put following to dokuwiki/lib/tpl/vector/user/boxes.php (NOT dokuwiki/lib/tpl/vector/conf/boxes.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
        }
    }
}

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

Known Bugs and Issues

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

plugin/starred.txt · Last modified: 2017-04-20 23:51 by andi