Mercurial > hg > chronicle
annotate README @ 191:fdadb51523fc
Added tag release-2.5 for changeset 4584897766c1
author | Steve Kemp <steve@steve.org.uk> |
---|---|
date | Wed, 02 Apr 2008 15:16:05 +0100 |
parents | 82917ab0dff4 |
children | f5873df8ec0b |
rev | line source |
---|---|
1 | 1 |
19 | 2 Homepage: |
3 http://www.steve.org.uk/Software/chronicle/ | |
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 | 7 |
69 | 8 Sample Output: |
9 http://www.steve.org.uk/Software/chronicle/demo/ | |
19 | 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 | 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 | 18 --------------------------- |
19 | |
19 | 20 Chronicle is a tool which will convert a directory of simple |
21 text files into a static HTML weblog, (or blog if you prefer). | |
22 | |
23 The system is intentionally simple, but it does support: | |
24 | |
25 * Template based output. | |
26 * Support for RSS feeds. | |
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 | 29 |
30 | |
1 | 31 |
32 | |
33 Installation | |
34 ------------ | |
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 | 37 by placing blog entries in the ./blog directory and running |
38 ./bin/chronicle. | |
39 | |
40 However it is recommended you install the software system-wide | |
41 by running "make install" as root. | |
42 | |
43 This will give you: | |
1 | 44 |
19 | 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. |
185
82917ab0dff4
Allow 'subject' as a synonym for 'title'
Steve Kemp <steve@steve.org.uk>
parents:
184
diff
changeset
|
47 /etc/chroniclerc <- The global configuration file. |
19 | 48 |
49 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 will prevent changes from being overwritten on upgrade. | |
52 | |
53 The configuration file may be copied to ~/.chroniclerc for | |
54 per-user configuration. | |
1 | 55 |
56 | |
57 | |
58 Blog Format | |
59 ----------- | |
60 | |
61 The blog format is very simple. Each file should start like this: | |
62 | |
19 | 63 /-- |
1 | 64 title: The title of my post |
65 date: 12 August 2007 | |
66 tags: foo, bar, baz | |
19 | 67 |
68 The text of the actual entry goes here. | |
69 | |
70 However much there is of it. | |
71 \-- | |
72 | |
1 | 73 |
185
82917ab0dff4
Allow 'subject' as a synonym for 'title'
Steve Kemp <steve@steve.org.uk>
parents:
184
diff
changeset
|
74 The three key fields are: |
82917ab0dff4
Allow 'subject' as a synonym for 'title'
Steve Kemp <steve@steve.org.uk>
parents:
184
diff
changeset
|
75 |
82917ab0dff4
Allow 'subject' as a synonym for 'title'
Steve Kemp <steve@steve.org.uk>
parents:
184
diff
changeset
|
76 Title: |
82917ab0dff4
Allow 'subject' as a synonym for 'title'
Steve Kemp <steve@steve.org.uk>
parents:
184
diff
changeset
|
77 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
|
78 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
|
79 used. |
82917ab0dff4
Allow 'subject' as a synonym for 'title'
Steve Kemp <steve@steve.org.uk>
parents:
184
diff
changeset
|
80 |
82917ab0dff4
Allow 'subject' as a synonym for 'title'
Steve Kemp <steve@steve.org.uk>
parents:
184
diff
changeset
|
81 |
82917ab0dff4
Allow 'subject' as a synonym for 'title'
Steve Kemp <steve@steve.org.uk>
parents:
184
diff
changeset
|
82 Date: |
82917ab0dff4
Allow 'subject' as a synonym for 'title'
Steve Kemp <steve@steve.org.uk>
parents:
184
diff
changeset
|
83 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
|
84 of the file is used. |
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 |
82917ab0dff4
Allow 'subject' as a synonym for 'title'
Steve Kemp <steve@steve.org.uk>
parents:
184
diff
changeset
|
87 Tags: |
82917ab0dff4
Allow 'subject' as a synonym for 'title'
Steve Kemp <steve@steve.org.uk>
parents:
184
diff
changeset
|
88 If any tags are present they will be used to catagorise the entry. |
82917ab0dff4
Allow 'subject' as a synonym for 'title'
Steve Kemp <steve@steve.org.uk>
parents:
184
diff
changeset
|
89 |
1 | 90 |
91 | |
166
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
92 Entry Cutting |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
93 ------------- |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
94 |
185
82917ab0dff4
Allow 'subject' as a synonym for 'title'
Steve Kemp <steve@steve.org.uk>
parents:
184
diff
changeset
|
95 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
|
96 for example:. |
166
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
97 |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
98 |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
99 /--------------------------\ |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
100 This is a line of text |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
101 <cut>This is hidden |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
102 So is this |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
103 </cut> |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
104 This is displayed. |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
105 \==========================/ |
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 Or, with specific test: |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
109 |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
110 /-------------------------------------------------\ |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
111 This is a line of text |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
112 <cut text="Click to read more...">This is hidden |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
113 So is this |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
114 </cut> |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
115 This is displayed. |
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 |
109
10797bf26799
Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
69
diff
changeset
|
118 |
10797bf26799
Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
69
diff
changeset
|
119 Comment Support |
10797bf26799
Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
69
diff
changeset
|
120 --------------- |
10797bf26799
Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
69
diff
changeset
|
121 |
10797bf26799
Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
69
diff
changeset
|
122 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
|
123 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
|
124 |
10797bf26799
Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
69
diff
changeset
|
125 |
10797bf26799
Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
69
diff
changeset
|
126 |
19 | 127 Bugs? |
128 ----- | |
1 | 129 |
19 | 130 Please report bugs to the author, where they will be fixed as |
131 quickly as possible. | |
1 | 132 |
133 | |
134 Steve | |
135 -- |