From 2ddeb78c8ce81177b32d32bf5a3495e03bfac687 Mon Sep 17 00:00:00 2001
From: Michael Olson <mwolson@gnu.org>
Date: Thu, 7 Jul 2005 03:16:38 +0000
Subject: [PATCH] Document new blosxom convenience feature.

* lisp/muse-blosxom.el: Document `muse-blosxom-project-alist-dirs' and
  `muse-blosxom-project-alist-entry'.  An example is provided in the
  header.

git-archimport-id: mwolson@gnu.org--2005/muse--main--1.0--patch-99
---
 ChangeLog            | 16 ++++++++++++++++
 lisp/muse-blosxom.el | 30 ++++++++++++++++++++++++++++++
 2 files changed, 46 insertions(+)

diff --git a/ChangeLog b/ChangeLog
index 1f04eb6..eae8e93 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -2,6 +2,22 @@
 # arch-tag: automatic-ChangeLog--mwolson@gnu.org--2005/muse--main--1.0
 #
 
+2005-07-07 03:16:38 GMT	Michael Olson <mwolson@gnu.org>	patch-99
+
+    Summary:
+      Document new blosxom convenience feature.
+    Revision:
+      muse--main--1.0--patch-99
+
+    * lisp/muse-blosxom.el: Document `muse-blosxom-project-alist-dirs' and
+      `muse-blosxom-project-alist-entry'.  An example is provided in the
+      header.
+    
+
+    modified files:
+     ChangeLog lisp/muse-blosxom.el
+
+
 2005-07-06 23:17:35 GMT	Michael Olson <mwolson@gnu.org>	patch-98
 
     Summary:
diff --git a/lisp/muse-blosxom.el b/lisp/muse-blosxom.el
index 78c6d33..c3be699 100644
--- a/lisp/muse-blosxom.el
+++ b/lisp/muse-blosxom.el
@@ -51,6 +51,24 @@
 ;; `hardcodedates.py' provides the second service.  Eventually it is
 ;; hoped that a blosxom plugin and script will be found/written.
 ;;
+;; Generating a project description
+;; --------------------------------
+;;
+;; Muse-blosxom has some helper functions to make specifying
+;; muse-blosxom projects a lot easier.  An example follows.
+;;
+;; (setq muse-project-alist
+;;       `(("blog"
+;;          (,@(muse-blosxom-project-alist-dirs "~/path/to/blog-entries")
+;;           :default "index")
+;;          ,@(muse-blosxom-project-alist-entry "~/path/to/blog-entries"
+;;                                              "~/public_html/blog"
+;;                                              "blosxom-xhtml")
+;;         )))
+;;
+;; Note that we need a backtick instead of a single quote on the
+;; second line of this example.
+;;
 ;; Creating new blog entries
 ;; -------------------------
 ;;
@@ -190,6 +208,13 @@ The page will be initialized with the current date and TITLE."
 ;; Make it easier to specify the muse-project-alist entry
 
 (defun muse-blosxom-project-alist-entry (entry-dir output-dir style)
+  "Return a list of styles to use when publishing a muse-blosxom project.
+ENTRY-DIR is where your Muse blog entries are kept.
+OUTPUT-DIR is where these entries are published.
+STYLE is the publishing style to use.
+
+For an example of the use of this function, see
+`examples/mwolson/muse-init.el' from the Muse distribution."
   (cons `(:base ,style :path ,(expand-file-name output-dir)
                 :include ,(concat "/" (file-name-nondirectory entry-dir)
                                   "/[^/]+$"))
@@ -200,6 +225,11 @@ The page will be initialized with the current date and TITLE."
                 (muse-blosxom-get-categories entry-dir))))
 
 (defun muse-blosxom-project-alist-dirs (entry-dir)
+  "Return a list of directories to use when publishing a muse-blosxom project.
+ENTRY-DIR is where your Muse blog entries are kept.
+
+For an example of the use of this function, see
+`examples/mwolson/muse-init.el' from the Muse distribution."
   (cons (expand-file-name entry-dir)
         (mapcar (lambda (dir) (expand-file-name dir entry-dir))
                 (muse-blosxom-get-categories entry-dir))))
-- 
2.11.4.GIT