Minor cleanups
[muse-el.git] / NEWS
blob6fb872711662507c396152ae97a3aec161236e0c
1 Emacs Muse NEWS --- History of user-visible changes    -*- outline -*-
3 * Changes in Muse 3.03 (not yet released)
5 ** Blosxom publishing (lisp/muse-blosxom.el)
7 *** New option: muse-blosxom-use-tags.
8 This specifies whether or not we are using tags.  Tags allow a page to
9 belong to multiple categories, but they do not rely on the directory
10 structure for categorization.
12 *** Use `find-file' as the browsing function.
14 *** Improve internal documentation for the included pyblosxom plug-ins.
16 *** New example script: contrib/pyblosxom/make-blog.
17 This shows how to invoke contrib/pyblosxom/getstamps.py.
19 ** Core functionality (lisp/muse.el)
21 *** Fix an XEmacs beta byte-compiler issue.
23 *** Make nested list manipulation accessible to both Muse Mode
24 and Muse publishing.
26 *** Fix failure to recognize the .muse file extension.
27 Handle the case where the user customizes the file extension.
29 *** It is now easier to indicate that Muse should not use a file
30 extension.  Just do the following.
32 (setq muse-file-extension nil
33       muse-mode-auto-p t)
35 *** Allow tab characters in explicit links.
37 *** Escape brackets in links, and then un-escape them when displaying
38 the link in a buffer of publishing it.  This allows brackets to be
39 safely used in link descriptions and links, as long as you use `C-c
40 TAB l', `C-c TAB u', `C-c C-e', or automatic Planner annotations.
42 ** HTML publishing (lisp/muse-html.el)
44 *** Make sure spaces in URLs get escaped properly.
46 *** Make the Table of Contents CSS easier to customize.
47 For an example, see examples/mwolson/stylesheets/screen.css.
49 *** Fix a paragraph detection bug for paragraphs that occur after
50 verses.
52 ** Importing LaTeX documents (lisp/muse-import-latex.el)
54 *** Rename from muse-convert.el.
55 There are plans for importing other formats into Muse as well.
57 ** Journal (lisp/muse-journal.el)
59 *** New option: muse-journal-rss-heading-regexp.
60 Determine the regexp to use when searching for an RSS heading.
62 *** Make sure that the date is in a format that RSS readers
63 can handle.
65 ** LaTeX publishing (lisp/muse-latex.el)
67 *** Improve escaping of specials.
69 *** Use \label{} and \ref{} for anchors and anchor references.
71 *** Emphasize table elements.
73 *** Improve table generation.
75 *** Use \url{} to publish bare URLs.
77 *** Handle case where a Muse page begins with a quote character.
79 *** Display footnotes when we have both a URL and description.
80 This makes the URLs show up on printed documents in a sensible
81 fashion.
83 *** Escape the "@" character in the entire document.
85 *** Make images take up 75% of the width of the page.
87 *** New option: muse-latex-permit-contents-tag.
88 This specifies whether we should take action on the <contents> tag.
90 ** Muse Manual (muse.texi)
92 *** Use better style for subsections.
94 *** Make sure the PDF file for the manual is properly generated.
96 *** Implicit Links
98 **** Mention how to customize the WikiName recognition.
100 *** Extending Muse
102 **** Move "Common Elements" and "Deriving Styles" chapters here.
104 ** Muse Mode (lisp/muse-mode.el)
106 *** `C-c TAB' now inserts an object, prompting the user for which type.
107 `C-c TAB l' inserts a relative link.
108 `C-c TAB t' inserts a Muse tag.
109 `C-c TAB u' inserts a URL.
111 These keybindings may be modified by editing `muse-insert-map'.  Note
112 that the prompt you get when you hit `C-c TAB' will not change.
114 *** New list-oriented keybindings:
115 `M-RET' inserts a list item.
116 `C->' increases list item indentation.
117 `C-<' decreases list item indentation.
119 *** Slightly improvement speed of flyspell integration
121 *** Implement searching through Muse files.
123 **** `C-c C-s' performs a search through Muse files.
125 **** New option: muse-grep-command.
126 Customize this to specify the command used for searching.  In
127 particular, "glimpse" is handy.  Check the documentation for this
128 command for details.
130 *** Changed keybindings:
131 `C-c C-b' is now `muse-find-backlinks'
132 `C-c C-v' is now `muse-browse-result'
134 *** Don't require muse-publish.el, since publishing and viewing Muse
135 files are supposed to be completely separable.
137 *** Speed up searching for next and previous references.
139 *** Make filling definition lists work better.
141 *** Make editing existing links with `C-c C-e' work better.
143 *** Make browsing the resulting page with `C-c C-v' work better.
145 *** Don't throw an error if doing flyspell or following link at
146 beginning of buffer.
148 *** When publishing a file with `C-c C-t', consult muse-project-alist
149 and use its publishing styles to intelligently prompt the user as to
150 the publishing style and output directory.
152 The old behavior of allowing the file to be published anywhere and
153 with any style has been moved to `C-c C-T'.
155 *** Clicking `mouse-2' now does the right thing when
156 mouse-yank-at-point is non-nil.
158 ** Muse Mode highlighting (lisp/muse-colors.el)
160 *** New option: muse-colors-inline-images.
161 This determines whether or not to inline an image.  The default is to
162 enable this behavior.
164 **** `C-c C-i' toggles whether images are inlined.
166 **** New option: muse-colors-inline-image-method.
167 This determines how to find an image that we want to inline.  The
168 default is to look in the current directory.  If set to
169 'muse-colors-use-publishing-directory, it will look in the directory
170 where the current page will be published.
172 *** Make faces conform the namespace better.
173 `muse-link-face' is renamed to `muse-link'.
174 `muse-bad-link-face' is renamed to `muse-bad-link'.
175 `muse-verbatim-face' is renamed to `muse-verbatim'.
177 *** Handle muse-emphasis faces better.
179 *** Make links blue by default, like most other Emacs modes do.
181 ** New modules
183 *** lisp/muse-backlink.el -- Provide backlink support for Muse.
185 *** lisp/muse-groff.el --  This introduces the publishing styles
186 "groff" and "groff-pdf".
188 *** lisp/muse-latex2png.el -- Publish embedded LaTeX content to a PNG file.
189 This introduces the <latex> tag.
191 *** lisp/muse-xml-common.el -- Common functionality used by XML-based
192 publishing styles, such as HTML, XML, and DocBook.
194 *** experimental/muse-mathml.el -- This introduces the "mathml"
195 publishing style and the <math> tag.
197 *** experimental/muse-protocol-iw.el: Implements a simpler URL-like
198 interwiki protocol that handles subdirectories.
200 *** experimental/muse-split.el -- Splits published Muse files into several
201 smaller files.
203 ** Project settings (lisp/muse-project.el)
205 *** Introduce the `with-muse-project' macro, which makes it easier
206 to switch to a given Muse project and execute some code.
208 *** Fix an error with `custom-quote'.
210 *** Ignore buffers that have no associated filename.
211 This fixes an annoyance where Muse prompts to save BBDB and ERC
212 buffers before publishing.
214 *** If we cannot find a project to publish, indicate this in an
215 error message.  This fixes an infinite loop.
217 *** Update the file-alist whenever a Muse file is saved.
219 *** Prevent infinite recursion when updating the file alist.
221 *** In addition to Arch and CVS metadata directories, also ignore
222 these for Darcs and SVN.  Also, don't erroneously ignore files with
223 "#" in them.
225 *** Make links to subdirectories work.
226 The idea is to include as much of the path that is needed in order to
227 disambiguate the link.  For example: "web/TestPage".
229 *** New variable: muse-current-output-style.
230 This holds the output style that is currently being used to publish a
231 file.
233 ** Publishing (lisp/muse-publish.el)
235 *** Implement escaping of specials throughout the entire document.
236 This makes it much easier to publish documents to multiple kinds of
237 formats, since you no longer have to worry about putting <verbatim>
238 around specials.
240 *** Make escaping of specials context-sensitive.
241 Muse now realizes that URLs, normal document text, <example> regions,
242 and the like have different special characters to escape.
244 *** Distinguish links and footnotes better.
246 *** Simplify markup string for anchors.
248 *** Allow text like "%N%" in markup strings.
249 This makes it much easier to re-use the same text or put strings in
250 a different order.
252 *** Support nested lists.
253 Muse now determines the nested level of a list by its initial
254 whitespace.  Ordered lists, unordered lists, and definition lists can
255 all be nested.  It is even possible to force a line break in a list
256 item by inserting a blank line on the same level between the lines.
257 Blockquotes may also be nested inside of a list.
259 *** Create parent directories when publishing for the first time.
261 *** Allow empty elements in tables.
263 *** Allow initial and trailing whitespace in tables, but strip it
264 out of the published result.
266 *** Handle case where we are trying to publish a file that has not
267 been saved.
269 *** Handle nested emphasis types better.
270 It should now publish exactly the way it looks in Muse Mode.
272 *** Fix XEmacs issue where text at beginning of buffer is read-only.
274 *** Allow publishing styles to specify a function to use for
275 escaping specials in a particular context.  This is especially handy
276 for HTML URLs, since they have a larger subset of special characters
277 than normal characters.
279 See `muse-xml-decide-specials' in muse-xml-common.el for details.
280 This functionality already exists for escaping specials in strings.
282 *** Fix an infinite loop problem.
284 *** Preserve whitespace around emdash.
285 This allows for more flexibility, since some people seem to prefer to
286 have the emdash directly against the surrounding text, while others
287 like it to be spaced.
289 *** If the #disable-tables publishing directive exists on the current
290 Muse page, do not generate a table.
292 *** Don't give an error when trying to define or derive an existing
293 style.  Just replace it.
295 *** Get rid of a warning that occurs when batch publishing.
297 *** Ignore list items that are part of higher-priority constructs
298 like emphasis.
300 *** Don't markup emdash in a link, since otherwise it will be
301 incorrectly escaped.
303 *** Improve the published descriptions for implicit links and explicit
304 links with no provided description.
306 *** Require at least once space after "::" in definition lists, so
307 we avoid an ambiguity with interwiki link syntax.
309 *** For headers and footers, use a better algorithm to detect whether
310 we have been given a filename or the real contents.
312 *** New option: muse-publish-markup-header-footer-tags.
313 This specifies which tags may be used when publishing headers and
314 footers.
316 *** New option: muse-publish-contents-depth.
317 This specifies the maximum depth of headings to include with
318 <contents> tags.
320 *** Allow `muse-publish-markup-buffer' to work even if the buffer
321 is not associated with a file.
323 *** Fix a compilation bug with XEmacs beta.
325 *** Allow the <lisp> tag to take the "markup" attribute.
326 see the Tag Summary section in the manual for details.
328 *** Publish image links with descriptions as captioned images.
329 This has been implemented for all Muse publishing styles.
331 The major change is that image links with descriptions will be
332 centered and the description will be displayed just below the image as
333 a "caption".  Thus, it is meant to only be used as its own paragraph,
334 not surrounded by other text.  Images without descriptions may still
335 have surrounding text.
337 *** Source-level change: Use 'image instead of 'image-link to indicate
338 images without descriptions.  Use 'image-link instead of
339 'url-with-image to indicate URLs that have an image as their
340 description.
342 *** Nested tags are now supported.
343 To activate this, set the 4th element in a `muse-publish-markup-tag'
344 to non-nil.  Note that this involved a change to the structure of
345 `muse-publish-markup-tag', so be sure to change any custom tags
346 appropriately.
348 *** New tags, see the Tag Summary section in the manual for details
350 **** <comment> -- Designate entire regions as comments.
352 **** <include> -- Insert the given file at publish time.
354 **** <markup> -- Mark up the text between the initial and ending tags.
356 **** <perl> -- Evaluate perl code.
358 **** <python> -- Evaluate python code.
360 **** <quote> -- Publish the region as a blockquote.
362 **** <ruby> -- Evaluate ruby code.
364 ** Texinfo publishing (lisp/muse-texinfo.el)
366 *** Escape commas in URLs.
368 *** Make it so that links to other info or PDF documents use the proper
369 suffix.
371 ** URL protocols (lisp/muse-protocols.el)
373 *** Add support for DOI's.
374 DOI's (digitial object identifiers) are a standard identifier used in
375 the publishing industry.
377 *** Add support for "dict:" URLs.
378 This is used to look up terms on the Wikipedia website.
380 **** New option: muse-wikipedia-country.
381 This specified the country code to use for Wikipedia.
383 ** Wiki (lisp/muse-wiki.el)
385 *** If the document does not have a valid title string, use the
386 empty string.
388 *** Fix some bugs.
390 *** New option: muse-wiki-wikiword-match-project-files.
391 Whether to extend WikiName functionality to also match
392 existing filenames, regardless of whether they are named in
393 WikiWord format.
395 If non-nil, Muse will color and publish implicit links to any
396 file in your project.  The default is nil.
398 *** Match filenames in the project before the general WikiWord
399 regexp.
401 *** Take the value of `muse-wiki-hide-nop-tag' into account.
403 *** New option: muse-wiki-ignore-implicit-links-to-current-page.
404 Whether to ignore implicit links to the current page.
406 If non-nil, Muse will not recognize implicit links to the current
407 page, both when formatting and publishing.
409 *** For interwiki links, prefer files that have the same file extension
410 as the current file.
412 ** XML publishing (lisp/muse-xml.el)
414 *** Update examples/muse.rnc to handle nested list items.
416 *** Fix table generation when some attributes are not given.
418 * Changes in Muse 3.02.8
420 ** Building Muse
422 *** Compile the contents of the contrib directory.
424 *** The debian/ directory has been moved into its own branch.
425 It is now available at mwolson@gnu.org--2006/muse--debian--0.
427 *** Further parametrize the build system, so that it can be easily
428 used by other Emacs Lisp projects.
430 *** Include autoloads file (lisp/muse-autoloads.el) with releases.
432 ** CGI library (contrib/cgi.el)
434 *** Make this not depend on cl.el at runtime.
436 *** Re-add the example calendar application.
438 ** HTTP daemon (contrib/httpd.el)
440 *** Update this to work with newer versions of Emacs.
442 * Changes in Muse 3.02.7
444 ** Muse Mode highlighting (lisp/muse-colors.el)
446 *** Fix bug that caused Muse not to work with recent builds of Emacs 22.
448 * Changes in Muse 3.02.6
450 ** Building Muse
452 *** Autoloads for Muse are now generated in the muse-autoloads.el
453 file at build time.
455 ** HTML publishing (lisp/muse-html.el)
457 *** Don't escape "%" and "+" in URLs.
459 ** Muse Mode (lisp/muse-mode.el)
461 *** <lisp> tags are now evaluated at display time.
462 The actual contents of the buffer will not change, just the displayed
463 text.  To toggle this behavior, set `muse-colors-evaluate-lisp-tags'.
465 ** Publishing (lisp/muse-publish.el)
467 *** When errors happen during publishing, a more explanatory message
468 is displayed.
470 *** It is now possible to specify non-breaking-space with "~~"
471 (two tildes).  This helps prevent proper names from being split up in
472 the output.
474 *** Escape specials in all forms of emphasis.
476 *** Escape "[" and "]" in links that are entered using muse-make-link.
478 *** Errors from invalid lisp code in a <lisp> tag will be published
479 as a comment.  If you have `muse-publish-comments-p' set to nil, the
480 effect is to remove the error message.
482 *** Fix several publishing issues involving comments and numbered lists.
484 ** Wiki (lisp/muse-wiki.el)
486 *** Interwiki links in extended links that have special characters are
487 now handled properly.
489 ** XML publishing (lisp/muse-xml.el)
491 *** The XML publishing style is now considered stable.
492 Its schema is available in `examples/muse.rnc'.
494 * Changes in Muse 3.02.5
496 ** LaTeX publishing (lisp/muse-latex.el)
498 *** Use a better algorithm for determining how many times we need to
499 call pdflatex for publishing.  Anything with a Table of Contents needs
500 2 passes.
502 ** Muse Mode (lisp/muse-mode.el)
504 *** The 3 levels of emphasis now have corresponding muse-emphasis-N faces.
505 This permits the user to customize them, which may be useful if a font
506 does not have italic and/or bold versions.
508 *** Visiting pages with anchors works better.
510 *** Fix fill bug with semicolons in the middle of paragraphs.
512 *** Fix a bug with editing the link at point.
514 *** Fix a display bug with text like =<verbatim><example></verbatim>=.
516 ** Project settings (lisp/muse-project.el)
518 *** Fix an edge case that yielded a stringp: nil error.
520 *** Prevent auto-save files from being recognized as Muse files.
522 ** Wiki (lisp/muse-wiki.el)
524 *** By default, WikiWords can have consecutive capital letters.
526 *** Fix an error that occurs when muse-colors is not loaded.
528 *** It is now possible to specify a suffix for WikiWord links.
529 For example: WikiName''''s.  The WikiName part will be displayed and
530 colored as a link, but the "s" will be left alone.
532 * Changes in Muse 3.02.02
534 ** Configuration
536 *** A bug with customizing `muse-project-alist' has been fixed.
538 *** We use a file extension for Muse files by default.
539 To obtain the old behavior, set `muse-file-extension' to nil and
540 `muse-mode-auto-p' to t.
542 To go along with the new behavior, be sure to rename all of your Muse
543 files to have a ".muse" extension.
545 *** New option: `muse-wiki-ignore-bare-project-names'.
546 This causes Muse to ignore bare project names if specified.  The
547 default is to turn bare project names into links.
549 *** New option: `muse-publish-comments-p'.
550 This causes Muse to publish comments as markup.  The default is to
551 remove comments before publishing rather than trying to mark them up.
553 *** New option: `muse-wiki-allow-nonexistent-wikiword'.
554 Enabling this will cause WikiWords with no corresponding file to be
555 colored as bad links.  The default is not to color them and turn them
556 into links.
558 ** Muse Mode (lisp/muse-mode.el)
560 *** An error with intangible links has been fixed.
562 *** Visiting a page with an anchor works better than before.
564 *** Flyspell behaves better with Emacs21 than before.
566 *** Links to nonexistent files will be colored red by default.
567 This happened previously, but the algorithm was buggy and didn't cover
568 implicit links.
570 ** Project handling (lisp/muse-project.el)
572 *** A convenience macro called `with-muse-project' has been added.
573 This allows a code block to be executed after changing the current
574 Muse project.  It is analogous to emacs-wiki's
575 `with-emacs-wiki-project' function.
577 ** Publishing (lisp/muse-publish.el)
579 *** An issue involving anchors at the end of a line has been
580 addressed.
582 *** Non-word characters are now allowed before an anchor.
584 *** Comments may now be published, if desired.
585 This behavior may be controlled with the `muse-publish-comments-p'
586 option.  The default is to remove comments before publishing rather
587 than trying to mark them up.
589 *** Publishing directives may now include a dash character.
591 ** LaTeX publishing (lisp/muse-latex.el)
593 *** A bug with footnotes has been addressed.
594 An attempt has been made to make generated footnote markup look more
595 "natural" to experienced LaTeX users.
597 *** Table headers are underlined and table footers are overlined.
599 *** PDF publishing will cause pdflatex to be called as needed.
600 The previous behavior was to always call pdflatex twice.  Currently,
601 if pdflatex succeeds, it will not be called again.  Otherwise, call it
602 up to three times.
604 *** Escaping of special characters should be drastically improved.
605 An attempt has been made to get escaping done right in most contexts.
606 The only quirk is that you must surround dollar signs with equal signs
607 to ensure escaping.  This makes publishing PDF documents much more
608 useful.
610 ** Texinfo publishing (lisp/muse-texinfo.el.el)
612 *** An attempt was made to hone some of the markup.
614 * Changes in Muse 3.02.01
616 ** Muse Mode (lisp/muse-mode.el)
618 *** Links should no longer prevent moving the point, and help text for
619 links should no longer cause errors to occur.
621 ** Project handling (lisp/muse-project.el)
623 *** `muse-project-alist' -- This variable should now save customizations
624 to the correct form in the .emacs file.  Before, it was saving an
625 intermediate form of the variable.
627 If you have used the customize interface in the previous release of
628 Muse to set `muse-project-alist', please do the following to import
629 your settings.
631  - Open your .emacs file.
632  - Move the point to where `muse-project-alist' is set.
633  - Type `M-: (setq muse-project-alist-using-customize t) RET'.
634  - Type `C-M-x'.
635  - Type `M-x customize-save-variable RET muse-project-alist RET'.
637 *** `muse-project-alist' -- A bug involving the deleting of items
638 using Emacs21 and XEmacs21 has been fixed.
640 ** Publishing (lisp/muse-publish.el)
642 *** If 2 or more blank lines separate list or table items, each item
643 will be published in a separate list or table.
645 *** The #date directive is now populated by default with the last
646 modified time of each file, rather than the current time of day.  To
647 use this value, add '<lisp>(muse-publishing-directive "date")<lisp>'
648 to your header or footer.
650 ** HTML publishing (lisp/muse-html.el)
652 *** `muse-xhtml-style-sheet' -- New option that indicates the style
653 settings to use for XHTML documents.  This may be either a filename or
654 a string of stylesheet settings.
656 * Changes in Muse 3.02
658 ** New modules
660 *** lisp/muse-wiki.el --- Provide automatic linking for WikiWords and
661 InterWiki links.  These words are clickable and publish as links.
662 Project names from `muse-project-alist' are available for InterWiki
663 linking by default.  The list of InterWiki names and handlers may be
664 customized through `muse-wiki-interwiki-alist'.
666 WikiWords that do not correspond with real files will not be displayed
667 as links nor published as links.  It is expected that this behavior
668 will be made optional in future versions of Muse.
670 **** This module includes a few helper functions that may be added to
671 `muse-publish-desc-transforms' in order to modify link descriptions at
672 publish time.
674 **** The concept of "implicit links" and "explicit links" has been
675 introduced.  Explicit links are surrounded by brackets, i.e.
676 [[http://blah.org][this is a explicit link]].  Implicit links are URLs
677 and email addresses that are not surrounded by brackets: they will not
678 be colorized or published if surrounded by double-quotes.
680 ***** `muse-wiki-publish-pretty-title' causes words to be Title-cased,
681 ignoring words like `the' and `at' which should not be changed.
683 ***** `muse-wiki-publish-pretty-interwiki' changes the delimiter of
684 interwiki links according to the text of the
685 `muse-wiki-interwiki-replacement' option.
687 *** lisp/muse-protocols.el --- URL protocols that Muse recognizes.
688 This automatically-included module provides an easily customizable
689 list of URL protocols, how to browse them, and how to resolve them for
690 publishing.  Customize `muse-url-protocols' to add and remove
691 protocols.
693 ** Compatibility fixes
695 *** Muse has been tested with XEmacs 21.4, both Mule and non-Mule versions.
696 There are no known problems remaining.  To make things work by
697 default, the iso-8859-1 charset is used as a default option in some
698 places.
700 ** Configuration
702 *** `muse-file-extension' -- New option that allows the file extension
703 for Muse files to be specified.  For example, setting this to "muse"
704 assumes that you have renamed your Muse files with a ".muse"
705 extension.  Using this (and setting `muse-mode-auto-p' to nil) will
706 prevent miscellaneous non-Muse files from being accidentally opened in
707 Muse Mode.
709 *** `muse-ignored-extensions' -- New option that determines which file
710 extensions to omit from the ending of a Muse page name.
712 *** `muse-ignored-extensions-regexp' -- This is no longer customizable.
713 It will be automatically generated from `muse-file-extension' and
714 `muse-ignored-extensions'.
716 *** `muse-project-alist' -- The customize interface for this option has
717 been greatly improved, and much effort has been spent in order to make
718 this user-friendly.
720 *** The `:force-publish' tag may be specified in `muse-project-alist'.
721 This causes a particular list of files to be re-created every time the
722 publishing process is invoked, even if they haven't been changed
723 according to their timestamps.  One use for this is to keep an index
724 of available pages by adding the following to a file in this list.
726 <lisp>(muse-index-as-string t t t)</lisp>
728 *** `muse-project-ignore-regexp' -- By default, version control directories
729 are now included in this regexp so that they don't appear when you hit
730 C-c C-f to browse files in a project.
732 *** The `muse-project-alist-styles' and `muse-project-alist-dirs' functions
733 may be used in `muse-project-alist' to recursively add styles and
734 directory listings for a given directory.  The following is an
735 example.  We use a backtick instead of a single quote to begin the
736 list.
738 (setq muse-project-alist
739       `(("Blog"
740          (,@(muse-project-alist-dirs "~/proj/wiki/blog")  ;; base dir
741           :default "guestbook")
743          ,@(muse-project-alist-styles "~/proj/wiki/blog"  ;; base dir
744                                       ;; output dir
745                                       "~/personal-site/site/blog"
746                                       ;; style
747                                       "my-blosxom"))))
749 Note that if you use the customize interface for `muse-project-alist',
750 you will still have to manually add information for any new
751 sub-directories.
753 ** Debian packaging
755 *** Debian packages for Muse have entered Debian unstable, thanks
756 to Romain Francoise, my sponsor.
758 It is possible to roll your own Muse packages if you want to do so.
759 Packages may be built by using `make debrelease', once the proper
760 options in Makefile.defs are set.  Revisions may be built using `make
761 debrevision'.
763 The manual and relevant documentation files have been included with
764 the Debian package for Muse.
766 ** Muse Mode (lisp/muse-mode.el)
768 *** Allow use of Muse with outline-minor-mode.
770 *** Filling text does the right thing with list items and footnotes.
771 List items and footnotes will no longer be concatenated when hitting
772 M-q in the midst of consecutive items.
774 *** Links will never be split in the middle when using Fill.
776 *** Some flyspell crash issues were addressed.
777 Using intangible text can cause strange problems with flyspell mode.
778 Hence, by default, the intangible property will be ignored.  A new
779 option called `muse-mode-intangible-links' indicates whether this
780 should be the case.
782 *** Links will no longer be highlighted by flyspell.
783 If you're using XEmacs or Emacs 22, flyspell will ignore links,
784 including link text.  This keeps flyspell from making the links
785 unclickable.  If you're using Emacs 21, flyspell will continue to
786 interfere with links.  If you know how to fix this, please send a
787 patch!
789 *** A few edge cases for emphasis and underlining have been addressed.
791 *** <example>, <verbatim>, and =surrounded text= are now colored using
792 the new face `muse-verbatim-face'.
794 *** All marked up text properties, like emphasis and underlining,
795 will be removed for the text between <example>, <verbatim>, <code>,
796 <literal>, and <lisp> tags.
798 *** Links to temporary files may be visited.
799 A "temporary file" in this case is a buffer that is not associated
800 with any file.  For some dynamic content import scripts with Planner,
801 this is helpful.
803 *** Typing "#title" should never crash Emacs anymore.
805 ** Muse manual (muse.texi)
807 *** Fix problem with producing a PDF version of the manual.
809 *** Document WikiNames.
811 *** Bring up-to-date with latest features.
813 *** Massively update Common Elements section.
815 *** New Directives section.
816 This describes the use of #title and #author, as well as other
817 directives that may be used.
819 *** New Comments section.
820 Describes the use of "; comment text".
822 ** Publishing (lisp/muse-publish.el)
824 *** The order of rules should be much improved.
825 This means that emphasis characters like `*' and `_' will never be
826 interpreted as such if they are within links.
828 *** The user will be notified when `muse-publish-this-file' fails to
829 publish the current file.  This happens when the timestamp of the
830 current file indicates that it is up-to-date.
832 *** Special characters are escaped in link descriptions and links on a
833 more consistent basis.  What defines a "special character" varies
834 according to the publishing style.
836 *** Errors that occur during publish time will cause a warning to be
837 displayed prominently, rather than being ignored.  It should no longer
838 be possible to mess up a Muse source file by tweaking the Muse
839 publishing process.
841 *** Errors in <lisp> tags cause a warning to be displayed and
842 return "<!--INVALID LISP CODE-->".  Muse will try to continue
843 publishing the page.
845 *** An emdash ("--") can now be used after a list, as long as there is
846 a blank line between the end of the list and the emdash.
848 *** The <code> tag has been introduced.
849 It does the same thing that =equal signs= do: escape specials and
850 publish as teletype text.  Use it for short command snippets and the
851 like.  <example> is a better choice for large blocks of code, since it
852 preserves whitespace.
854 *** An edge case involving links at the beginning of a paragraph
855 has been addressed.
857 *** An edge case involving consecutive directives of the same size
858 has been addressed.
860 *** Every publishing style is now capable of specifying strings to use
861 for sections beyond the third level.
863 *** Every publishing style may specify an end-of-section string.
864 This is used, for example, by the experimental XML style and the
865 DocBook style.
867 *** Every publishing style may specify a method of handling "internal
868 link" markup.  An internal link is a link that refers to an anchor on
869 the current page.
871 *** Every publishing style may specify a link suffix to use.
872 This allows the file extensions in links to other Muse files to be
873 different from their actual extension.  Blosxom makes use of this
874 (since its published files are .txt and the dynamically-generated
875 output is .html), and it could come in handy for PHP stuff.
877 If a link suffix is not specified via :link-suffix, the value of
878 :suffix will be used.
880 ** Blosxom publishing (lisp/muse-blosxom.el)
882 *** muse-blosxom-new-entry: A #category directive is added by default.
883 Nothing is done with this yet, but it could be handy for tag-based
884 (multiple category) blogging, once we figure out a good way to do that
885 in both Muse and Pyblosxom.  Ideas are welcome, and patches even more
888 ** DocBook publishing (lisp/muse-docbook.el)
890 *** The markup has been comprehensively improved.
891 Published documents will now pass validation tests and look better in
892 general.
894 *** It is now possible to specify the encoding of DocBook documents.
895 The default encoding is utf-8.
897 *** Footnotes will be embedded into paragraphs, since this is
898 The DocBook Way.
900 *** Tables will be sorted by section.
901 Headers first, then footers, then the rest of the table.
903 *** Anchors are now handled correctly and publish to the best available
904 form.  Links to anchors are published with the <link> tag.
906 ** HTML publishing (lisp/muse-html.el)
908 *** Fix minor issue with anchors.
910 *** Paragraph publishing will no longer insert <div> tags before images.
911 This was causing too much hassle for some programs that were trying to
912 extend Muse, like the Muse port of Planner.
914 *** The `&', `<', and '>' characters will be escaped using their specific
915 HTML escape codes, rather than with "&#NNN;".  This makes the
916 published output display correctly in more web browsers.
918 *** Use HTML 4.0 Transitional by default for `muse-html-header'.
920 *** Include empty alt element in markup string for images that lack a
921 description.
923 *** Tables will be sorted by section.
924 Headers first, then footers, then the rest of the table.
926 *** `muse-xhtml-extension' -- The default extension for XHTML publishing.
927 This is a new option.
929 ** Journal publishing (lisp/muse-journal.el)
931 *** Use "div class=..." rather than "div id=..." for sections.
933 ** LaTeX publishing (lisp/muse-latex.el)
935 *** A newline will be appended to the default footer for the latex and
936 latexpdf publishing styles.  This keeps the PDF-building process from
937 failing due to lack of a newline at end of file.
939 *** Anchors and links to them now work properly.
941 *** When generating PDF files, call pdflatex twice.
942 This should ensure that the table of contents gets generated, if one
943 is due to be published.
945 *** PDF files with spaces may be published.
946 A bug preventing this has been fixed.
948 *** Teletype text is now published using \\texttt{...}.
950 *** An attempt has been made to escape special characters more
951 consistently.
953 ** Texinfo publishing (lisp/muse-texinfo.el)
955 *** Fix a fatal error that occurs when publishing tables.
957 *** Generate the contents in the header by default rather than the footer.
958 This is the way that most Texinfo manuals do it.
960 *** The info-pdf publishing style currently produces the best PDF output
961 on the maintainer's machine, so it is now used to publish the PDF
962 version of the Muse Manual.
964 *** The characters `{' and `}' will be treated as special characters that
965 need to be escaped at publish-time.
967 *** Improve dots and enddots markup strings.
969 *** Surround underlined text with "_" since Texinfo doesn't seem to have
970 any better options for producing underlined text.
972 *** Anchors and links to them now work properly.