← Back to branch summary

~ubuntu-branches/ubuntu/feisty/pyblosxom/feisty

« back to all changes in this revision

Viewing changes to contrib/plugins/comments/README

  • Committer: Bazaar Package Importer
  • Author(s): Tollef Fog Heen
  • Date: 2005-04-06 18:56:44 UTC
  • mfrom: (1.2.1 upstream) (2.1.1 hoary)
  • Revision ID: james.westby@ubuntu.com-20050406185644-t4dg3gqw55bdfu3z
Tags: 1.2-1
http://bugs.debian.org/291726
http://bugs.debian.org/227080
http://bugs.debian.org/229342
http://bugs.debian.org/271655
http://bugs.debian.org/274830
http://bugs.debian.org/282603
http://bugs.debian.org/231621
* New upstream release (closes: #291726)
  - no contributed plugins any more.  License issues and upstream
    splitting it out of the upstream tarball.
  - No more xmlrpc.py (closes: #227080, #229342)
  - Now actually uses ignore_directories correctly (closes: #271655)
  - Corrected use of hex constants (closes: #274830)
  - Uses $pyblosxom_version in default renderer (closes: #282603)
  - No longer has version number in default config file (closes: #231621)

* Update new upstream URL in welcome.txt
* Update license to the MIT license.

Show diffs side-by-side

added added

removed removed

Lines of Context:
contrib/plugins/comments/README
1
 
To install comments:
2
 
 
3
 
1. Install plugins/comments.py in your lib/plugins directory
4
 
 
5
 
2. If you want trackbacks, install trackback.cgi in your pyblosxom 
6
 
   directory and make it executable as a CGI.  The CGI must be callable
7
 
   via a URI on your blog site. 
8
 
 
9
 
3. If you want pingbacks, install xmlrpcplugins/pingback.py in your
10
 
   lib/xmlrpcplugins directory
11
 
 
12
 
4  In config.py, 
13
 
   add 'comments' to py['load_plugins']
14
 
 
15
 
   Comments are stored in a directory which will parallel the data
16
 
   directory.  The comments themselves are stored as XML files named
17
 
   entryname-datetime.suffix.  The comment system allows you to specify
18
 
   the directory where the comment directory tree will stored, and the
19
 
   suffix used for comment files.
20
 
 
21
 
   set py['comment_dir'] to the directory (in your data directory)
22
 
   where you want the comments to be stored.  The default value is a
23
 
   directory named 'comments' in your data directory.
24
 
 
25
 
   set py['comment_ext'] to the change comment file extension.  The
26
 
   default file extension is 'cmt'
27
 
 
28
 
5  The comment system can notify you via e-mail when new
29
 
   comments/trackbacks/pingbacks are posted.  If you want to enable this 
30
 
   feature, create the following config.py entries:
31
 
 
32
 
   py['comment_smtp_server'] - your SMTP server
33
 
   py['comment_smtp_from'] - the address sending the notification
34
 
   py['comment_smtp_to'] - the address receiving the notification
35
 
 
36
 
   set for e-mail notification stuff - fix vars
37
 
 
38
 
6. Copy the flavour files from the flavours directory.  There are
39
 
   flavours for .html and rss.  You should copy both.  The comment-story
40
 
   template is used to format a single entry that has comments .  The
41
 
   comment template is used to format a single
42
 
   comment/trackback/pingback.  The comment-form template provides the
43
 
   form used to enter new comments.
44
 
 
45
 
7. Edit the comment-story, comment, and comment-form templates.  You
46
 
   will have to adjust trackback URI's to match your webserver
47
 
   configuration.  Variables that are available are:
48
 
 
49
 
   Available in the story and comment-story templates:
50
 
   $num_comments - Contains an integer count of the number of comments
51
 
   associated with this entry
52
 
   
53
 
   Available in the comment template:
54
 
   $cmt_title - the title of the comment
55
 
   $cmt_description - the content of the comment or excerpt of the trackback/pingback
56
 
   $cmt_link - the pingback link referring to this entry
57
 
   $cmt_author - the author of the comment or trackback
58
 
   $cmt_pubDate - the date and time of the comment/trackback/pingback
59
 
   $cmt_source - the source of the trackback