etc/emacs-wiki-migration.txt

   1
   2 This document describes the process of migrating from emacs-wiki to Muse.
   3
   4 Features
   5 ========
   6
   7 Muse only
   8 ---------
   9
  10  - Nested lists.
  11
  12  - Publishing to other formats, such as LaTeX and Docbook.
  13
  14  - Escaping special characters automatically throughout the entire
  15    document, so that you don't have to.
  16
  17 emacs-wiki only
  18 ---------------
  19
  20 The reason that most of these have not been implemented is lack of
  21 demand.  If you want to see these features implemented, please send an
  22 email to the muse-el-discuss mailing list, describing a good use case
  23 for them.
  24
  25  - Publishing bookmarks in XBEL format.  The bk2site program --
  26    available separately -- does an adequate job, so this was not
  27    implemented for Muse.
  28
  29  - Macros, i.e. keywords like %this%, that expand to some text upon
  30    publishing.
  31
  32  - Global IDs.
  33
  34  - Menu generation.
  35
  36  - PGP encryption of regions with the <gpg> and <gpge> tags.
  37
  38  - The <redirect> tag.
  39
  40  - Publishing of ChangeLog files.
  41
  42  - The keybinding `C-c C-r': rename wiki link at point.
  43
  44  - The keybinding `C-c C-D': delete wiki link at point.
  45
  46  - The #style directive.
  47
  48  - Using the title of the page in a generated index page, rather than
  49    the filename of the page.
  50
  51 Specifying Projects
  52 ===================
  53
  54 Special Topics
  55 ==============
  56
  57 Including multiple directories
  58 ------------------------------
  59
  60 With emacs-wiki, this was done by setting the
  61 `emacs-wiki-recurse-directories' option to non-nil.
  62
  63 With Muse, this can be accomplished by including an entry in your
  64 muse-project-alist setting that causes entries for a directory and all
  65 subdirectories to be created.  This does not work when using the
  66 customize interface to set `muse-project-alist'.
  67
  68 Here is an example:
  69
  70     ("Blog" (,@(muse-project-alist-dirs "~/Blog")
  71              :default "index")
  72
  73      ;; Publish this directory and its subdirectories.  Arguments
  74      ;; are as follows.  The above `muse-project-alist-dirs' part
  75      ;; is also needed, using Argument 1.
  76      ;;
  77      ;;  1. Source directory
  78      ;;  2. Output directory
  79      ;;  3. Publishing style
  80      ;;  remainder: Other things to put in every generated style
  81      ,@(muse-project-alist-styles "~/Blog"
  82                                   "~/public_html/blog"
  83                                   "blosxom"))
  84
  85 Generating an Index page
  86 ------------------------
  87
  88 In emacs-wiki, the page specified by `emacs-wiki-index-page' is an
  89 automatically generated index page.
  90
  91 Muse does not automatically create this file.  If you want an
  92 automatic index file to be generated, then create a file and place the
  93 following contents (between the lines of underscores) in it.
  94
  95 _____
  96 #title Index
  97
  98 <lisp>(muse-index-as-string t t t)</lisp>
  99 _____
 100
 101 Then, add a :force-publish tag to the paths part of the project entry
 102 in muse-project-alist.  Example:
 103
 104     ("Website" ("~/Web/"
 105                 :force-publish ("WikiIndex")
 106                 :default "WelcomePage")
 107      (:base "xhtml"
 108             :base-url "http://mydomain.org/"
 109             :path "~/public_html"))
 110
 111 License
 112 =======
 113
 114 This file may be used, distributed, and modified without restriction.