Mercurial > hg > chronicle
changeset 109:10797bf26799
Added 'COMMENTS' to the file.
| author | Steve Kemp <steve@steve.org.uk> |
|---|---|
| date | Thu, 13 Dec 2007 12:18:20 +0000 |
| parents | a25099606ec5 |
| children | afe385f49abd |
| files | COMMENTS README debian/docs |
| diffstat | 3 files changed, 63 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/COMMENTS Thu Dec 13 12:18:20 2007 +0000 @@ -0,0 +1,46 @@ + + + Chronicle, since version 2.0, supports the submission of post + comments. + + The way this works is rather non-standard so please read this + document to understand it. + + +Basic Usage +----------- + + The basic use of chronicle is to convert a collection of text files + into a HTML & RSS blog. + + Generally it appears that people will do this upon a local machine, + then scp, rsync, or otherwise move the output into place upon their + remote webserver. + + This process looks something like this: + + chronicle --input=./blog --output=./html + rsync html user@host:/path/to/blog + + +Advanced Usage +-------------- + + Since the blog, once produced, is typically stored upon a remote + system there is no easy way for comments which are stored upon that + system to be integrated into the main blog. + + The solution to this problem is to merely record comments upon + the webserver in simple text files. + + Later these can be fetched to the machine which is building the + blog, and integrated for the next rebuild: + + + scp uesr@host://path/to/comments/* ./comments/ + chronicle --input=./blog --output=./html --comments=./comments + rsync html user@host:/path/to/blog + + +Steve +-- \ No newline at end of file
--- a/README Thu Dec 13 12:11:43 2007 +0000 +++ b/README Thu Dec 13 12:18:20 2007 +0000 @@ -8,8 +8,11 @@ Sample Output: http://www.steve.org.uk/Software/chronicle/demo/ +Real World Use: + http://blog.steve.org.uk/ - + + chronicle - A blog compiler --------------------------- @@ -19,11 +22,9 @@ The system is intentionally simple, but it does support: * Template based output. - * Support for RSS feeds. - * Support for tagged entries. - + * Optional support for comments. @@ -41,7 +42,7 @@ This will give you: /usr/share/chronicle <- The theme directories. - /usr/local/bin/chronicle <- The main binary. + /usr/bin/chronicle <- The main binary. /etc/chroniclerc <- The main configuration file. If you wish to customise the templates it is recommended you @@ -73,6 +74,15 @@ is used in preference to the current date if none is present. + +Comment Support +--------------- + + The system supports the submission of user-supplied comments upon + posts, for more details please see the included file COMMENTS. + + + Bugs? -----