Mercurial > hg > commentator

comparison README.txt @ 7:872f98a484d2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
note about audiences
author Jeff Hammel <jhammel@mozilla.com>
date Sat, 23 Mar 2013 16:50:40 -0700
parents 1c95a3fa76c1
children
comparison
equal deleted inserted replaced
6:c95f1dfed329 7:872f98a484d2
11 Commentator, pass a database (the path to the pickle) and a pattern. 11 Commentator, pass a database (the path to the pickle) and a pattern.
12 The pattern is in the form of 12 The pattern is in the form of
13 13
14 <URL pattern>#<xpath pattern> -> URL 14 <URL pattern>#<xpath pattern> -> URL
15 15
16 The URL pattern is a 16 The URL pattern is a
17 `python regular expression <ttp://docs.python.org/library/re.html>`_ 17 `python regular expression <ttp://docs.python.org/library/re.html>`_
18 to match against the request's PATH_INFO. 18 to match against the request's PATH_INFO.
19 19
20 The xpath pattern is where you want to place the comments on the 20 The xpath pattern is where you want to place the comments on the
21 page. See http://www.w3schools.com/XPath/ for more about xpath 21 page. See http://www.w3schools.com/XPath/ for more about xpath
22 expressions. 22 expressions.
23 23
68 * fix weird lxml issue where you have to put .// for elements 68 * fix weird lxml issue where you have to put .// for elements
69 * allow commenting on multiple resources (multiple patterns per instance) 69 * allow commenting on multiple resources (multiple patterns per instance)
70 * locking pickle files 70 * locking pickle files
71 * fix couch....not sure what's wrong 71 * fix couch....not sure what's wrong
72 * allow use of CSS classes, not just xpath 72 * allow use of CSS classes, not just xpath
73 * tests!
74
75 Types of comments:
76
77 A generalize comment (stream) is a *discussion* content type. As
78 such, in general you could include the standard *((string)key, value)*
79 metadata with each comment.
80
81 More actionably, a single field, *audience*, is often sufficient.
82 While the general form is out-of-scope (for now) for commentator,
83 adding an audience would go some ways towards comment effectivity.
84
85 Examples of audiences:
86
87 * original author : especially useful for site comments
88 * discussion : everyone participating
89
73 90
74 -- 91 --
75 92
76 http://k0s.org 93 http://k0s.org