commentator for Linux 0.1

Usage:<br />Make a factory wrapping your app in the commentator middleware. Currently, commentator only pickles comments. To the constructor of Commentator, pass a database (the path to the pickle) and a pattern. The pattern is in the form of<br />< URL pattern >#< xpath pattern > -> URL<br />The URL pattern is a python regular expression to match against the request's PATH_INFO.<br />The xpath pattern is where you want to place the comments on the page. See http://www.w3schools.com/XPath/ for more about xpath expressions.<br />The URL is a python string template that is substituted for groups in the URL regular expression and element attributes in the found nodes. The element attributes are referenced by name (${id}, ${class}, etc) and the groups are referenced by number (${1}, ...).<br />Example:<br />A reference implementation is illustrated in the commentator.ini file. This uses the pattern:<br /> commentator.pattern = (.*)#.//div[@id='comment_on_this'] -> ${1}<br />What this pattern says is<br /> * comment on every PATH_INFO (.*)<br /> * append the rendered content template to div[@id='comment_on_this']<br /> * reference the PATH_INFO as the canonical URL ${1}<br />To comment on every HTML page at the end of the body, you would use<br /> commentator.pattern = (.*)#.//body -> ${1}<br />A more complex example is in the .ini file, commented out, for use with bitsyblog :<br /> commentator.pattern = /blog/.*#.//div[@class='blog-entry'] -> /blog/${id}<br />This pattern says:<br /> * comment on all paths under blog<br /> * put the comments at the end of each div[@class='blog-entry']<br /> * get the URI from the div's id, not from the PATH_INFO

Requirements:	No special requirements
Platforms:	*nix, Linux
Keyword:	Append,  Attributes,  Comment,  Commentator,  Commentator Linux,  Commentatorpattern,  Comments,  Divid Comment,  Element,  Expression,  Factory,  Groups,  Linux,  Path Info,  Pattern,  Python,  Reference,  Referenced,  Regular,  Template,  Xpath
Users rating:	0/10