1 Emacs Muse NEWS --- History of user-visible changes -*- outline -*-
3 * Changes in Muse 3.02.02
7 *** A bug with customizing `muse-project-alist' has been fixed.
9 *** We use a file extension for Muse files by default.
10 To obtain the old behavior, set `muse-file-extension' to nil and
11 `muse-mode-auto-p' to t.
13 To go along with the new behavior, be sure to rename all of your Muse
14 files to have a ".muse" extension.
16 *** New option: `muse-wiki-ignore-bare-project-names'.
17 This causes Muse to ignore bare project names if specified. The
18 default is to turn bare project names into links.
20 *** New option: `muse-publish-comments-p'.
21 This causes Muse to publish comments as markup. The default is to
22 remove comments before publishing rather than trying to mark them up.
24 *** New option: `muse-wiki-allow-nonexistent-wikiword'.
25 Enabling this will cause WikiWords with no corresponding file to be
26 colored as bad links. The default is not to color them and turn them
31 *** An error with intangible links has been fixed.
33 *** Visiting a page with an anchor works better than before.
35 *** Flyspell behaves better with Emacs21 than before.
37 *** Links to nonexistent files will be colored red by default.
38 This happened previously, but the algorithm was buggy and didn't cover
43 *** A convenience macro called `with-muse-project' has been added.
44 This allows a code block to be executed after changing the current
45 Muse project. It is analogous to emacs-wiki's
46 `with-emacs-wiki-project' function.
50 *** An issue involving anchors at the end of a line has been
53 *** Non-word characters are now allowed before an anchor.
55 *** Comments may now be published, if desired.
56 This behavior may be controlled with the `muse-publish-comments-p'
57 option. The default is to remove comments before publishing rather
58 than trying to mark them up.
60 *** Publishing directives may now include a dash character.
64 *** A bug with footnotes has been addressed.
65 An attempt has been made to make generated footnote markup look more
66 "natural" to experienced LaTeX users.
68 *** Table headers are underlined and table footers are overlined.
70 *** PDF publishing will cause pdflatex to be called as needed.
71 The previous behavior was to always call pdflatex twice. Currently,
72 if pdflatex succeeds, it will not be called again. Otherwise, call it
75 *** Escaping of special characters should be drastically improved.
76 An attempt has been made to get escaping done right in most contexts.
77 The only quirk is that you must surround dollar signs with equal signs
78 to ensure escaping. This makes publishing PDF documents much more
83 *** An attempt was made to hone some of the markup.
85 * Changes in Muse 3.02.01
89 *** `muse-project-alist' -- This variable should now save customizations
90 to the correct form in the .emacs file. Before, it was saving an
91 intermediate form of the variable.
93 If you have used the customize interface in the previous release of
94 Muse to set `muse-project-alist', please do the following to import
97 - Open your .emacs file.
98 - Move the point to where `muse-project-alist' is set.
99 - Type `M-: (setq muse-project-alist-using-customize t) RET'.
101 - Type `M-x customize-save-variable RET muse-project-alist RET'.
103 *** `muse-project-alist' -- A bug involving the deleting of items
104 using Emacs21 and XEmacs21 has been fixed.
108 *** Links should no longer prevent moving the point, and help text for
109 links should no longer cause errors to occur.
113 *** If 2 or more blank lines separate list or table items, each item
114 will be published in a separate list or table.
116 *** The #date directive is now populated by default with the last
117 modified time of each file, rather than the current time of day. To
118 use this value, add '<lisp>(muse-publishing-directive "date")<lisp>'
119 to your header or footer.
123 *** `muse-xhtml-style-sheet' -- New option that indicates the style
124 settings to use for XHTML documents. This may be either a filename or
125 a string of stylesheet settings.
127 * Changes in Muse 3.02
131 *** muse-wiki.el --- Provide automatic linking for WikiWords and
132 InterWiki links. These words are clickable and publish as links.
133 Project names from `muse-project-alist' are available for InterWiki
134 linking by default. The list of InterWiki names and handlers may be
135 customized through `muse-wiki-interwiki-alist'.
137 WikiWords that do not correspond with real files will not be displayed
138 as links nor published as links. It is expected that this behavior
139 will be made optional in future versions of Muse.
141 **** This module includes a few helper functions that may be added to
142 `muse-publish-desc-transforms' in order to modify link descriptions at
145 **** The concept of "implicit links" and "explicit links" has been
146 introduced. Explicit links are surrounded by brackets, i.e.
147 [[http://blah.org][this is a explicit link]]. Implicit links are URLs
148 and email addresses that are not surrounded by brackets: they will not
149 be colorized or published if surrounded by double-quotes.
151 ***** `muse-wiki-publish-pretty-title' causes words to be Title-cased,
152 ignoring words like `the' and `at' which should not be changed.
154 ***** `muse-wiki-publish-pretty-interwiki' changes the delimiter of
155 interwiki links according to the text of the
156 `muse-wiki-interwiki-replacement' option.
158 *** muse-protocols.el --- URL protocols that Muse recognizes.
159 This automatically-included module provides an easily customizable
160 list of URL protocols, how to browse them, and how to resolve them for
161 publishing. Customize `muse-url-protocols' to add and remove
164 ** Compatibility fixes
166 *** Muse has been tested with XEmacs 21.4, both Mule and non-Mule versions.
167 There are no known problems remaining. To make things work by
168 default, the iso-8859-1 charset is used as a default option in some
173 *** `muse-file-extension' -- New option that allows the file extension
174 for Muse files to be specified. For example, setting this to "muse"
175 assumes that you have renamed your Muse files with a ".muse"
176 extension. Using this (and setting `muse-mode-auto-p' to nil) will
177 prevent miscellaneous non-Muse files from being accidentally opened in
180 *** `muse-ignored-extensions' -- New option that determines which file
181 extensions to omit from the ending of a Muse page name.
183 *** `muse-ignored-extensions-regexp' -- This is no longer customizable.
184 It will be automatically generated from `muse-file-extension' and
185 `muse-ignored-extensions'.
187 *** `muse-project-alist' -- The customize interface for this option has
188 been greatly improved, and much effort has been spent in order to make
191 *** The `:force-publish' tag may be specified in `muse-project-alist'.
192 This causes a particular list of files to be re-created every time the
193 publishing process is invoked, even if they haven't been changed
194 according to their timestamps. One use for this is to keep an index
195 of available pages by adding the following to a file in this list.
197 <lisp>(muse-index-as-string t t t)</lisp>
199 *** `muse-project-ignore-regexp' -- By default, version control directories
200 are now included in this regexp so that they don't appear when you hit
201 C-c C-f to browse files in a project.
203 *** The `muse-project-alist-styles' and `muse-project-alist-dirs' functions
204 may be used in `muse-project-alist' to recursively add styles and
205 directory listings for a given directory. The following is an
206 example. We use a backtick instead of a single quote to begin the
209 (setq muse-project-alist
211 (,@(muse-project-alist-dirs "~/proj/wiki/blog") ;; base dir
212 :default "guestbook")
214 ,@(muse-project-alist-styles "~/proj/wiki/blog" ;; base dir
216 "~/personal-site/site/blog"
220 Note that if you use the customize interface for `muse-project-alist',
221 you will still have to manually add information for any new
226 *** Debian packages for Muse have entered Debian unstable, thanks
227 to Romain Francoise, my sponsor.
229 It is possible to roll your own Muse packages if you want to do so.
230 Packages may be built by using `make debrelease', once the proper
231 options in Makefile.defs are set. Revisions may be built using `make
234 The manual and relevant documentation files have been included with
235 the Debian package for Muse.
239 *** Allow use of Muse with outline-minor-mode.
241 *** Filling text does the right thing with list items and footnotes.
242 List items and footnotes will no longer be concatenated when hitting
243 M-q in the midst of consecutive items.
245 *** Links will never be split in the middle when using Fill.
247 *** Some flyspell crash issues were addressed.
248 Using intangible text can cause strange problems with flyspell mode.
249 Hence, by default, the intangible property will be ignored. A new
250 option called `muse-mode-intangible-links' indicates whether this
253 *** Links will no longer be highlighted by flyspell.
254 If you're using XEmacs or Emacs 22, flyspell will ignore links,
255 including link text. This keeps flyspell from making the links
256 unclickable. If you're using Emacs 21, flyspell will continue to
257 interfere with links. If you know how to fix this, please send a
260 *** A few edge cases for emphasis and underlining have been addressed.
262 *** <example>, <verbatim>, and =surrounded text= are now colored using
263 the new face `muse-verbatim-face'.
265 *** All marked up text properties, like emphasis and underlining,
266 will be removed for the text between <example>, <verbatim>, <code>,
267 <literal>, and <lisp> tags.
269 *** Links to temporary files may be visited.
270 A "temporary file" in this case is a buffer that is not associated
271 with any file. For some dynamic content import scripts with Planner,
274 *** Typing "#title" should never crash Emacs anymore.
278 *** Fix problem with producing a PDF version of the manual.
280 *** Document WikiNames.
282 *** Bring up-to-date with latest features.
284 *** Massively update Common Elements section.
286 *** New Directives section.
287 This describes the use of #title and #author, as well as other
288 directives that may be used.
290 *** New Comments section.
291 Describes the use of "; comment text".
295 *** The order of rules should be much improved.
296 This means that emphasis characters like `*' and `_' will never be
297 interpreted as such if they are within links.
299 *** The user will be notified when `muse-publish-this-file' fails to
300 publish the current file. This happens when the timestamp of the
301 current file indicates that it is up-to-date.
303 *** Special characters are escaped in link descriptions and links on a
304 more consistent basis. What defines a "special character" varies
305 according to the publishing style.
307 *** Errors that occur during publish time will cause a warning to be
308 displayed prominently, rather than being ignored. It should no longer
309 be possible to mess up a Muse source file by tweaking the Muse
312 *** Errors in <lisp> tags cause a warning to be displayed and
313 return "<!--INVALID LISP CODE-->". Muse will try to continue
316 *** An emdash ("--") can now be used after a list, as long as there is
317 a blank line between the end of the list and the emdash.
319 *** The <code> tag has been introduced.
320 It does the same thing that =equal signs= do: escape specials and
321 publish as teletype text. Use it for short command snippets and the
322 like. <example> is a better choice for large blocks of code, since it
323 preserves whitespace.
325 *** An edge case involving links at the beginning of a paragraph
328 *** An edge case involving consecutive directives of the same size
331 *** Every publishing style is now capable of specifying strings to use
332 for sections beyond the third level.
334 *** Every publishing style may specify an end-of-section string.
335 This is used, for example, by the experimental XML style and the
338 *** Every publishing style may specify a method of handling "internal
339 link" markup. An internal link is a link that refers to an anchor on
342 *** Every publishing style may specify a link suffix to use.
343 This allows the file extensions in links to other Muse files to be
344 different from their actual extension. Blosxom makes use of this
345 (since its published files are .txt and the dynamically-generated
346 output is .html), and it could come in handy for PHP stuff.
348 If a link suffix is not specified via :link-suffix, the value of
349 :suffix will be used.
351 ** Blosxom publishing
353 *** muse-blosxom-new-entry: A #category directive is added by default.
354 Nothing is done with this yet, but it could be handy for tag-based
355 (multiple category) blogging, once we figure out a good way to do that
356 in both Muse and Pyblosxom. Ideas are welcome, and patches even more
359 ** DocBook publishing
361 *** The markup has been comprehensively improved.
362 Published documents will now pass validation tests and look better in
365 *** It is now possible to specify the encoding of DocBook documents.
366 The default encoding is utf-8.
368 *** Footnotes will be embedded into paragraphs, since this is
371 *** Tables will be sorted by section.
372 Headers first, then footers, then the rest of the table.
374 *** Anchors are now handled correctly and publish to the best available
375 form. Links to anchors are published with the <link> tag.
379 *** Fix minor issue with anchors.
381 *** Paragraph publishing will no longer insert <div> tags before images.
382 This was causing too much hassle for some programs that were trying to
383 extend Muse, like the Muse port of Planner.
385 *** The `&', `<', and '>' characters will be escaped using their specific
386 HTML escape codes, rather than with "&#NNN;". This makes the
387 published output display correctly in more web browsers.
389 *** Use HTML 4.0 Transitional by default for `muse-html-header'.
391 *** Include empty alt element in markup string for images that lack a
394 *** Tables will be sorted by section.
395 Headers first, then footers, then the rest of the table.
397 *** `muse-xhtml-extension' -- The default extension for XHTML publishing.
398 This is a new option.
400 ** Journal publishing
402 *** Use "div class=..." rather than "div id=..." for sections.
406 *** A newline will be appended to the default footer for the latex and
407 latexpdf publishing styles. This keeps the PDF-building process from
408 failing due to lack of a newline at end of file.
410 *** Anchors and links to them now work properly.
412 *** When generating PDF files, call pdflatex twice.
413 This should ensure that the table of contents gets generated, if one
414 is due to be published.
416 *** PDF files with spaces may be published.
417 A bug preventing this has been fixed.
419 *** Teletype text is now published using \\texttt{...}.
421 *** An attempt has been made to escape special characters more
424 ** TexInfo publishing
426 *** Fix a fatal error that occurs when publishing tables.
428 *** Generate the contents in the header by default rather than the footer.
429 This is the way that most TexInfo manuals do it.
431 *** The info-pdf publishing style currently produces the best PDF output
432 on the maintainer's machine, so it is now used to publish the PDF
433 version of the Muse Manual.
435 *** The characters `{' and `}' will be treated as special characters that
436 need to be escaped at publish-time.
438 *** Improve dots and enddots markup strings.
440 *** Surround underlined text with "_" since TexInfo doesn't seem to have
441 any better options for producing underlined text.
443 *** Anchors and links to them now work properly.