Mercurial > hg > commentator
diff README.txt @ 7:872f98a484d2
note about audiences
author | Jeff Hammel <jhammel@mozilla.com> |
---|---|
date | Sat, 23 Mar 2013 16:50:40 -0700 |
parents | 1c95a3fa76c1 |
children |
line wrap: on
line diff
--- a/README.txt Tue Mar 02 11:44:10 2010 -0500 +++ b/README.txt Sat Mar 23 16:50:40 2013 -0700 @@ -13,9 +13,9 @@ <URL pattern>#<xpath pattern> -> URL -The URL pattern is a +The URL pattern is a `python regular expression <ttp://docs.python.org/library/re.html>`_ -to match against the request's PATH_INFO. +to match against the request's PATH_INFO. The xpath pattern is where you want to place the comments on the page. See http://www.w3schools.com/XPath/ for more about xpath @@ -70,6 +70,23 @@ * locking pickle files * fix couch....not sure what's wrong * allow use of CSS classes, not just xpath + * tests! + +Types of comments: + +A generalize comment (stream) is a *discussion* content type. As +such, in general you could include the standard *((string)key, value)* +metadata with each comment. + +More actionably, a single field, *audience*, is often sufficient. +While the general form is out-of-scope (for now) for commentator, +adding an audience would go some ways towards comment effectivity. + +Examples of audiences: + +* original author : especially useful for site comments +* discussion : everyone participating + --