NEWS

   1 Emacs Muse NEWS --- History of user-visible changes    -*- outline -*-
   2
   3 * Changes in Muse 3.02
   4
   5 ** New modules
   6
   7 *** muse-wiki.el --- Provide automatic linking for WikiWords and
   8 InterWiki links.  These words are clickable and publish as links.
   9 Project names from `muse-project-alist' are available for InterWiki
  10 linking by default.  The list of InterWiki names and handlers may be
  11 customized through `muse-wiki-interwiki-alist'.
  12
  13 WikiWords that do not correspond with real files will not be displayed
  14 as links nor published as links.  It is expected that this behavior
  15 will be made optional in future versions of Muse.
  16
  17 **** This module includes a few helper functions that may be added to
  18 `muse-publish-desc-transforms' in order to modify link descriptions at
  19 publish time.
  20
  21 **** The concept of "implicit links" and "explicit links" has been
  22 introduced.  Explicit links are surrounded by brackets, i.e.
  23 [[http://blah.org][this is a explicit link]].  Implicit links are URLs
  24 and email addresses that are not surrounded by brackets: they will not
  25 be colorized or published if surrounded by double-quotes.
  26
  27 ***** `muse-wiki-publish-pretty-title' causes words to be Title-cased,
  28 ignoring words like `the' and `at' which should not be changed.
  29
  30 ***** `muse-wiki-publish-pretty-interwiki' changes the delimiter of
  31 interwiki links according to the text of the
  32 `muse-wiki-interwiki-replacement' option.
  33
  34 ** Compatibility fixes
  35
  36 *** Muse has been tested with XEmacs 21.4, both Mule and non-Mule versions.
  37 There are no known problems remaining.  To make things work by
  38 default, the iso-8859-1 charset is used as a default option in some
  39 places.
  40
  41 ** Configuration
  42
  43 *** `muse-file-extension' -- New option that allows the file extension
  44 for Muse files to be specified.  For example, setting this to "muse"
  45 assumes that you have renamed your Muse files with a ".muse"
  46 extension.  Using this (and setting `muse-mode-auto-p' to nil) will
  47 prevent miscellaneous non-Muse files from being accidentally opened in
  48 Muse Mode.
  49
  50 *** `muse-ignored-extensions' -- New option that determines which file
  51 extensions to omit from the ending of a Muse page name.
  52
  53 *** `muse-ignored-extensions-regexp' -- This is no longer customizable.
  54 It will be automatically generated from `muse-file-extension' and
  55 `muse-ignored-extensions'.
  56
  57 *** `muse-project-alist' -- The customize interface for this option has
  58 been greatly improved, and much effort has been spent in order to make
  59 this user-friendly.
  60
  61 *** The `:force-publish' tag may be specified in `muse-project-alist'.
  62 This causes a particular list of files to be re-created every time the
  63 publishing process is invoked, even if they haven't been changed
  64 according to their timestamps.  One use for this is to keep an index
  65 of available pages by adding the following to a file in this list.
  66
  67 <lisp>(muse-index-as-string t t t)</lisp>
  68
  69 *** `muse-project-ignore-regexp' -- By default, version control directories
  70 are now included in this regexp so that they don't appear when you hit
  71 C-c C-f to browse files in a project.
  72
  73 *** The `muse-project-alist-styles' and `muse-project-alist-dirs' functions
  74 may be used in `muse-project-alist' to recursively add styles and
  75 directory listings for a given directory.  The following is an
  76 example.  We use a backtick instead of a single quote to begin the
  77 list.
  78
  79 (setq muse-project-alist
  80       `(("Blog"
  81          (,@(muse-project-alist-dirs "~/proj/wiki/blog")  ;; base dir
  82           :default "guestbook")
  83
  84          ,@(muse-project-alist-styles "~/proj/wiki/blog"  ;; base dir
  85                                       ;; output dir
  86                                       "~/personal-site/site/blog"
  87                                       ;; style
  88                                       "my-blosxom"))))
  89
  90 Note that if you use the customize interface for `muse-project-alist',
  91 you will still have to manually add information for any new
  92 sub-directories.
  93
  94 ** Debian packaging
  95
  96 *** Debian packages for Muse have entered Debian unstable, thanks
  97 to Romain Francoise, my sponsor.
  98
  99 It is possible to roll your own Muse packages if you want to do so.
 100 Packages may be built by using `make debrelease', once the proper
 101 options in Makefile.defs are set.  Revisions may be built using `make
 102 debrevision'.
 103
 104 The manual and relevant documentation files have been included with
 105 the Debian package for Muse.
 106
 107 ** Muse Mode
 108
 109 *** Allow use of Muse with outline-minor-mode.
 110
 111 *** Filling text does the right thing with list items and footnotes.
 112 List items and footnotes will no longer be concatenated when hitting
 113 M-q in the midst of consecutive items.
 114
 115 *** Links will never be split in the middle when using Fill.
 116
 117 *** Some flyspell crash issues were addressed.
 118 Using intangible text can cause strange problems with flyspell mode.
 119 Hence, by default, the intangible property will be ignored.  A new
 120 option called `muse-mode-intangible-links' indicates whether this
 121 should be the case.
 122
 123 *** Links will no longer be highlighted by flyspell.
 124 If you're using XEmacs or Emacs 22, flyspell will ignore links,
 125 including link text.  This keeps flyspell from making the links
 126 unclickable.  If you're using Emacs 21, flyspell will continue to
 127 interfere with links.  If you know how to fix this, please send a
 128 patch!
 129
 130 *** A few edge cases for emphasis and underlining have been addressed.
 131
 132 *** <example>, <verbatim>, and =surrounded text= are now colored using
 133 the new face `muse-verbatim-face'.
 134
 135 *** All marked up text properties, like emphasis and underlining,
 136 will be removed for the text between <example>, <verbatim>, <code>,
 137 <literal>, and <lisp> tags.
 138
 139 ** Muse manual
 140
 141 *** Fix problem with producing a PDF version of the manual.
 142
 143 ** Publishing
 144
 145 *** The order of rules should be much improved.
 146 This means that emphasis characters like `*' and `_' will never be
 147 interpreted as such if they are within links.
 148
 149 *** The user will be notified when `muse-publish-this-file' fails to
 150 publish the current file.  This happens when the timestamp of the
 151 current file indicates that it is up-to-date.
 152
 153 *** Special characters are escaped in link descriptions and links on a
 154 more consistent basis.  What defines a "special character" varies
 155 according to the publishing style.
 156
 157 *** Errors that occur during publish time will cause a warning to be
 158 displayed prominently, rather than being ignored.  It should no longer
 159 be possible to mess up a Muse source file by tweaking the Muse
 160 publishing process.
 161
 162 *** Errors in <lisp> tags cause a warning to be displayed and
 163 return "<!--INVALID LISP CODE-->".  Muse will try to continue
 164 publishing the page.
 165
 166 *** An emdash ("--") can now be used after a list, as long as there is
 167 a blank line between the end of the list and the emdash.
 168
 169 *** Every publishing style is now capable of specifying strings to use
 170 for sections beyond the third level.
 171
 172 *** Every publishing style may specify an end-of-section string.
 173 This is used, for example, by the experimental XML style and the
 174 DocBook style.
 175
 176 *** Every publishing style may specify a method of handling "internal
 177 link" markup.  An internal link is a link that refers to an anchor on
 178 the current page.
 179
 180 ** Blosxom publishing
 181
 182 *** muse-blosxom-new-entry: A #category directive is added by default.
 183 Nothing is done with this yet, but it could be handy for tag-based
 184 (multiple category) blogging, once we figure out a good way to do that
 185 in both Muse and Pyblosxom.  Ideas are welcome, and patches even more
 186 so.
 187
 188 ** DocBook publishing
 189
 190 *** The markup has been comprehensively improved.
 191 Published documents will now pass validation tests and look better in
 192 general.
 193
 194 *** It is now possible to specify the encoding of DocBook documents.
 195 The default encoding is utf-8.
 196
 197 *** Footnotes will be embedded into paragraphs, since this is
 198 The DocBook Way.
 199
 200 *** Tables will be sorted by section.
 201 Headers first, then footers, then the rest of the table.
 202
 203 *** Anchors are now handled correctly and publish to the best available
 204 form.  Links to anchors are published with the <link> tag.
 205
 206 ** HTML publishing
 207
 208 *** Fix minor issue with anchors.
 209
 210 *** Paragraph publishing will no longer insert <div> tags before images.
 211 This was causing too much hassle for some programs that were trying to
 212 extend Muse, like the Muse port of Planner.
 213
 214 *** The `&', `<', and '>' characters will be escaped using their specific
 215 HTML escape codes, rather than with "&#NNN;".  This makes the
 216 published output display correctly in more web browsers.
 217
 218 *** Use HTML 4.0 Transitional by default for `muse-html-header'.
 219
 220 *** Include empty alt element in markup string for images that lack a
 221 description.
 222
 223 *** Tables will be sorted by section.
 224 Headers first, then footers, then the rest of the table.
 225
 226 *** `muse-xhtml-extension' -- The default extension for XHTML publishing.
 227 This is a new option.
 228
 229 ** Journal publishing
 230
 231 *** Use "div class=..." rather than "div id=..." for sections.
 232
 233 ** LaTeX publishing
 234
 235 *** A newline will be appended to the default footer for the latex and
 236 latexpdf publishing styles.  This keeps the PDF-building process from
 237 failing due to lack of a newline at end of file.
 238
 239 *** Anchors and links to them now work properly.
 240
 241 ** TexInfo publishing
 242
 243 *** Fix a fatal error that occurs when publishing tables.
 244
 245 *** Generate the contents in the header by default rather than the footer.
 246 This is the way that most TexInfo manuals do it.
 247
 248 *** The info-pdf publishing style currently produces the best PDF output
 249 on the maintainer's machine, so it is now used to publish the PDF
 250 version of the Muse Manual.
 251
 252 *** The characters `{' and `}' will be treated as special characters that
 253 need to be escaped at publish-time.
 254
 255 *** Improve dots and enddots markup strings.
 256
 257 *** Surround underlined text with "_" since TexInfo doesn't seem to have
 258 any better options for producing underlined text.
 259
 260 *** Anchors and links to them now work properly.