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 *** muse-protocols.el --- URL protocols that Muse recognizes.
  35 This automatically-included module provides an easily customizable
  36 list of URL protocols, how to browse them, and how to resolve them for
  37 publishing.  Customize `muse-url-protocols' to add and remove
  38 protocols.
  39
  40 ** Compatibility fixes
  41
  42 *** Muse has been tested with XEmacs 21.4, both Mule and non-Mule versions.
  43 There are no known problems remaining.  To make things work by
  44 default, the iso-8859-1 charset is used as a default option in some
  45 places.
  46
  47 ** Configuration
  48
  49 *** `muse-file-extension' -- New option that allows the file extension
  50 for Muse files to be specified.  For example, setting this to "muse"
  51 assumes that you have renamed your Muse files with a ".muse"
  52 extension.  Using this (and setting `muse-mode-auto-p' to nil) will
  53 prevent miscellaneous non-Muse files from being accidentally opened in
  54 Muse Mode.
  55
  56 *** `muse-ignored-extensions' -- New option that determines which file
  57 extensions to omit from the ending of a Muse page name.
  58
  59 *** `muse-ignored-extensions-regexp' -- This is no longer customizable.
  60 It will be automatically generated from `muse-file-extension' and
  61 `muse-ignored-extensions'.
  62
  63 *** `muse-project-alist' -- The customize interface for this option has
  64 been greatly improved, and much effort has been spent in order to make
  65 this user-friendly.
  66
  67 *** The `:force-publish' tag may be specified in `muse-project-alist'.
  68 This causes a particular list of files to be re-created every time the
  69 publishing process is invoked, even if they haven't been changed
  70 according to their timestamps.  One use for this is to keep an index
  71 of available pages by adding the following to a file in this list.
  72
  73 <lisp>(muse-index-as-string t t t)</lisp>
  74
  75 *** `muse-project-ignore-regexp' -- By default, version control directories
  76 are now included in this regexp so that they don't appear when you hit
  77 C-c C-f to browse files in a project.
  78
  79 *** The `muse-project-alist-styles' and `muse-project-alist-dirs' functions
  80 may be used in `muse-project-alist' to recursively add styles and
  81 directory listings for a given directory.  The following is an
  82 example.  We use a backtick instead of a single quote to begin the
  83 list.
  84
  85 (setq muse-project-alist
  86       `(("Blog"
  87          (,@(muse-project-alist-dirs "~/proj/wiki/blog")  ;; base dir
  88           :default "guestbook")
  89
  90          ,@(muse-project-alist-styles "~/proj/wiki/blog"  ;; base dir
  91                                       ;; output dir
  92                                       "~/personal-site/site/blog"
  93                                       ;; style
  94                                       "my-blosxom"))))
  95
  96 Note that if you use the customize interface for `muse-project-alist',
  97 you will still have to manually add information for any new
  98 sub-directories.
  99
 100 ** Debian packaging
 101
 102 *** Debian packages for Muse have entered Debian unstable, thanks
 103 to Romain Francoise, my sponsor.
 104
 105 It is possible to roll your own Muse packages if you want to do so.
 106 Packages may be built by using `make debrelease', once the proper
 107 options in Makefile.defs are set.  Revisions may be built using `make
 108 debrevision'.
 109
 110 The manual and relevant documentation files have been included with
 111 the Debian package for Muse.
 112
 113 ** Muse Mode
 114
 115 *** Allow use of Muse with outline-minor-mode.
 116
 117 *** Filling text does the right thing with list items and footnotes.
 118 List items and footnotes will no longer be concatenated when hitting
 119 M-q in the midst of consecutive items.
 120
 121 *** Links will never be split in the middle when using Fill.
 122
 123 *** Some flyspell crash issues were addressed.
 124 Using intangible text can cause strange problems with flyspell mode.
 125 Hence, by default, the intangible property will be ignored.  A new
 126 option called `muse-mode-intangible-links' indicates whether this
 127 should be the case.
 128
 129 *** Links will no longer be highlighted by flyspell.
 130 If you're using XEmacs or Emacs 22, flyspell will ignore links,
 131 including link text.  This keeps flyspell from making the links
 132 unclickable.  If you're using Emacs 21, flyspell will continue to
 133 interfere with links.  If you know how to fix this, please send a
 134 patch!
 135
 136 *** A few edge cases for emphasis and underlining have been addressed.
 137
 138 *** <example>, <verbatim>, and =surrounded text= are now colored using
 139 the new face `muse-verbatim-face'.
 140
 141 *** All marked up text properties, like emphasis and underlining,
 142 will be removed for the text between <example>, <verbatim>, <code>,
 143 <literal>, and <lisp> tags.
 144
 145 *** Links to temporary files may be visited.
 146 A "temporary file" in this case is a buffer that is not associated
 147 with any file.  For some dynamic content import scripts with Planner,
 148 this is helpful.
 149
 150 *** Typing "#title" should never crash Emacs anymore.
 151
 152 ** Muse manual
 153
 154 *** Fix problem with producing a PDF version of the manual.
 155
 156 *** Document WikiNames.
 157
 158 *** Bring up-to-date with latest features.
 159
 160 *** New Directives section.
 161 This describes the use of #title and #author, as well as other
 162 directives that may be used.
 163
 164 ** Publishing
 165
 166 *** The order of rules should be much improved.
 167 This means that emphasis characters like `*' and `_' will never be
 168 interpreted as such if they are within links.
 169
 170 *** The user will be notified when `muse-publish-this-file' fails to
 171 publish the current file.  This happens when the timestamp of the
 172 current file indicates that it is up-to-date.
 173
 174 *** Special characters are escaped in link descriptions and links on a
 175 more consistent basis.  What defines a "special character" varies
 176 according to the publishing style.
 177
 178 *** Errors that occur during publish time will cause a warning to be
 179 displayed prominently, rather than being ignored.  It should no longer
 180 be possible to mess up a Muse source file by tweaking the Muse
 181 publishing process.
 182
 183 *** Errors in <lisp> tags cause a warning to be displayed and
 184 return "<!--INVALID LISP CODE-->".  Muse will try to continue
 185 publishing the page.
 186
 187 *** An emdash ("--") can now be used after a list, as long as there is
 188 a blank line between the end of the list and the emdash.
 189
 190 *** The <code> tag has been introduced.
 191 It does the same thing that =equal signs= do: escape specials and
 192 publish as teletype text.  Use it for short command snippets and the
 193 like.  <example> is a better choice for large blocks of code, since it
 194 preserves whitespace.
 195
 196 *** An edge case involving links at the beginning of a paragraph
 197 has been addressed.
 198
 199 *** An edge case involving consecutive directives of the same size
 200 has been addressed.
 201
 202 *** Every publishing style is now capable of specifying strings to use
 203 for sections beyond the third level.
 204
 205 *** Every publishing style may specify an end-of-section string.
 206 This is used, for example, by the experimental XML style and the
 207 DocBook style.
 208
 209 *** Every publishing style may specify a method of handling "internal
 210 link" markup.  An internal link is a link that refers to an anchor on
 211 the current page.
 212
 213 *** Every publishing style may specify a link suffix to use.
 214 This allows the file extensions in links to other Muse files to be
 215 different from their actual extension.  Blosxom makes use of this
 216 (since its published files are .txt and the dynamically-generated
 217 output is .html), and it could come in handy for PHP stuff.
 218
 219 If a link suffix is not specified via :link-suffix, the value of
 220 :suffix will be used.
 221
 222 ** Blosxom publishing
 223
 224 *** muse-blosxom-new-entry: A #category directive is added by default.
 225 Nothing is done with this yet, but it could be handy for tag-based
 226 (multiple category) blogging, once we figure out a good way to do that
 227 in both Muse and Pyblosxom.  Ideas are welcome, and patches even more
 228 so.
 229
 230 ** DocBook publishing
 231
 232 *** The markup has been comprehensively improved.
 233 Published documents will now pass validation tests and look better in
 234 general.
 235
 236 *** It is now possible to specify the encoding of DocBook documents.
 237 The default encoding is utf-8.
 238
 239 *** Footnotes will be embedded into paragraphs, since this is
 240 The DocBook Way.
 241
 242 *** Tables will be sorted by section.
 243 Headers first, then footers, then the rest of the table.
 244
 245 *** Anchors are now handled correctly and publish to the best available
 246 form.  Links to anchors are published with the <link> tag.
 247
 248 ** HTML publishing
 249
 250 *** Fix minor issue with anchors.
 251
 252 *** Paragraph publishing will no longer insert <div> tags before images.
 253 This was causing too much hassle for some programs that were trying to
 254 extend Muse, like the Muse port of Planner.
 255
 256 *** The `&', `<', and '>' characters will be escaped using their specific
 257 HTML escape codes, rather than with "&#NNN;".  This makes the
 258 published output display correctly in more web browsers.
 259
 260 *** Use HTML 4.0 Transitional by default for `muse-html-header'.
 261
 262 *** Include empty alt element in markup string for images that lack a
 263 description.
 264
 265 *** Tables will be sorted by section.
 266 Headers first, then footers, then the rest of the table.
 267
 268 *** `muse-xhtml-extension' -- The default extension for XHTML publishing.
 269 This is a new option.
 270
 271 ** Journal publishing
 272
 273 *** Use "div class=..." rather than "div id=..." for sections.
 274
 275 ** LaTeX publishing
 276
 277 *** A newline will be appended to the default footer for the latex and
 278 latexpdf publishing styles.  This keeps the PDF-building process from
 279 failing due to lack of a newline at end of file.
 280
 281 *** Anchors and links to them now work properly.
 282
 283 *** When generating PDF files, call pdflatex twice.
 284 This should ensure that the table of contents gets generated, if one
 285 is due to be published.
 286
 287 *** PDF files with spaces may be published.
 288 A bug preventing this has been fixed.
 289
 290 *** Teletype text is now published using \\texttt{...}.
 291
 292 *** An attempt has been made to escape special characters more
 293 consistently.
 294
 295 ** TexInfo publishing
 296
 297 *** Fix a fatal error that occurs when publishing tables.
 298
 299 *** Generate the contents in the header by default rather than the footer.
 300 This is the way that most TexInfo manuals do it.
 301
 302 *** The info-pdf publishing style currently produces the best PDF output
 303 on the maintainer's machine, so it is now used to publish the PDF
 304 version of the Muse Manual.
 305
 306 *** The characters `{' and `}' will be treated as special characters that
 307 need to be escaped at publish-time.
 308
 309 *** Improve dots and enddots markup strings.
 310
 311 *** Surround underlined text with "_" since TexInfo doesn't seem to have
 312 any better options for producing underlined text.
 313
 314 *** Anchors and links to them now work properly.