Mercurial > hg > chronicle

annotate COMMENTS @ 220:79f30bca8489

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Ran through ispell
author Steve Kemp <steve@steve.org.uk>
date Wed, 16 Apr 2008 19:07:39 +0100
parents 1d4f3be0e000
children 6e34732430db
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
109
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
1
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
2
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
3 Chronicle, since version 2.0, supports the submission of comments
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
4 upon published posts. This document describes how you would go
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
5 about enabling this support.
109
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
6
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
7
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
8
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
9 Introduction
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
10 ------------
109
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
11
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
12 The basic use of chronicle is to convert a collection of text files
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
13 into a HTML & RSS blog.
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
14
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
15 There are two ways this software is typically used:
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
16
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
17 Single Machine
220
79f30bca8489 Ran through ispell
Steve Kemp <steve@steve.org.uk>
parents: 204
diff changeset
18 The blog input is stored upon your web-server and you generate
141
07482ca8e696 minor rewording + new section on spam.
Steve Kemp <steve@steve.org.uk>
parents: 129
diff changeset
19 the output directly to a http-accessible directory upon that
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
20 machine.
109
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
21
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
22 Multiple Machines
141
07482ca8e696 minor rewording + new section on spam.
Steve Kemp <steve@steve.org.uk>
parents: 129
diff changeset
23 The blog input lives upon one machine, and once you've generated
220
79f30bca8489 Ran through ispell
Steve Kemp <steve@steve.org.uk>
parents: 204
diff changeset
24 the output you copy it over to a remote web-server where it may
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
25 be viewed.
109
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
26
141
07482ca8e696 minor rewording + new section on spam.
Steve Kemp <steve@steve.org.uk>
parents: 129
diff changeset
27 Depending upon which of these ways you use the software the
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
28 comment support will need to be handled differently.
109
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
29
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
30
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
31
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
32 Common Setup
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
33 ------------
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
34
220
79f30bca8489 Ran through ispell
Steve Kemp <steve@steve.org.uk>
parents: 204
diff changeset
35 Install the included file cgi-bin/comments.cgi upon the web-server
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
36 which hosts the blog, and adjust the settings at the start of that
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
37 file to specify:
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
38
141
07482ca8e696 minor rewording + new section on spam.
Steve Kemp <steve@steve.org.uk>
parents: 129
diff changeset
39 1. The local directory to save the comments within.
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
40
220
79f30bca8489 Ran through ispell
Steve Kemp <steve@steve.org.uk>
parents: 204
diff changeset
41 2. The source and destination email addresses to use for
79f30bca8489 Ran through ispell
Steve Kemp <steve@steve.org.uk>
parents: 204
diff changeset
42 notification purposes.
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
43
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
44
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
45
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
46 Single Machine
109
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
47 --------------
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
48
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
49 If you have only a single machine then you may configure the
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
50 comments.cgi script to save the comments in text files directly
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
51 within your blog tree.
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
52
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
53 Assuming you have something like this:
109
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
54
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
55 comments/
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
56 A directory to contain the comments.
220
79f30bca8489 Ran through ispell
Steve Kemp <steve@steve.org.uk>
parents: 204
diff changeset
57 NOTE: You will need to ensure your web-server has the permissions
129
613ad3447729 Misc update.
Steve Kemp <steve@steve.org.uk>
parents: 113
diff changeset
58 to save files to this directory.
613ad3447729 Misc update.
Steve Kemp <steve@steve.org.uk>
parents: 113
diff changeset
59
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
60 data/
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
61 The directory where your blog posts are loaded from.
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
62
109
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
63
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
64 You may then regenerate your blog via:
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
65
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
66 chronicle --input=./date/ --comments=./comments/ --output=/var/www/blog/
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
67
220
79f30bca8489 Ran through ispell
Steve Kemp <steve@steve.org.uk>
parents: 204
diff changeset
68 This will ensure that the comments saved by your web-server into the
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
69 comments directory are included in the (re)generated blog.
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
70
129
613ad3447729 Misc update.
Steve Kemp <steve@steve.org.uk>
parents: 113
diff changeset
71
109
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
72
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
73
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
74 Multiple Machines
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
75 -----------------
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
76
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
77 If you have the blog input files upon machine "local" and the
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
78 hosted blog upon the machine "remote" then you will run into
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
79 problems:
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
80
220
79f30bca8489 Ran through ispell
Steve Kemp <steve@steve.org.uk>
parents: 204
diff changeset
81 1. The comments are saved by your web-server to a local directory
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
82 upon the machine "remote".
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
83
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
84 2. To rebuild the blog upon your local machine, "local", you must
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
85 have those files.
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
86
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
87 The solution is to generate your blog in a three-step process:
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
88
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
89 1. Copy the comment files, if any from "remote" to "local".
109
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
90
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
91 2. Rebuild the blog.
109
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
92
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
93 3. Upload the built blog.
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
94
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
95 With the "pre-build" and "post-build" arguments to chronicle
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
96 you can automate this:
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
97
204
1d4f3be0e000 Updated the comment example to be valid.
Steve Kemp <steve@steve.org.uk>
parents: 141
diff changeset
98 chronicle \
1d4f3be0e000 Updated the comment example to be valid.
Steve Kemp <steve@steve.org.uk>
parents: 141
diff changeset
99 --pre-build="rsync -varz user@remote:/path/to/comments comments/" \
1d4f3be0e000 Updated the comment example to be valid.
Steve Kemp <steve@steve.org.uk>
parents: 141
diff changeset
100 --comments=./comments \
1d4f3be0e000 Updated the comment example to be valid.
Steve Kemp <steve@steve.org.uk>
parents: 141
diff changeset
101 --output=./output \
1d4f3be0e000 Updated the comment example to be valid.
Steve Kemp <steve@steve.org.uk>
parents: 141
diff changeset
102 --post-build="rsync -vazr ./output user@remote:/path/to/location"
113
b296489d9ea1 Updated to give a better overview.
Steve Kemp <steve@steve.org.uk>
parents: 109
diff changeset
103
129
613ad3447729 Misc update.
Steve Kemp <steve@steve.org.uk>
parents: 113
diff changeset
104
141
07482ca8e696 minor rewording + new section on spam.
Steve Kemp <steve@steve.org.uk>
parents: 129
diff changeset
105
07482ca8e696 minor rewording + new section on spam.
Steve Kemp <steve@steve.org.uk>
parents: 129
diff changeset
106 Spam Filtering
07482ca8e696 minor rewording + new section on spam.
Steve Kemp <steve@steve.org.uk>
parents: 129
diff changeset
107 --------------
07482ca8e696 minor rewording + new section on spam.
Steve Kemp <steve@steve.org.uk>
parents: 129
diff changeset
108
07482ca8e696 minor rewording + new section on spam.
Steve Kemp <steve@steve.org.uk>
parents: 129
diff changeset
109 In the modern world many blogs will receive comments which are
07482ca8e696 minor rewording + new section on spam.
Steve Kemp <steve@steve.org.uk>
parents: 129
diff changeset
110 just spam, and not related to your content at all.
07482ca8e696 minor rewording + new section on spam.
Steve Kemp <steve@steve.org.uk>
parents: 129
diff changeset
111
07482ca8e696 minor rewording + new section on spam.
Steve Kemp <steve@steve.org.uk>
parents: 129
diff changeset
112 My solution to this is to use an email spam filter upon the
07482ca8e696 minor rewording + new section on spam.
Steve Kemp <steve@steve.org.uk>
parents: 129
diff changeset
113 comments. So my comments are saved to a directory, and later
07482ca8e696 minor rewording + new section on spam.
Steve Kemp <steve@steve.org.uk>
parents: 129
diff changeset
114 tested automatically. If they are non-spam they are kept, if
07482ca8e696 minor rewording + new section on spam.
Steve Kemp <steve@steve.org.uk>
parents: 129
diff changeset
115 they are spam they are deleted.
07482ca8e696 minor rewording + new section on spam.
Steve Kemp <steve@steve.org.uk>
parents: 129
diff changeset
116
07482ca8e696 minor rewording + new section on spam.
Steve Kemp <steve@steve.org.uk>
parents: 129
diff changeset
117 You might need to do something similar for your own installation.
07482ca8e696 minor rewording + new section on spam.
Steve Kemp <steve@steve.org.uk>
parents: 129
diff changeset
118
109
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
119 Steve
204
1d4f3be0e000 Updated the comment example to be valid.
Steve Kemp <steve@steve.org.uk>
parents: 141
diff changeset
120 --