annotate COMMENTS @ 112:bdc987f0c049

Added /favicon.ico
author Steve Kemp <steve@steve.org.uk>
date Thu, 13 Dec 2007 13:02:06 +0000
parents 10797bf26799
children b296489d9ea1
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
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
3 Chronicle, since version 2.0, supports the submission of post
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
4 comments.
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
5
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
6 The way this works is rather non-standard so please read this
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
7 document to understand it.
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
8
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
9
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
10 Basic Usage
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
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
13 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
14 into a HTML & RSS blog.
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
15
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
16 Generally it appears that people will do this upon a local machine,
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
17 then scp, rsync, or otherwise move the output into place upon their
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
18 remote webserver.
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
19
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
20 This process looks something like this:
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
21
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
22 chronicle --input=./blog --output=./html
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
23 rsync html user@host:/path/to/blog
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
24
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
25
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
26 Advanced Usage
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
27 --------------
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
28
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
29 Since the blog, once produced, is typically stored upon a remote
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
30 system there is no easy way for comments which are stored upon that
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
31 system to be integrated into the main blog.
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
32
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
33 The solution to this problem is to merely record comments upon
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
34 the webserver in simple text files.
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
35
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
36 Later these can be fetched to the machine which is building the
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
37 blog, and integrated for the next rebuild:
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
38
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
39
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
40 scp uesr@host://path/to/comments/* ./comments/
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
41 chronicle --input=./blog --output=./html --comments=./comments
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
42 rsync html user@host:/path/to/blog
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
43
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
44
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
45 Steve
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
diff changeset
46 --