Mercurial > hg > chronicle

comparison README @ 199:f5873df8ec0b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Briefly mention the spooler.
author Steve Kemp <steve@steve.org.uk>
date Mon, 14 Apr 2008 18:55:35 +0100
parents 82917ab0dff4
children 62fd800e7777
comparison
equal deleted inserted replaced
198:889827a88e34 199:f5873df8ec0b
42 42
43 This will give you: 43 This will give you:
44 44
45 /usr/share/chronicle <- The theme directories. 45 /usr/share/chronicle <- The theme directories.
46 /usr/bin/chronicle <- The main binary. 46 /usr/bin/chronicle <- The main binary.
47 /usr/bin/chronicle-spooler <- A simple helper.
47 /etc/chroniclerc <- The global configuration file. 48 /etc/chroniclerc <- The global configuration file.
48 49
49 If you wish to customise the templates it is recommended you 50 If you wish to customise the templates it is recommended you
50 make a copy of them with a new name, then edit that copy. This 51 make a copy of them with a new name, then edit that copy. This
51 will prevent changes from being overwritten on upgrade. 52 will prevent changes from being overwritten on upgrade.
69 70
70 However much there is of it. 71 However much there is of it.
71 \-- 72 \--
72 73
73 74
74 The three key fields are: 75
76 The entries are aided by a psuedo-header. This header contains
77 entries which are used by Chronicle to build your blog. The entries
78 themselves are not included in your output HTML.
75 79
76 Title: 80 Title:
77 This holds the name of the post. ("Subject:" may be used as a synonym.) 81 This holds the name of the post. ("Subject:" may be used as a synonym.)
78 If neither "Title" or "Subject" are present the filename itself is 82 If neither "Title" or "Subject" are present the filename itself is
79 used. 83 used.
80 84
81 85
82 Date: 86 Date:
83 The date this entry was created. If not present the creation time 87 The date this entry was created. If not present the creation time
84 of the file is used. 88 of the file is used.
89
90
91 Publish:
92 If you make use of the spooler, to automatically post pre-written entries
93 on particular days, this field will specify when an entry is made live.
85 94
86 95
87 Tags: 96 Tags:
88 If any tags are present they will be used to catagorise the entry. 97 If any tags are present they will be used to catagorise the entry.
89 98
114 </cut> 123 </cut>
115 This is displayed. 124 This is displayed.
116 \=================================================/ 125 \=================================================/
117 126
118 127
128
119 Comment Support 129 Comment Support
120 --------------- 130 ---------------
121 131
122 The system supports the submission of user-supplied comments upon 132 The system supports the submission of user-supplied comments upon
123 posts, for more details please see the included file COMMENTS. 133 posts, for more details please see the included file COMMENTS.