| blob | 4eade48d062e9f728102304f1c765ff33c408ebf |
1 ;;; muse-blosxom.el --- Publish a document tree for serving by (py)Blosxom
3 ;; Copyright (C) 2004, 2005 Free Software Foundation, Inc.
5 ;; Date: Wed, 23 March 2005
6 ;; Author: Michael Olson (mwolson AT gnu DOT org)
7 ;; Maintainer: Michael Olson (mwolson AT gnu DOT org)
9 ;; This file is not part of GNU Emacs.
11 ;; This is free software; you can redistribute it and/or modify it under
12 ;; the terms of the GNU General Public License as published by the Free
13 ;; Software Foundation; either version 2, or (at your option) any later
14 ;; version.
15 ;;
16 ;; This is distributed in the hope that it will be useful, but WITHOUT
17 ;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18 ;; FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19 ;; for more details.
20 ;;
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;; The Blosxom publishing style publishes a tree of categorised files
29 ;; to a mirrored tree of stories to be served by blosxom.cgi or
30 ;; pyblosxom.cgi.
31 ;;
32 ;; Serving entries with (py)blosxom
33 ;; --------------------------------
34 ;;
35 ;; Each Blosxom file must include `#date yyyy-mm-dd', or optionally
36 ;; the longer `#date yyyy-mm-dd-hh-mm', a title (using the `#title'
37 ;; directive) plus whatever normal content is desired.
38 ;;
39 ;; The date directive is not used directly by (py)blosxom or this
40 ;; program. You need to find two additional items to make use of this
41 ;; feature.
42 ;;
43 ;; 1. A script to gather date directives from the entire blog tree
44 ;; into a single file. The file must associate a blog entry with
45 ;; a date.
46 ;;
47 ;; 2. A plugin for (py)blosxom that reads this file.
48 ;;
49 ;; These 2 things are provided for pyblosxom in the contrib/pyblosxom
50 ;; subdirectory. `getstamps.py' provides the 1st service, while
51 ;; `hardcodedates.py' provides the second service. Eventually it is
52 ;; hoped that a blosxom plugin and script will be found/written.
53 ;;
54 ;; Generating a project description
55 ;; --------------------------------
56 ;;
57 ;; Muse-blosxom has some helper functions to make specifying
58 ;; muse-blosxom projects a lot easier. An example follows.
59 ;;
60 ;; (setq muse-project-alist
61 ;; `(("blog"
62 ;; (,@(muse-project-alist-dirs "~/path/to/blog-entries")
63 ;; :default "index")
64 ;; ,@(muse-project-alist-styles "~/path/to/blog-entries"
65 ;; "~/public_html/blog"
66 ;; "blosxom-xhtml")
67 ;; )))
68 ;;
69 ;; Note that we need a backtick instead of a single quote on the
70 ;; second line of this example.
71 ;;
72 ;; Creating new blog entries
73 ;; -------------------------
74 ;;
75 ;; There is a function called `muse-blosxom-new-entry' that will
76 ;; automate the process of making a new blog entry. To make use of
77 ;; it, do the following.
78 ;;
79 ;; - Customize `muse-blosxom-base-directory' to the location that
80 ;; your blog entries are stored.
81 ;;
82 ;; - Assign the `muse-blosxom-new-entry' function to a key sequence.
83 ;; I use the following code to assign this function to `C-c p l'.
84 ;;
85 ;; (global-set-key "\C-cpl" 'muse-blosxom-new-entry)
86 ;;
87 ;; - You should create your directory structure ahead of time under
88 ;; your base directory. These directories, which correspond with
89 ;; category names, may be nested.
90 ;;
91 ;; - When you enter this key sequence, you will be prompted for the
92 ;; category of your entry and its title. Upon entering this
93 ;; information, a new file will be created that corresponds with
94 ;; the title, but in lowercase letters and having special
95 ;; characters converted to underscores. The title and date
96 ;; directives will be inserted automatically.
98 ;;; Contributors:
100 ;; Gary Vaughan (gary AT gnu DOT org) is the original author of
101 ;; `emacs-wiki-blosxom.el', which is the ancestor of this file.
102 ;;
103 ;; Brad Collins (brad AT chenla DOT org) ported this file to Muse.
104 ;;
105 ;; Michael Olson (mwolson AT gnu DOT org) further adapted this file to
106 ;; Muse and continues to maintain it.
107 ;;
108 ;; Björn Lindström (bkhl AT elektrubadur DOT se) made many valuable
109 ;; suggestions.
111 ;;; Code:
113 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
114 ;;
115 ;; Muse Blosxom Publishing
116 ;;
117 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
124 "Options controlling the behavior of Muse Blosxom publishing.
125 See `muse-blosxom' for more information."
129 "Default file extension for publishing Blosxom files."
135 "Header used for publishing Blosxom files. This may be text or a filename."
140 "Footer used for publishing Blosxom files. This may be text or a filename."
145 "Base directory of blog entries.
146 This is the top-level directory where your Muse blog entries may be found."
150 ;; Maintain (published-file . date) alist, which will later be written
151 ;; to a timestamps file; not implemented yet.
156 "Add a date entry to `muse-blosxom-page-date-alist' for this page."
157 ;; Make current file be relative to base directory
167 ;; Strip the file extension
171 rel-file)
173 ;; Add to page-date alist
175 'muse-blosxom-page-date-alist
178 ;; Enter a new blog entry
181 "Derive a file name from the given TITLE.
183 Feel free to overwrite this if you have a different concept of what
184 should be allowed in a filename."
189 "Start a new blog entry with given CATEGORY.
190 The filename of the blog entry is derived from TITLE.
191 The page will be initialized with the current date and TITLE."
196 muse-blosxom-base-directory)))
200 file "blosxom" nil
210 ;; Register the Blosxom Publisher
227 ;;; muse-blosxom.el ends here