1
|
1
|
19
|
2 Homepage:
|
|
3 http://www.steve.org.uk/Software/chronicle/
|
|
4
|
|
5 CVS Repository:
|
|
6 http://chronicle.cvsrepository.org/
|
|
7
|
|
8
|
|
9
|
|
10
|
1
|
11 chronicle - A blog compiler
|
|
12 ---------------------------
|
|
13
|
19
|
14 Chronicle is a tool which will convert a directory of simple
|
|
15 text files into a static HTML weblog, (or blog if you prefer).
|
|
16
|
|
17 The system is intentionally simple, but it does support:
|
|
18
|
|
19 * Template based output.
|
1
|
20
|
19
|
21 * Support for RSS feeds.
|
|
22
|
|
23 * Support for tagged entries.
|
|
24
|
|
25
|
|
26
|
1
|
27
|
|
28
|
|
29 Installation
|
|
30 ------------
|
|
31
|
19
|
32 It is possible to run the software without installing it, just
|
|
33 by placing blog entries in the ./blog directory and running
|
|
34 ./bin/chronicle.
|
|
35
|
|
36 However it is recommended you install the software system-wide
|
|
37 by running "make install" as root.
|
|
38
|
|
39 This will give you:
|
1
|
40
|
19
|
41 /usr/share/chronicle <- The theme directories.
|
|
42 /usr/local/bin/chronicle <- The main binary.
|
|
43 /etc/chroniclerc <- The main configuration file.
|
|
44
|
|
45 If you wish to customise the templates it is recommended you
|
|
46 make a copy of them with a new name, then edit that copy. This
|
|
47 will prevent changes from being overwritten on upgrade.
|
|
48
|
|
49 The configuration file may be copied to ~/.chroniclerc for
|
|
50 per-user configuration.
|
1
|
51
|
|
52
|
|
53
|
|
54 Blog Format
|
|
55 -----------
|
|
56
|
|
57 The blog format is very simple. Each file should start like this:
|
|
58
|
19
|
59 /--
|
1
|
60 title: The title of my post
|
|
61 date: 12 August 2007
|
|
62 tags: foo, bar, baz
|
19
|
63
|
|
64 The text of the actual entry goes here.
|
|
65
|
|
66 However much there is of it.
|
|
67 \--
|
|
68
|
1
|
69
|
|
70 The tags are optional, but recommended, similarly the date of the post
|
19
|
71 is used in preference to the current date if none is present.
|
1
|
72
|
|
73
|
19
|
74 Bugs?
|
|
75 -----
|
1
|
76
|
19
|
77 Please report bugs to the author, where they will be fixed as
|
|
78 quickly as possible.
|
1
|
79
|
|
80
|
|
81 Steve
|
|
82 -- |