[emacs-wiki-discuss] migration notes: from emacs-wiki to muse

[Evan MONROIG]

Hi,

I have just migrated from emacs-wiki/planner to muse/planner. I thought
that someone my find my migration notes interesting. 

1) migration notes

My distribution is Ubuntu Breezy (5.10), and my software versions were

emacs21 21.4a-1ubuntu1
planner-el 3.30-1
emacs-wiki 2.69-1

Before anything, I made a backup of my planner files (that I do all the
time anyway, by means of version control of my planner directory). 

As explained in the documentation [1], I added one line to my
/etc/apt/sources.list

deb http://www.mwolson.org/debian/ ./

and installed the package muse. I also upgraded planner-el and removed
emacs-wiki. 

Then I added a few lines to my .emacs file based on suggestions found in
emacswiki [2]: 

---
(require 'muse-mode)
(require 'muse-colors)
(require 'muse-wiki)
(require 'muse-html)
(require 'muse-latex)

(setq planner-project "WikiPlanner")
(setq muse-project-alist
      '(("WikiPlanner"        ;; use value of `planner-project'
         ("~/planner/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 "planner-xhtml"
                ;; value of `planner-publishing-directory'
                :path "~/planner/pub/xhtml"))))

(require 'planner)
(require 'planner-publish)
---

And I launched emacs. An error made me think that I would be good to
remove emacs-wiki related settings that I had in my .emacs, which I
did. 

I closed emacs and launched it again. This time, I could see today's
page, but all my tasks and notes had disappeared... After two minutes of
thinking I found that muse wants its files to have the extension
".muse", so that it thought that I had no planner files. 

I closed emacs again, renamed all files with the following commands (if
you don't use svn you might want to change the following lines a bit) 

cd ~/planner/plans
for i in *; do svn mv $i $i.muse; done

and opened emacs again, which showed me my files :).

2) first impressions

- The color of the links is now bright green instead of blue, which I
  find a little tiring for the eyes. 

- The extension ".muse" is nice if you have files other than planner
  files in the same directory, but it adds complexity. For example if
  you have a few plan pages like 'Emacs' and 'EmacsTips', now you have
  to press "E <TAB> . <TAB> <Enter" to in the mini-buffer to find the
  'Emacs' page, instead of "E <TAB> <Enter>". 

- Default publishing to html produces a nicer output

- I had hoped to be able to publish to pdf but it fails, most probably
  because I have japanese characters in my files. According to the
  documentation, there are some latexcjk settings, so it may be just me
  not doing it right..

3) removing the .muse extension

For reasons stated above, I would like to use muse without .muse
extension on all files. Following the documentation [3], I added two
lines to my .emacs

(setq muse-file-extension nil
      muse-mode-auto-p t)

and renamed all my files.

However, starting emacs again gives me the following error: "This is not
a planner buffer".

Evan

[1] http://www.mwolson.org/static/doc/muse.html#Obtaining-Muse

[2] http://www.emacswiki.org/cgi-bin/wiki/PlannerMusePort

[3] http://www.mwolson.org/static/doc/muse.html#Projects