Mercurial > hg > chronicle
annotate README @ 175:887a460d77d5
Ran through perltidy
author | Steve Kemp <steve@steve.org.uk> |
---|---|
date | Tue, 01 Apr 2008 20:47:13 +0100 |
parents | df0201e39fed |
children | 3739e04097da |
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/ |
19 | 13 |
109
10797bf26799
Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
69
diff
changeset
|
14 |
10797bf26799
Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
69
diff
changeset
|
15 |
1 | 16 chronicle - A blog compiler |
17 --------------------------- | |
18 | |
19 | 19 Chronicle is a tool which will convert a directory of simple |
20 text files into a static HTML weblog, (or blog if you prefer). | |
21 | |
22 The system is intentionally simple, but it does support: | |
23 | |
24 * Template based output. | |
25 * Support for RSS feeds. | |
26 * Support for tagged entries. | |
109
10797bf26799
Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
69
diff
changeset
|
27 * Optional support for comments. |
19 | 28 |
29 | |
1 | 30 |
31 | |
32 Installation | |
33 ------------ | |
34 | |
166
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
35 It is possible to run the software without installing it, just |
19 | 36 by placing blog entries in the ./blog directory and running |
37 ./bin/chronicle. | |
38 | |
39 However it is recommended you install the software system-wide | |
40 by running "make install" as root. | |
41 | |
42 This will give you: | |
1 | 43 |
19 | 44 /usr/share/chronicle <- The theme directories. |
109
10797bf26799
Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
69
diff
changeset
|
45 /usr/bin/chronicle <- The main binary. |
19 | 46 /etc/chroniclerc <- The main configuration file. |
47 | |
48 If you wish to customise the templates it is recommended you | |
49 make a copy of them with a new name, then edit that copy. This | |
50 will prevent changes from being overwritten on upgrade. | |
51 | |
52 The configuration file may be copied to ~/.chroniclerc for | |
53 per-user configuration. | |
1 | 54 |
55 | |
56 | |
57 Blog Format | |
58 ----------- | |
59 | |
60 The blog format is very simple. Each file should start like this: | |
61 | |
19 | 62 /-- |
1 | 63 title: The title of my post |
64 date: 12 August 2007 | |
65 tags: foo, bar, baz | |
19 | 66 |
67 The text of the actual entry goes here. | |
68 | |
69 However much there is of it. | |
70 \-- | |
71 | |
1 | 72 |
73 The tags are optional, but recommended, similarly the date of the post | |
19 | 74 is used in preference to the current date if none is present. |
1 | 75 |
76 | |
166
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
77 Entry Cutting |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
78 ------------- |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
79 |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
80 If you wish to truncate an entry you may do so via the <cut> tags. |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
81 |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
82 For example: |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
83 |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
84 |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
85 /--------------------------\ |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
86 This is a line of text |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
87 <cut>This is hidden |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
88 So is this |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
89 </cut> |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
90 This is displayed. |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
91 \==========================/ |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
92 |
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 Or, with specific test: |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
95 |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
96 /-------------------------------------------------\ |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
97 This is a line of text |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
98 <cut text="Click to read more...">This is hidden |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
99 So is this |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
100 </cut> |
df0201e39fed
Added 'cut' implementation.
Steve Kemp <steve@steve.org.uk>
parents:
109
diff
changeset
|
101 This is displayed. |
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 |
109
10797bf26799
Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
69
diff
changeset
|
104 |
10797bf26799
Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
69
diff
changeset
|
105 Comment Support |
10797bf26799
Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
69
diff
changeset
|
106 --------------- |
10797bf26799
Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
69
diff
changeset
|
107 |
10797bf26799
Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
69
diff
changeset
|
108 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
|
109 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
|
110 |
10797bf26799
Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
69
diff
changeset
|
111 |
10797bf26799
Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents:
69
diff
changeset
|
112 |
19 | 113 Bugs? |
114 ----- | |
1 | 115 |
19 | 116 Please report bugs to the author, where they will be fixed as |
117 quickly as possible. | |
1 | 118 |
119 | |
120 Steve | |
121 -- |