| blob | 34e821d03c6d9e18d66ce37e1520dd58ad819669 |
1 ;;; muse-blosxom.el --- publish a document tree for serving by (py)Blosxom
3 ;; Copyright (C) 2004, 2005, 2006 Free Software Foundation, Inc.
5 ;; Author: Michael Olson (mwolson AT gnu DOT org)
6 ;; Date: Wed, 23 March 2005
8 ;; This file is part of Emacs Muse. It is not part of GNU Emacs.
10 ;; Emacs Muse is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published
12 ;; by the Free Software Foundation; either version 2, or (at your
13 ;; option) any later version.
15 ;; Emacs Muse is distributed in the hope that it will be useful, but
16 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 ;; General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with Emacs Muse; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
25 ;;; Commentary:
27 ;; The Blosxom publishing style publishes a tree of categorised files
28 ;; to a mirrored tree of stories to be served by blosxom.cgi or
29 ;; pyblosxom.cgi.
30 ;;
31 ;; Serving entries with (py)blosxom
32 ;; --------------------------------
33 ;;
34 ;; Each Blosxom file must include `#date yyyy-mm-dd', or optionally
35 ;; the longer `#date yyyy-mm-dd-hh-mm', a title (using the `#title'
36 ;; directive) plus whatever normal content is desired.
37 ;;
38 ;; The date directive is not used directly by (py)blosxom or this
39 ;; program. You need to find two additional items to make use of this
40 ;; feature.
41 ;;
42 ;; 1. A script to gather date directives from the entire blog tree
43 ;; into a single file. The file must associate a blog entry with
44 ;; a date.
45 ;;
46 ;; 2. A plugin for (py)blosxom that reads this file.
47 ;;
48 ;; These 2 things are provided for pyblosxom in the contrib/pyblosxom
49 ;; subdirectory. `getstamps.py' provides the 1st service, while
50 ;; `hardcodedates.py' provides the second service. Eventually it is
51 ;; hoped that a blosxom plugin and script will be found/written.
52 ;;
53 ;; Alternately, the pyblosxom metadate plugin may be used. Set the
54 ;; value of muse-blosxom-use-metadate to non-nil to enable adding a
55 ;; #postdate directive to all published files. You can do this by:
56 ;;
57 ;; M-x customize-variable RET muse-blosxom-use-metadate RET
58 ;;
59 ;; With the metadate plugin installed in pyblosxom, the date set in
60 ;; this directive will be used instead of the file's modification
61 ;; time. The plugin is available at:
62 ;; http://pyblosxom.sourceforge.net/blog/registry/date/metadate
63 ;;
64 ;; Generating a Muse project entry
65 ;; -------------------------------
66 ;;
67 ;; Muse-blosxom has some helper functions to make specifying
68 ;; muse-blosxom projects a lot easier. An example follows.
69 ;;
70 ;; (setq muse-project-alist
71 ;; `(("blog"
72 ;; (,@(muse-project-alist-dirs "~/path/to/blog-entries")
73 ;; :default "index")
74 ;; ,@(muse-project-alist-styles "~/path/to/blog-entries"
75 ;; "~/public_html/blog"
76 ;; "blosxom-xhtml")
77 ;; )))
78 ;;
79 ;; Note that we need a backtick instead of a single quote on the
80 ;; second line of this example.
81 ;;
82 ;; Creating new blog entries
83 ;; -------------------------
84 ;;
85 ;; There is a function called `muse-blosxom-new-entry' that will
86 ;; automate the process of making a new blog entry. To make use of
87 ;; it, do the following.
88 ;;
89 ;; - Customize `muse-blosxom-base-directory' to the location that
90 ;; your blog entries are stored.
91 ;;
92 ;; - Assign the `muse-blosxom-new-entry' function to a key sequence.
93 ;; I use the following code to assign this function to `C-c p l'.
94 ;;
95 ;; (global-set-key "\C-cpl" 'muse-blosxom-new-entry)
96 ;;
97 ;; - You should create your directory structure ahead of time under
98 ;; your base directory. These directories, which correspond with
99 ;; category names, may be nested.
100 ;;
101 ;; - When you enter this key sequence, you will be prompted for the
102 ;; category of your entry and its title. Upon entering this
103 ;; information, a new file will be created that corresponds with
104 ;; the title, but in lowercase letters and having special
105 ;; characters converted to underscores. The title and date
106 ;; directives will be inserted automatically.
107 ;;
108 ;; Using tags
109 ;; ----------
110 ;;
111 ;; If you wish to keep all of your blog entries in one directory and
112 ;; use tags to classify your entries, set `muse-blosxom-use-tags' to
113 ;; non-nil.
114 ;;
115 ;; For this to work, you will need to be using the PyBlosxom plugin at
116 ;; http://pyblosxom.sourceforge.net/blog/registry/meta/Tags.
118 ;;; Contributors:
120 ;; Gary Vaughan (gary AT gnu DOT org) is the original author of
121 ;; `emacs-wiki-blosxom.el', which is the ancestor of this file.
123 ;; Brad Collins (brad AT chenla DOT org) ported this file to Muse.
125 ;; Björn Lindström (bkhl AT elektrubadur DOT se) made many valuable
126 ;; suggestions.
128 ;; Sasha Kovar (sasha AT arcocene DOT org) fixed
129 ;; muse-blosxom-new-entry when using tags and also implemented support
130 ;; for the #postdate directive.
132 ;;; Code:
134 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
135 ;;
136 ;; Muse Blosxom Publishing
137 ;;
138 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
145 "Options controlling the behavior of Muse Blosxom publishing.
146 See `muse-blosxom' for more information."
150 "Default file extension for publishing Blosxom files."
156 (when muse-blosxom-use-metadate
160 (when muse-blosxom-use-tags
163 "Header used for publishing Blosxom files. This may be text or a filename."
168 "Footer used for publishing Blosxom files. This may be text or a filename."
173 "Base directory of blog entries.
174 This is the top-level directory where your Muse blog entries may be found."
179 "Determine whether or not to enable use of the #tags directive.
181 If you wish to keep all of your blog entries in one directory and
182 use tags to classify your entries, set `muse-blosxom-use-tags' to
183 non-nil.
185 For this to work, you will need to be using the PyBlosxom plugin
186 at http://pyblosxom.sourceforge.net/blog/registry/meta/Tags."
191 "Determine whether or not to use the #postdate directive.
193 If non-nil, published entries include the original date (as specified
194 in the muse #date line) which can be read by the metadate PyBlosxom
195 plugin.
197 For this to work, you will need to be using the PyBlosxom plugin
198 at http://pyblosxom.sourceforge.net/blog/registry/date/metadate."
202 ;; Maintain (published-file . date) alist, which will later be written
203 ;; to a timestamps file; not implemented yet.
208 "Add a date entry to `muse-blosxom-page-date-alist' for this page."
209 ;; Make current file be relative to base directory
219 ;; Strip the file extension
223 rel-file)
225 ;; Add to page-date alist
227 'muse-blosxom-page-date-alist
230 ;; Enter a new blog entry
233 "Derive a file name from the given TITLE.
235 Feel free to overwrite this if you have a different concept of what
236 should be allowed in a filename."
241 "Convert a date string to PyBlosxom metadate plugin format."
244 ;;;###autoload
246 "Start a new blog entry with given CATEGORY.
247 The filename of the blog entry is derived from TITLE.
248 The page will be initialized with the current date and TITLE."
257 tags)
260 muse-blosxom-base-directory))))
264 file "blosxom" nil
280 ;;; Register the Muse Blosxom Publisher
300 ;;; muse-blosxom.el ends here