﻿=== bbPress Pencil Unread ===
Contributors: grosbouff 
Tags: bbpress,unread,topics,forums,buddypress
Requires at least: Wordpress 3, bbPress 2
Tested up to: Wordpress 3.5.1, bbPress 2.2.4
Stable tag: trunk
License:GPLv2 or later

bbPress Pencil Unread display which bbPress forums/topics have already been read by the user.

== Description ==

bbPress Pencil Unread display which bbPress forums/topics have already been read by the logged user; and adds classes to forums/topics so you can customize your theme easily.  
  
*   For **topics**, it checks if the user opened the topic since it was last active.
*   For **forums**, it checks if the user has visited the forum since it was last active.

== Installation ==

Extract the zip file and just drop the contents in the wp-content/plugins/ directory of your WordPress installation and then activate the Plugin from Plugins page.
== Frequently Asked Questions ==

== Frequently Asked Questions ==

= How does it work? =

*bbPress Pencil Unread* handles differently the way forums & topics are set as read.

*   For **topics**, the ID of each visitor having read the topic is is stored in *bbppu_read_by* (posts metas table) when the topic is opened.  When a new reply is added, the IDs of the users having already read the topic are deleted.
*   For **forums**, the time of each forum's last access by the user is stored in *bbppu_forums_visits* (users metas table) on forum visits, and compared to the forum last activity time. This means a forum will be set as "read" if the user has visited the forum page, and even if some topics inside have not been read (but they will remain listed as non read topics when displaying the forum).
  
It's working that way to avoid having too much database calls / data stored.

= How can I use those functions outside of the plugin ? =

Have a look at the file /bbppu-template.php, which contains functions you could need.

== Screenshots ==
1. Style of the read / non-read forums

== Changelog ==
= 1.0.0 =
First release