Source

tgapp-tgcomments / README.rst

Diff from to

README.rst

 About tgcomments
 -------------------------
 
-tgcomments is a Pluggable application for TurboGears2.
+tgcomments is a Pluggable Comments application for TurboGears2.
+Comments can be added to any webpage by using the ``comments_for`` partial.
+
+TGComments supports Facebook for avatar if the user logged using tgapp-fbauth
+or if the User model provides a similar interface. Otherwise will fallback to
+Gravatar.
 
 Installing
 -------------------------------
 You will be able to access the registration process at
 *http://localhost:8080/tgcomments*.
 
-Available Hooks
-----------------------
-
-tgcomments makes available a some hooks which will be
-called during some actions to alter the default
-behavior of the appplications:
-
 Exposed Partials
 ----------------------
 
 to render pieces of the blogging system anywhere in your
 application:
 
+- ``tgcomments.partials:comments_for(entity)``
+    Given any SQLAlchemy entity which is available inside your application ``model`` module
+    it will display a list of comments for that entity with a box to add a new comment.
+
+Provided Options
+--------------------
+
+tgcomments supports a bunch of options that can be passed to the plug call
+to change its behavior:
+
+- *notify_facebook* (default:True) automatically notify on facebook comments that
+    the user wrote if he has logged using Facebook
+- *allow_anonymous* (default:True) allow anonymous users to comment
+
 Exposed Templates
 --------------------
 
 The templates used by registration and that can be replaced with
 *tgext.pluggable.replace_template* are:
 
+- ``tgcomments.templates.comments_partial``
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.