[emacs-wiki-discuss] Planner port of Muse (was Re: Planner/Hipster/Muse thoughts)

[Michael Olson]

Chris Parsons <address@hidden> writes:

> - Use muse and it's alternate output stuff... (perhaps output to tex?) I
>   don't know much about muse yet, but it seems ideal for the sort of
>   thing I'd like to do. Has anyone taken a branch of planner and ported
>   it to muse yet?

I've taken Sacha's excellent work on the port of Planner to Muse and
hacked it up a bit.  Yann Hodique's patch was merged.  I merged the
patches from planner-dev--1.0 up through patch-396, with some
exceptions.

Please refer to Sacha's planner--muse announcement at
http://article.gmane.org/gmane.emacs.wiki.general/2195 to see what is
known to be working, her example setup, archive, and tarball.

Archive name: address@hidden
Location: http://www.mwolson.org/archives/2005
Branch: planner-muse--mwolson--1.0
Tarball: http://www.mwolson.org/static/dist/planner-muse-latest.tar.gz

Setup
-----

In order to get it to work, you will need to do the following in your
.emacs file.

 - Immediately after the (require 'planner) line, you need the
   following code.

(unless (fboundp 'planner-update-wiki-project)
  (defun planner-update-wiki-project ()
    ;; do nothing
    )
  (defvar planner-markup-tags nil))

I haven't figured out yet what should be done about this function and
variable, but things seem to work (for now) without them.  The
"(unless ...)" wrapper ensures that the function and variable will not
be overwritten (i.e. when you use the normal version of Planner).

 - After loading Muse, customize the `muse-project-alist' variable as
   follows.  If you already have Muse projects, this section can be
   appended to the existing sections without trouble.

(setq muse-project-alist
      '(("WikiPlanner"        ;; use value of `planner-project'
         ("~/Plans"           ;; where your Planner pages are located
          :default "TaskPool" ;; use value of `planner-default-page'
          :major-mode planner-mode
          :visit-link planner-visit-link)

         ;; This next part is for specifying where Planner pages
         ;; should be published and what Muse publishing style to
         ;; use.  In this example, we will use the XHTML publishing
         ;; style.

         (:base "xhtml"
                ;; value of `planner-publishing-directory'
                :path "~/public_html/Plans"))))

Here's an (untested) example of a multiple directory, multiple
publishing style entry.

(setq muse-project-alist
      '(("Plans"
         ("~/Plans/near-term"
          "~/Plans/far-term"
          "~/Plans/older"
          :default "index"
          :major-mode planner-mode
          :visit-link planner-visit-link)

         ;; pages from near-term and far-term get published to the
         ;; same directory (~/public_html/plans/) in XHTML form
         (:base "xhtml"
                :path "~/public_html/plans/"

                ;; this is a regexp that is matched against the path
                ;; to a Planner page
                :include "/\((near\\|far\\)-term/"))

                ;; we could have also written:
                ;; :exclude "/older/"

         ;; pages from the older directory get published here with
         ;; HTML style
         (:base "html"
                :path "~/public_html/plans/older/"
                :include "/older/"))))

What works
----------

 - Task lists publish as lists.
 - Buffer fontification seems to work.
 - New tasks seem to create clickable links to other Planner pages.

What doesn't work
-----------------

 - Note publishing
 - Index generation
 - Bare WikiNames (fontification or publishing)
 - ".html" gets appended to the visible names of some links

Future plans for the port
-------------------------

I would like to keep committing changes to this port.  I'm not sure if
I want it to be considered the official place for the Muse port of
Planner.  It would be nice to co-maintain this, and I hope that it is
useful to Sacha in her effort to port Planner.

I've attached the relevant ChangeLog entries since it describes the
progress of the port somewhat and lists the patches that did not go
through.

I hope to do more research on what it would take to get Wiki support
for Muse.  In particular, I wonder if an emacs-wiki minor mode would
be useful, or if I should just port the publishing code of emacs-wiki
to Muse.

-- 
Michael Olson -- FSF Associate Member #652 -- http://www.mwolson.org/
Jabber: mwolson_at_hcoop.net -- IRC: mwolson on freenode.net: #muse, #pulug
  /` |\ | | |
 |_] | \| |_|   Interests: anime, Debian GNU/Linux, XHTML, wiki, Emacs Lisp

2005-05-22 06:02:41 GMT Michael Olson <address@hidden>  patch-5

    Summary:
      Make generated lists publish correctly.
    Revision:
      planner-muse--mwolson--1.0--patch-5

    * planner.el (planner-notes-tag, planner-markup-task): Print space before
      the dash when composing a list entry.

    modified files:
     ChangeLog planner.el


2005-05-22 01:00:43 GMT Michael Olson <address@hidden>  patch-4

    Summary:
      Cause task IDs to be colored.
    Revision:
      planner-muse--mwolson--1.0--patch-4

    * planner-id.el (planner-id-setup): Since we append values to
      `muse-colors-buffer-hook' in the `planner-setup-highlighting' function,
      do so here as well.  Otherwise `planner-id-markup' never gets called.
      I think the `run-hook-with-args' function in Emacs CVS may have a bug.
    
    * planner-appt.el (planner-appt-font-setup): Ditto.

    modified files:
     ChangeLog planner-appt.el planner-id.el


2005-05-21 04:54:07 GMT Michael Olson <address@hidden>  patch-3

    Summary:
      Merge massively from sacha/367 to sacha/396, with some omissions.
    Revision:
      planner-muse--mwolson--1.0--patch-3

    I ran "tla changes emacs-wiki--dev--1.0--patch-366" while in the
    directory containing the emacs-wiki--dev--1.0 tree so that I could get a
    cumulative patch of all the changes from patch-366 to the present.  I
    merged in as much as I could.
    
    It seemed that the file permissions changed to 644 recently for files in
    the planner archive, so I followed suit.
    
    It is hoped that this effort will help Sacha keep the Muse port of
    Planner current :^) .  I haven't yet tested these changes; I should do
    that soon.
    
    Patches that did not (fully) apply:
    
     * patch-384 [Improve support for putting files in subdirectories]:
       (planner-list-daily-files): This version was significantly different
       in the Muse version, so I wasn't sure whether or not the fix was
       applicable.
    
       (planner-extract-tasks): Ditto.
    
       (planner-search-notes-internal): Ditto.
    
       (planner-past-notes-tag): This one applied cleanly.
    
     * patch-392, patch-393, patch-394, patch-395: I applied the
       documentation fixes.
    
       (planner-list-unfinished-tasks, planner-file-alist,
       planner-search-internal, planner-list-tasks-with-status): The
       cumulative patch did not apply cleanly, so these functions were left
       unaltered.
    
       (planner-past-notes-tag): The changes for this applied correctly.
    
    Patches applied:
    
     * address@hidden/planner--dev--1.0--patch-33
       Merge patch 345-352 from Sacha
    
     * address@hidden/planner--dev--1.0--patch-34
       merge patch 353-367 from main stream
    
     * address@hidden/planner--dev--1.0--patch-35
       speed up planner-rank
    
     * address@hidden/planner--dev--1.0--patch-36
       conditional require remember.el
    
     * address@hidden/planner--dev--1.0--patch-37
       Place the annotation in task title where I want
    
     * address@hidden/planner--dev--1.0--patch-38
       fix private symbal introduced yesterday
    
     * address@hidden/planner--jeho--1.0--patch-50
       planner-appt 
    
     * address@hidden/planner--jeho--1.0--patch-57
       merge latest
    
     * address@hidden/planner--jeho--1.0--patch-58
       fixed fix of planner-multi-read-name
    
     * address@hidden/planner--jeho--1.0--patch-59
       merge latest 
    
     * address@hidden/planner--jeho--1.0--patch-60
       planner-appt: create task fix, better advising, etc.
    
     * address@hidden/planner--jeho--1.0--patch-61
       merge latest
    
     * address@hidden/planner--jeho--1.0--patch-62
       with-planner-update-setup
    
     * address@hidden/planner--jeho--1.0--patch-63
       merge latest; planner-appt changes
    
     * address@hidden/planner--jeho--1.0--patch-64
       planner-el.texi: updated planner-appt node
    
     * address@hidden/planner--johnsu01--0--base-0
       tag of address@hidden/planner--dev--1.0--patch-375
    
     * address@hidden/planner--johnsu01--0--patch-1   
    
     * address@hidden/planner--johnsu01--0--patch-2
       Replaced all occurrences of PlannerMode with Planner except where
       inaccurate.
    
     * address@hidden/planner--johnsu01--0--patch-3
       planner-el.texi (Diary): Corrected instructions for showing diary
       entries for multiple days. Replaced @code's with @var where
       appropriate.
    
     * address@hidden/planner--dev--1.0--patch-367
       Always add menu to planner-mode buffers
    
     * address@hidden/planner--dev--1.0--patch-368
       Merge planner-multi-read-name bugfix from jeho
    
     * address@hidden/planner--dev--1.0--patch-369
       Bugfix: planner-timeclock-summary-proj. New:
       planner-annotation-symbol-string, planner-create-task-from-note
    
     * address@hidden/planner--dev--1.0--patch-370 New:
       planner-timewarp. Bugfix: Group .*? regexp to deal with possible
       XEmacs bug.
    
     * address@hidden/planner--dev--1.0--patch-371
       New: planner-annotation-from-dired, planner-psvn
    
     * address@hidden/planner--dev--1.0--patch-372
       Bugfix: planner-vm-browse-url
    
     * address@hidden/planner--dev--1.0--patch-373
       planner-psvn bugfix: stray paren
    
     * address@hidden/planner--dev--1.0--patch-374
       Docfix: Update URL for remind
    
     * address@hidden/planner--dev--1.0--patch-375
       Docfix: carrying over unfinished tasks.
    
     * address@hidden/planner--dev--1.0--patch-376
       planner-id bugfix (completed/cancelled tasks) and planner-el docfixes
    
     * address@hidden/planner--dev--1.0--patch-377
       planner-gnus: Pick up the group name properly
    
     * address@hidden/planner--dev--1.0--patch-378
       Merge planner-appt updates from jeho: create task fix, better advising
    
     * address@hidden/planner--dev--1.0--patch-379
       Document planner-trunk.el
    
     * address@hidden/planner--dev--1.0--patch-380
       Bugfix: planner-multi-replan-task, replace mapc with mapcar
    
     * address@hidden/planner--dev--1.0--patch-381
       planner-vm: Turn on annotations in vm-presentation-mode as well
    
     * address@hidden/planner--dev--1.0--patch-382
       XEmacs compatibility: condition-case instead of 4-arg require, XEmacs
       menu strangeness
    
     * address@hidden/planner--dev--1.0--patch-383
       planner-multi-read-name-multiple-prompts: Easier multiple inputs with
       nil default
    
     * address@hidden/planner--dev--1.0--patch-385
       Bugfix: Make planner-sort-tasks stop causing backtraces
    
     * address@hidden/planner--dev--1.0--patch-386
       Bugfix: planner-replan-note should properly add notes to
       non-wiki-named pages
    
     * address@hidden/planner--dev--1.0--patch-387
       Bugfix: planner-gnus-browse-url: Load group even if registry is not
       used
    
     * address@hidden/planner--dev--1.0--patch-388
       Tweak: planner-copy-or-move-region does not include last line if at
       start of line
    
     * address@hidden/planner--dev--1.0--patch-389
       Bugfix: planner-sort-tasks should use 5-arg sort-subr for older GNU
       Emacs
    
     * address@hidden/planner--dev--1.0--patch-390
       Bugfix: planner-sort-tasks: Remove non-fontification code
    
     * address@hidden/planner--dev--1.0--patch-391
       Sync with jeho: with-planner-update-setup returns value of body;
       planner-appt-task-appointments-section
    
     * address@hidden/planner--dev--1.0--patch-396
       NOTE: planner-tasks-file-behavior new default: 'close

    new files:
     .arch-ids/planner-psvn.el.id planner-psvn.el

    modified files:
     ChangeLog planner-appt.el planner-bookmark.el planner-diary.el
     planner-el.texi planner-gnus.el planner-id.el planner-multi.el
     planner-rank.el planner-timeclock-summary-proj.el
     planner-timeclock-summary.el planner-timeclock.el
     planner-trunk.el planner-vm.el planner.el
     
{arch}/emacs-wiki/emacs-wiki--sacha/emacs-wiki--sacha--1.0/address@hidden/patch-log/patch-5

    modified directories:
     {arch}/planner/planner--dev-kea
     {arch}/planner/planner--dev-kea/planner--dev-kea--1.0
     {arch}/planner/planner--dev-kea/planner--dev-kea--1.0/address@hidden
     
{arch}/planner/planner--dev-kea/planner--dev-kea--1.0/address@hidden/patch-log

    new patches:
    [snip]

2005-05-20 21:44:57 GMT Michael Olson <address@hidden>  patch-2

    Summary:
      Merge in Yann Hodique's planner-muse patch.
    Revision:
      planner-muse--mwolson--1.0--patch-2

    Patches applied:
    
     * address@hidden/planner--yh--1.0--patch-1
       Some hacks on planner--muse
    

    modified files:
     ChangeLog planner-gnus.el planner-log-edit.el planner-mhe.el
     planner-unix-mail.el planner.el

    new patches:
     address@hidden/planner--yh--1.0--patch-1


2005-05-20 21:20:22 GMT Michael Olson <address@hidden>  patch-1

    Summary:
      Make a new ChangeLog file.
    Revision:
      planner-muse--mwolson--1.0--patch-1


    new files:
     .arch-ids/ChangeLog.id ChangeLog

    removed files:
     .arch-ids/ChangeLog.id ChangeLog


2005-05-20 21:15:38 GMT Michael Olson <address@hidden>  base-0

    Summary:
      tag of address@hidden/planner--muse--1.0--patch-6
    Revision:
      planner-muse--mwolson--1.0--base-0

    (automatically generated log message)

    new patches:
    [snip]

pgpGDFpsn9vAR.pgp
Description: PGP signature