update documentation
[cmcms:cmcms.git] / README
1 cmcms == CMCMS Content Management System
2 ========================================
3
4 Usage
5 -----
6
7 ./src/cmcms.sh help           display usage information
8 ./src/cmcms.sh version        display version information
9 ./src/cmcms.sh init           initialize a new empty site
10 ./src/cmcms.sh add            add a new page
11 ./src/cmcms.sh gen [config]   generate output site from "config"
12
13 See also the provided 'example/'.
14
15
16 Usage Examples
17 --------------
18
19 ----8<----
20 example $ ../src/cmcms.sh add
21 date       : 2010-09-12T17:27:14+0100
22 title      : Quux
23 url        : 2010-09-12_quux
24 summary    : Moar Metasyntax
25 tag(s)     : metasyntactic variable
26 gallery(s) : 
27 output saved to `pages/2010-09-12_quux.xml', now edit it to add content
28 ----8<----
29
30 ----8<----
31 example $ ../src/cmcms.sh gen example.conf
32 Configuring...
33 Setting up...
34 Generating tag cloud...
35 Generating recent posts...
36 Generating header and footer...
37 Generating galleries...
38 Generating content pages...
39 Generating tag pages...
40 Generating index page...
41 Generating tag RSS feeds...
42 Generating main RSS feed...
43 Copying static content...
44 Copying gallery images...
45 Updating gallery thumbnails...
46 Done!
47 ----8<----
48
49
50 Configuration file
51 ------------------
52
53 NAME    The name of the site; appears in titles, feeds, ...
54 URL     The base url of the output site; appears in RSS feeds.
55 OUT     The output directory; relative to config file or absolute.
56 TMP     Temporary directory; relative to config file or absolute.
57 THUMB   Thumbnail geometry.
58
59
60 Hardcoded paths (relative to configuration file)
61 ------------------------------------------------
62
63 pages/*.xml             page definititions
64 gallery/*/*.(jpg|png)   original gallery images
65 static/*                extra files to copy to output
66 static/cmcms.css        main default screen stylesheet
67 static/print.css        printable format stylesheet
68 theme/header.xml        page header xhtml snippet
69 theme/footer.xml        page footer xhtml snippet
70
71
72 Hardcoded urls (relative to output directory)
73 ---------------------------------------------
74
75 index.html    main view
76 {tag}.html    tag view
77 {page}.html   page view
78 index.rss     main RSS feed
79 {tag}.rss     tag RSS feed
80 cmcms.css     screen stylesheet
81 print.css     print stylesheet
82
83 g/{gallery}/{image}.(jpg|png)   original images
84 g/{gallery}/{image}_thumb.jpg   generated thumbnails
85
86
87 Hardcoded texts
88 ---------------
89
90 " :: " separates pagename from sitename in <title> tag of HTML and RSS
91 probably some other stuff...
92
93
94 Legal
95 -----
96
97 Copyright (C) 2008,2009,2010  Claude Heiland-Allen <claudiusmaximus@goto10.org>
98
99 This program is free software: you can redistribute it and/or modify
100 it under the terms of the GNU Affero General Public License as published by
101 the Free Software Foundation, either version 3 of the License, or
102 (at your option) any later version.
103
104 This program is distributed in the hope that it will be useful,
105 but WITHOUT ANY WARRANTY; without even the implied warranty of
106 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
107 GNU Affero General Public License for more details.
108
109 You should have received a copy of the GNU Affero General Public License
110 along with this program.  If not, see <http://www.gnu.org/licenses/>.