DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:starred

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:starred [2011-12-24 12:34] Aleksandrplugin:starred [2023-10-31 00:20] (current) Klap-in
Line 1: Line 1:
-====== starred plugin ====== +====== Starred Plugin ======
- +
-[[http://www.cosmocode.de/en/wiki/dokuwiki/plugins|{{ http://www.cosmocode.de/_media/en/wiki/dokuwiki/cosmologo.png?recache|A CosmoCode Plugin}}]]+
  
 ---- plugin ---- ---- plugin ----
-description: allows users to remember pages+description: Allows users to remember pages
 author     : Andreas Gohr author     : Andreas Gohr
-email      : andi@splitbrain.org+email      : dokuwiki@cosmocode.de
 type       : action, syntax type       : action, syntax
-lastupdate : 2010-12-21 +lastupdate : 2023-06-13 
-compatible : 2009-12-25+, anteater, rincewind+compatible : Frusterick Manners
 depends    : sqlite depends    : sqlite
 conflicts  conflicts 
 similar    :  similar    : 
 tags       : favorites, remember 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
 ---- ----
  
-Plugin doku and download is available on [[http://ickewiki.de/dokumentation/starred|ICKEwiki.de]].+[[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. 
 + 
 + 
 +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 [[template:icke|icke template]] already include 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 pageWorks 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 pageAn 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 ===
  
-===== Localization =====+Please report bugs and issues at: https://github.com/cosmocode/starred/issues
  
-  * [[http://my.opera.com/alexgearbox/blog/download-starred-ru-zip|Russian translation]] 
plugin/starred.1324726491.txt.gz · Last modified: 2011-12-24 12:34 by Aleksandr

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki