36bbbb40b97442e807b851509ad4757e2690fbc8
| blob | 36bbbb40b97442e807b851509ad4757e2690fbc8 |
1 ;;; muse-blosxom.el --- publish a document tree for serving by (py)Blosxom
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
5 ;; Author: Michael Olson <mwolson@gnu.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 3, 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. On the
54 ;; plus side, there is no need to run a script to gather the date. On
55 ;; the downside, each entry is read twice rather than once when the
56 ;; page is rendered. Set the value of muse-blosxom-use-metadate to
57 ;; non-nil to enable adding a #postdate directive to all published
58 ;; files. You can do this by:
59 ;;
60 ;; M-x customize-variable RET muse-blosxom-use-metadate RET
61 ;;
62 ;; With the metadate plugin installed in pyblosxom, the date set in
63 ;; this directive will be used instead of the file's modification
64 ;; time. The plugin is included with Muse at
65 ;; contrib/pyblosxom/metadate.py.
66 ;;
67 ;; Generating a Muse project entry
68 ;; -------------------------------
69 ;;
70 ;; Muse-blosxom has some helper functions to make specifying
71 ;; muse-blosxom projects a lot easier. An example follows.
72 ;;
73 ;; (setq muse-project-alist
74 ;; `(("blog"
75 ;; (,@(muse-project-alist-dirs "~/path/to/blog-entries")
76 ;; :default "index")
77 ;; ,@(muse-project-alist-styles "~/path/to/blog-entries"
78 ;; "~/public_html/blog"
79 ;; "blosxom-xhtml")
80 ;; )))
81 ;;
82 ;; Note that we need a backtick instead of a single quote on the
83 ;; second line of this example.
84 ;;
85 ;; Creating new blog entries
86 ;; -------------------------
87 ;;
88 ;; There is a function called `muse-blosxom-new-entry' that will
89 ;; automate the process of making a new blog entry. To make use of
90 ;; it, do the following.
91 ;;
92 ;; - Customize `muse-blosxom-base-directory' to the location that
93 ;; your blog entries are stored.
94 ;;
95 ;; - Assign the `muse-blosxom-new-entry' function to a key sequence.
96 ;; I use the following code to assign this function to `C-c p l'.
97 ;;
98 ;; (global-set-key "\C-cpl" 'muse-blosxom-new-entry)
99 ;;
100 ;; - You should create your directory structure ahead of time under
101 ;; your base directory. These directories, which correspond with
102 ;; category names, may be nested.
103 ;;
104 ;; - When you enter this key sequence, you will be prompted for the
105 ;; category of your entry and its title. Upon entering this
106 ;; information, a new file will be created that corresponds with
107 ;; the title, but in lowercase letters and having special
108 ;; characters converted to underscores. The title and date
109 ;; directives will be inserted automatically.
110 ;;
111 ;; Using tags
112 ;; ----------
113 ;;
114 ;; If you wish to keep all of your blog entries in one directory and
115 ;; use tags to classify your entries, set `muse-blosxom-use-tags' to
116 ;; non-nil.
117 ;;
118 ;; For this to work, you will need to be using the PyBlosxom plugin at
119 ;; http://pyblosxom.sourceforge.net/blog/registry/meta/Tags.
121 ;;; Contributors:
123 ;; Gary Vaughan (gary AT gnu DOT org) is the original author of
124 ;; `emacs-wiki-blosxom.el', which is the ancestor of this file.
126 ;; Brad Collins (brad AT chenla DOT org) ported this file to Muse.
128 ;; Björn Lindström (bkhl AT elektrubadur DOT se) made many valuable
129 ;; suggestions.
131 ;; Sasha Kovar (sasha AT arcocene DOT org) fixed
132 ;; muse-blosxom-new-entry when using tags and also implemented support
133 ;; for the #postdate directive.
135 ;;; Code:
137 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
138 ;;
139 ;; Muse Blosxom Publishing
140 ;;
141 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
148 "Options controlling the behavior of Muse Blosxom publishing.
149 See `muse-blosxom' for more information."
153 "Default file extension for publishing Blosxom files."
159 (when muse-blosxom-use-metadate
163 (when muse-blosxom-use-tags
166 "Header used for publishing Blosxom files. This may be text or a filename."
171 "Footer used for publishing Blosxom files. This may be text or a filename."
176 "Base directory of blog entries.
177 This is the top-level directory where your Muse blog entries may be found."
182 "Determine whether or not to enable use of the #tags directive.
184 If you wish to keep all of your blog entries in one directory and
185 use tags to classify your entries, set `muse-blosxom-use-tags' to
186 non-nil.
188 For this to work, you will need to be using the PyBlosxom plugin
189 at http://pyblosxom.sourceforge.net/blog/registry/meta/Tags."
194 "Determine whether or not to use the #postdate directive.
196 If non-nil, published entries include the original date (as specified
197 in the muse #date line) which can be read by the metadate PyBlosxom
198 plugin.
200 For this to work, you will need to be using the PyBlosxom plugin
201 at http://pyblosxom.sourceforge.net/blog/registry/date/metadate."
205 ;; Maintain (published-file . date) alist, which will later be written
206 ;; to a timestamps file; not implemented yet.
211 "Add a date entry to `muse-blosxom-page-date-alist' for this page."
213 ;; Make current file be relative to base directory
223 ;; Strip the file extension
227 rel-file)
229 ;; Add to page-date alist
231 'muse-blosxom-page-date-alist
234 ;; Enter a new blog entry
237 "Derive a file name from the given TITLE.
239 Feel free to overwrite this if you have a different concept of what
240 should be allowed in a filename."
245 "Convert a date string to PyBlosxom metadate plugin format."
248 ;;;###autoload
250 "Start a new blog entry with given CATEGORY.
251 The filename of the blog entry is derived from TITLE.
252 The page will be initialized with the current date and TITLE."
261 tags)
263 "Category: "
265 muse-blosxom-base-directory))))
269 file "blosxom" nil
285 ;;; Register the Muse Blosxom Publisher
305 ;;; muse-blosxom.el ends here