chronicle: README annotate

annotate README @ 263:c22641b53918

Updated for version 3.0 release

author	Steve Kemp <steve@steve.org.uk>
date	Wed, 23 Jul 2008 18:45:56 +0100
parents	62fd800e7777
children	6e34732430db

rev	line source
1 bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	1
19 8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	2 Homepage:
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	3 http://www.steve.org.uk/Software/chronicle/
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	4
65 88f87687b36e Removed references to the CVS repository and replaced them with Mercurial. Steve Kemp <steve@steve.org.uk> parents: 19 diff changeset	5 Mercurial Repository:
88f87687b36e Removed references to the CVS repository and replaced them with Mercurial. Steve Kemp <steve@steve.org.uk> parents: 19 diff changeset	6 http://chronicle.repository.steve.org.uk/
19 8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	7
69 e5b192246b68 Mention the demo site. Steve Kemp <steve@steve.org.uk> parents: 65 diff changeset	8 Sample Output:
e5b192246b68 Mention the demo site. Steve Kemp <steve@steve.org.uk> parents: 65 diff changeset	9 http://www.steve.org.uk/Software/chronicle/demo/
19 8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	10
109 10797bf26799 Added 'COMMENTS' to the file. Steve Kemp <steve@steve.org.uk> parents: 69 diff changeset	11 Real World Use:
10797bf26799 Added 'COMMENTS' to the file. Steve Kemp <steve@steve.org.uk> parents: 69 diff changeset	12 http://blog.steve.org.uk/
184 3739e04097da Mention the other real-world usage Steve Kemp <steve@steve.org.uk> parents: 166 diff changeset	13 http://blog.mail-scanning.com/
19 8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	14
109 10797bf26799 Added 'COMMENTS' to the file. Steve Kemp <steve@steve.org.uk> parents: 69 diff changeset	15
10797bf26799 Added 'COMMENTS' to the file. Steve Kemp <steve@steve.org.uk> parents: 69 diff changeset	16
184 3739e04097da Mention the other real-world usage Steve Kemp <steve@steve.org.uk> parents: 166 diff changeset	17 The chronicle blog compiler
1 bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	18 ---------------------------
bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	19
19 8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	20 Chronicle is a tool which will convert a directory of simple
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	21 text files into a static HTML weblog, (or blog if you prefer).
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	22
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	23 The system is intentionally simple, but it does support:
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	24
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	25 * Template based output.
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	26 * Support for RSS feeds.
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	27 * Support for tagged entries.
109 10797bf26799 Added 'COMMENTS' to the file. Steve Kemp <steve@steve.org.uk> parents: 69 diff changeset	28 * Optional support for comments.
19 8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	29
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	30
1 bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	31
bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	32
bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	33 Installation
bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	34 ------------
bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	35
166 df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	36 It is possible to run the software without installing it, just
19 8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	37 by placing blog entries in the ./blog directory and running
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	38 ./bin/chronicle.
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	39
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	40 However it is recommended you install the software system-wide
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	41 by running "make install" as root.
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	42
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	43 This will give you:
1 bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	44
19 8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	45 /usr/share/chronicle <- The theme directories.
109 10797bf26799 Added 'COMMENTS' to the file. Steve Kemp <steve@steve.org.uk> parents: 69 diff changeset	46 /usr/bin/chronicle <- The main binary.
199 f5873df8ec0b Briefly mention the spooler. Steve Kemp <steve@steve.org.uk> parents: 185 diff changeset	47 /usr/bin/chronicle-spooler <- A simple helper.
185 82917ab0dff4 Allow 'subject' as a synonym for 'title' Steve Kemp <steve@steve.org.uk> parents: 184 diff changeset	48 /etc/chroniclerc <- The global configuration file.
19 8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	49
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	50 If you wish to customise the templates it is recommended you
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	51 make a copy of them with a new name, then edit that copy. This
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	52 will prevent changes from being overwritten on upgrade.
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	53
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	54 The configuration file may be copied to ~/.chroniclerc for
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	55 per-user configuration.
1 bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	56
bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	57
bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	58
bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	59 Blog Format
bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	60 -----------
bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	61
bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	62 The blog format is very simple. Each file should start like this:
bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	63
19 8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	64 /--
1 bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	65 title: The title of my post
bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	66 date: 12 August 2007
bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	67 tags: foo, bar, baz
19 8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	68
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	69 The text of the actual entry goes here.
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	70
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	71 However much there is of it.
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	72 \--
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	73
1 bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	74
199 f5873df8ec0b Briefly mention the spooler. Steve Kemp <steve@steve.org.uk> parents: 185 diff changeset	75
218 62fd800e7777 Ran through ispell Steve Kemp <steve@steve.org.uk> parents: 199 diff changeset	76 The entries are aided by a pseudo-header. This header contains
199 f5873df8ec0b Briefly mention the spooler. Steve Kemp <steve@steve.org.uk> parents: 185 diff changeset	77 entries which are used by Chronicle to build your blog. The entries
f5873df8ec0b Briefly mention the spooler. Steve Kemp <steve@steve.org.uk> parents: 185 diff changeset	78 themselves are not included in your output HTML.
185 82917ab0dff4 Allow 'subject' as a synonym for 'title' Steve Kemp <steve@steve.org.uk> parents: 184 diff changeset	79
82917ab0dff4 Allow 'subject' as a synonym for 'title' Steve Kemp <steve@steve.org.uk> parents: 184 diff changeset	80 Title:
82917ab0dff4 Allow 'subject' as a synonym for 'title' Steve Kemp <steve@steve.org.uk> parents: 184 diff changeset	81 This holds the name of the post. ("Subject:" may be used as a synonym.)
82917ab0dff4 Allow 'subject' as a synonym for 'title' Steve Kemp <steve@steve.org.uk> parents: 184 diff changeset	82 If neither "Title" or "Subject" are present the filename itself is
82917ab0dff4 Allow 'subject' as a synonym for 'title' Steve Kemp <steve@steve.org.uk> parents: 184 diff changeset	83 used.
82917ab0dff4 Allow 'subject' as a synonym for 'title' Steve Kemp <steve@steve.org.uk> parents: 184 diff changeset	84
82917ab0dff4 Allow 'subject' as a synonym for 'title' Steve Kemp <steve@steve.org.uk> parents: 184 diff changeset	85
82917ab0dff4 Allow 'subject' as a synonym for 'title' Steve Kemp <steve@steve.org.uk> parents: 184 diff changeset	86 Date:
82917ab0dff4 Allow 'subject' as a synonym for 'title' Steve Kemp <steve@steve.org.uk> parents: 184 diff changeset	87 The date this entry was created. If not present the creation time
82917ab0dff4 Allow 'subject' as a synonym for 'title' Steve Kemp <steve@steve.org.uk> parents: 184 diff changeset	88 of the file is used.
82917ab0dff4 Allow 'subject' as a synonym for 'title' Steve Kemp <steve@steve.org.uk> parents: 184 diff changeset	89
82917ab0dff4 Allow 'subject' as a synonym for 'title' Steve Kemp <steve@steve.org.uk> parents: 184 diff changeset	90
199 f5873df8ec0b Briefly mention the spooler. Steve Kemp <steve@steve.org.uk> parents: 185 diff changeset	91 Publish:
f5873df8ec0b Briefly mention the spooler. Steve Kemp <steve@steve.org.uk> parents: 185 diff changeset	92 If you make use of the spooler, to automatically post pre-written entries
f5873df8ec0b Briefly mention the spooler. Steve Kemp <steve@steve.org.uk> parents: 185 diff changeset	93 on particular days, this field will specify when an entry is made live.
f5873df8ec0b Briefly mention the spooler. Steve Kemp <steve@steve.org.uk> parents: 185 diff changeset	94
f5873df8ec0b Briefly mention the spooler. Steve Kemp <steve@steve.org.uk> parents: 185 diff changeset	95
185 82917ab0dff4 Allow 'subject' as a synonym for 'title' Steve Kemp <steve@steve.org.uk> parents: 184 diff changeset	96 Tags:
218 62fd800e7777 Ran through ispell Steve Kemp <steve@steve.org.uk> parents: 199 diff changeset	97 If any tags are present they will be used to categorise the entry.
185 82917ab0dff4 Allow 'subject' as a synonym for 'title' Steve Kemp <steve@steve.org.uk> parents: 184 diff changeset	98
1 bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	99
bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	100
166 df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	101 Entry Cutting
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	102 -------------
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	103
185 82917ab0dff4 Allow 'subject' as a synonym for 'title' Steve Kemp <steve@steve.org.uk> parents: 184 diff changeset	104 If you wish you may truncate a long entry via the special <cut> tag,
82917ab0dff4 Allow 'subject' as a synonym for 'title' Steve Kemp <steve@steve.org.uk> parents: 184 diff changeset	105 for example:.
166 df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	106
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	107
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	108 /--------------------------\
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	109 This is a line of text
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	110 <cut>This is hidden
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	111 So is this
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	112 </cut>
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	113 This is displayed.
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	114 \==========================/
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	115
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	116
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	117 Or, with specific test:
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	118
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	119 /-------------------------------------------------\
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	120 This is a line of text
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	121 <cut text="Click to read more...">This is hidden
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	122 So is this
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	123 </cut>
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	124 This is displayed.
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	125 \=================================================/
df0201e39fed Added 'cut' implementation. Steve Kemp <steve@steve.org.uk> parents: 109 diff changeset	126
109 10797bf26799 Added 'COMMENTS' to the file. Steve Kemp <steve@steve.org.uk> parents: 69 diff changeset	127
199 f5873df8ec0b Briefly mention the spooler. Steve Kemp <steve@steve.org.uk> parents: 185 diff changeset	128
109 10797bf26799 Added 'COMMENTS' to the file. Steve Kemp <steve@steve.org.uk> parents: 69 diff changeset	129 Comment Support
10797bf26799 Added 'COMMENTS' to the file. Steve Kemp <steve@steve.org.uk> parents: 69 diff changeset	130 ---------------
10797bf26799 Added 'COMMENTS' to the file. Steve Kemp <steve@steve.org.uk> parents: 69 diff changeset	131
10797bf26799 Added 'COMMENTS' to the file. Steve Kemp <steve@steve.org.uk> parents: 69 diff changeset	132 The system supports the submission of user-supplied comments upon
10797bf26799 Added 'COMMENTS' to the file. Steve Kemp <steve@steve.org.uk> parents: 69 diff changeset	133 posts, for more details please see the included file COMMENTS.
10797bf26799 Added 'COMMENTS' to the file. Steve Kemp <steve@steve.org.uk> parents: 69 diff changeset	134
10797bf26799 Added 'COMMENTS' to the file. Steve Kemp <steve@steve.org.uk> parents: 69 diff changeset	135
10797bf26799 Added 'COMMENTS' to the file. Steve Kemp <steve@steve.org.uk> parents: 69 diff changeset	136
19 8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	137 Bugs?
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	138 -----
1 bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	139
19 8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	140 Please report bugs to the author, where they will be fixed as
8af29bfa35b0 2007-08-14 21:13:09 by steve steve parents: 1 diff changeset	141 quickly as possible.
1 bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	142
bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	143
bc8961a81af6 2007-08-13 22:53:14 by steve steve parents: diff changeset	144 Steve
199 f5873df8ec0b Briefly mention the spooler. Steve Kemp <steve@steve.org.uk> parents: 185 diff changeset	145 --

Mercurial > hg > chronicle

annotate README @ 263:c22641b53918