NEWS

   1 Emacs Muse NEWS -- history of user-visible changes.    -*- outline -*-
   2
   3 progress: patch-149
   4
   5 * Changes in Muse 3.02
   6
   7 ** New modules
   8
   9 *** muse-wiki.el --- Provide automatic linking for WikiWords and
  10 InterWiki links.  These words are clickable and publish as links.
  11 Project names from `muse-project-alist' are available for InterWiki
  12 linking by default.  The list of InterWiki names and handlers may be
  13 customized through `muse-wiki-interwiki-alist'.
  14
  15 WikiWords that do not correspond with real files will not be displayed
  16 as links nor published as links.  It is expected that this behavior
  17 will be made optional in future versions of Muse.
  18
  19 **** This module includes a few helper functions that may be added to
  20 `muse-publish-desc-transforms' in order to modify link descriptions at
  21 publish time.
  22
  23  `muse-wiki-publish-pretty-title' causes words to be Title-cased,
  24 ignoring words like `the' and `at' which should not be changed.
  25
  26 `muse-wiki-publish-pretty-interwiki' changes the delimiter
  27 of interwiki links according to the text of the
  28 `muse-wiki-interwiki-replacement' option.
  29
  30 ** Compatibility fixes
  31
  32 *** Muse has been tested with XEmacs 21.4, both Mule and non-Mule versions.
  33 There are no known problems remaining.  To make things work by
  34 default, the iso-8859-1 charset is used as a default option in some
  35 places.
  36
  37 ** Configuration
  38
  39 *** `muse-file-extension' -- New option that allows the file extension
  40 for Muse files to be specified.  For example, setting this to "muse"
  41 assumes that you have renamed your Muse files with a ".muse"
  42 extension.  Using this (and setting `muse-mode-auto-p' to nil) will
  43 prevent miscellaneous non-Muse files from being accidentally opened in
  44 Muse Mode.
  45
  46 *** `muse-ignored-extensions' -- New option that determines which file
  47 extensions to omit from the ending of a Muse page name.
  48
  49 *** `muse-ignored-extensions-regexp' -- This is no longer customizable.
  50 It will be automatically generated from `muse-file-extension' and
  51 `muse-ignored-extensions'.
  52
  53 *** `muse-project-alist' -- The customize interface for this option has
  54 been greatly improved, and much effort has been spent in order to make
  55 this user-friendly.
  56
  57 **** The `:force-publish' tag may be specified in `muse-project-alist'.
  58 This causes a particular list of files to be re-created every time the
  59 publishing process is invoked, even if they haven't been changed
  60 according to their timestamps.  One use for this is to keep an index
  61 of available pages by adding the following to a file in this list.
  62
  63 <lisp>(muse-index-as-string t t t)</lisp>
  64
  65 ** Debian packaging
  66
  67 *** Debian packages for Muse have entered Debian unstable, thanks
  68 to Romain Francoise, my sponsor.  Packages may be built by using `make
  69 debrelease', once the proper options in Makefile.defs are set.
  70 Revisions may be built using `make debrevision'.
  71
  72 The manual and relevant documentation files have been included with
  73 the Debian package for Muse.
  74
  75 ** Insinuation with other modes
  76
  77 *** Allow use of Muse with outline-minor-mode.
  78
  79 *** Filling text does the right thing with list items.
  80 List items will no longer be concatenated when hitting M-q in the
  81 midst of consecutive list items.
  82
  83 Links will never be split in the middle when using Fill.
  84
  85 *** Some flyspell crash issues were addressed.
  86 Using intangible text can cause strange problems with flyspell mode.
  87 Hence, by default, the intangible property will be ignored.  A new
  88 option called `muse-mode-intangible-links' indicates whether this
  89 should be the case.
  90
  91 *** Links will no longer be highlighted by flyspell.
  92 If you're using XEmacs or Emacs 22, flyspell will ignore links,
  93 including link text.  This keeps flyspell from making the links
  94 unclickable.  If you're using Emacs 21, flyspell will continue to
  95 interfere with links.  If you know how to fix this, please send a
  96 patch!
  97
  98 ** Muse manual
  99
 100 *** Fix problem with producing a PDF version of the manual.
 101
 102 ** Publishing
 103
 104 *** The order of rules should be much improved.
 105 This means that emphasis characters like `*' and `_' will never be
 106 interpreted as such if they are within links.
 107
 108 *** The user will be notified when `muse-publish-this-file' fails to
 109 publish the current file.  This happens when the timestamp of the
 110 current file indicates that it is up-to-date.
 111
 112 *** Special characters are escaped in link descriptions and links on a
 113 more consistent basis.  What defines a "special character" varies
 114 according to the publishing style.
 115
 116 *** Errors that occur during publish time will cause a warning to be
 117 displayed prominently, rather than being ignored.  It should no longer
 118 be possible to mess up a Muse source file by tweaking the Muse
 119 publishing process.
 120
 121 *** Errors in <lisp> tags cause a warning to be displayed and
 122 return "<!--INVALID LISP CODE-->".  Muse will try to continue
 123 publishing the page.
 124
 125 ** DocBook publishing
 126
 127 *** The markup has been comprehensively improved.
 128 Published documents will now pass validation tests.
 129
 130 *** It is now possible to specify the encoding of DocBook documents.
 131 The default encoding is utf-8.
 132
 133 ** HTML publishing
 134
 135 *** Fix minor issue with anchors.
 136
 137 *** Paragraph publishing will no longer insert <div> tags before images.
 138 This was causing too much hassle for some programs that were trying to
 139 extend Muse, like the Muse port of Planner.
 140
 141 *** The `&', `<', and '>' characters will be escaped using their specific
 142 HTML escape codes, rather than with "&#NNN;".  This makes the
 143 published output display correctly in more web browsers.
 144
 145 *** Use HTML 4.0 Transitional by default for `muse-html-header'.
 146
 147 *** Include empty alt element in markup string for images that lack a
 148 description.
 149
 150 ** Journal publishing
 151
 152 *** Use "div class=..." rather than "div id=..." for sections.