Re-license manual to GFDL instead of GPL
[muse-el.git] / NEWS
blob4263648ca9a5cb6e4639f294bba9ab228e7d3bda
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 ** DocBook publishing (lisp/muse-docbook.el)
44 *** A bug with multiple-stanza verses has been fixed.
46 ** HTML publishing (lisp/muse-html.el)
48 *** Make sure spaces in URLs get escaped properly.
50 *** Make the Table of Contents CSS easier to customize.
51 For an example, see examples/mwolson/stylesheets/screen.css.
53 *** Fix a paragraph detection bug for paragraphs that occur after
54 verses.
56 ** Importing LaTeX documents (lisp/muse-import-latex.el)
58 *** Rename from muse-convert.el.
59 There are plans for importing other formats into Muse as well.
61 ** Journal (lisp/muse-journal.el)
63 *** New option: muse-journal-rss-heading-regexp.
64 Determine the regexp to use when searching for an RSS heading.
66 *** Make sure that the date is in a format that RSS readers
67 can handle.
69 ** LaTeX publishing (lisp/muse-latex.el)
71 *** Improve escaping of specials.
73 *** Use \label{} and \ref{} for anchors and anchor references.
75 *** Emphasize table elements.
77 *** Improve table generation.
79 *** Use \url{} to publish bare URLs.
81 *** Handle case where a Muse page begins with a quote character.
83 *** Display footnotes when we have both a URL and description.
84 This makes the URLs show up on printed documents in a sensible
85 fashion.
87 *** Escape the "@" character in the entire document.
89 *** Make images take up 75% of the width of the page.
91 *** New option: muse-latex-permit-contents-tag.
92 This specifies whether we should take action on the <contents> tag.
94 *** Allow for definitions to be separated from their terms,
95 much like the way HTML does it by default, if the user puts a blank
96 line or a line break between the term and the definition.
98 If the term and definition are on the same line, they will be that way
99 in the output as well.
101 ** Muse Manual (muse.texi)
103 *** Re-license under the GFDL instead of the GPL.
104 The rationale for this is that Muse may one day be included with
105 Emacs, so it should use the same manual license that Emacs itself
106 uses.  At this point, the matter is not open to debate, unless the FSF
107 brings it up.
109 *** Use better style for subsections.
111 *** Make sure the PDF file for the manual is properly generated.
113 *** Implicit Links
115 **** Mention how to customize the WikiName recognition.
117 *** Extending Muse
119 **** Move "Common Elements" and "Deriving Styles" chapters here.
121 ** Muse Mode (lisp/muse-mode.el)
123 *** `C-c TAB' now inserts an object, prompting the user for which type.
124 `C-c TAB l' inserts a relative link.
125 `C-c TAB t' inserts a Muse tag.
126 `C-c TAB u' inserts a URL.
128 These keybindings may be modified by editing `muse-insert-map'.  Note
129 that the prompt you get when you hit `C-c TAB' will not change.
131 *** New list-oriented keybindings:
132 `M-RET' inserts a list item.
133 `C->' increases list item indentation.
134 `C-<' decreases list item indentation.
136 *** Slightly improvement speed of flyspell integration
138 *** Implement searching through Muse files.
140 **** `C-c C-s' performs a search through Muse files.
142 **** New option: muse-grep-command.
143 Customize this to specify the command used for searching.  In
144 particular, "glimpse" is handy.  Check the documentation for this
145 command for details.
147 *** Changed keybindings:
148 `C-c C-b' is now `muse-find-backlinks'
149 `C-c C-v' is now `muse-browse-result'
151 *** Remove the C-c C-c keybinding, since it conflicts with other
152 modes like Planner.
154 *** Don't require muse-publish.el, since publishing and viewing Muse
155 files are supposed to be completely separable.
157 *** Speed up searching for next and previous references.
159 *** Make filling definition lists work better.
161 *** Make editing existing links with `C-c C-e' work better.
163 *** Make browsing the resulting page with `C-c C-v' work better.
165 *** Don't throw an error if doing flyspell or following link at
166 beginning of buffer.
168 *** When publishing a file with `C-c C-t', consult muse-project-alist
169 and use its publishing styles to intelligently prompt the user as to
170 the publishing style and output directory.
172 The old behavior of allowing the file to be published anywhere and
173 with any style has been moved to `C-c C-T'.
175 *** Clicking `mouse-2' now does the right thing when
176 mouse-yank-at-point is non-nil.
178 ** Muse Mode highlighting (lisp/muse-colors.el)
180 *** New option: muse-colors-inline-images.
181 This determines whether or not to inline an image.  The default is to
182 enable this behavior.
184 **** `C-c C-i' toggles whether images are inlined.
186 **** New option: muse-colors-inline-image-method.
187 This determines how to find an image that we want to inline.  The
188 default is to look in the current directory.  If set to
189 'muse-colors-use-publishing-directory, it will look in the directory
190 where the current page will be published.
192 *** Make faces conform the namespace better.
193 `muse-link-face' is renamed to `muse-link'.
194 `muse-bad-link-face' is renamed to `muse-bad-link'.
195 `muse-verbatim-face' is renamed to `muse-verbatim'.
197 *** Handle muse-emphasis faces better.
199 *** Make links blue by default, like most other Emacs modes do.
201 *** Source-level change: The regexps in `muse-colors-markup' are now
202 permitted to have non-shy groupings.
204 ** New modules
206 *** lisp/muse-backlink.el -- Provide backlink support for Muse.
208 *** lisp/muse-groff.el --  This introduces the publishing styles
209 "groff" and "groff-pdf".
211 *** lisp/muse-import-docbook.el -- Convert Docbook XML into Muse format.
213 *** lisp/muse-import-xml.el -- Helper file for muse-import-docbook.el.
215 *** lisp/muse-latex2png.el -- Publish embedded LaTeX content to a PNG file.
216 This introduces the <latex> tag.
218 *** lisp/muse-xml-common.el -- Common functionality used by XML-based
219 publishing styles, such as HTML, XML, and DocBook.
221 *** experimental/muse-mathml.el -- This introduces the "mathml"
222 publishing style and the <math> tag.
224 *** experimental/muse-protocol-iw.el: Implements a simpler URL-like
225 interwiki protocol that handles subdirectories.
227 *** experimental/muse-split.el -- Splits published Muse files into several
228 smaller files.
230 ** Project settings (lisp/muse-project.el)
232 *** Introduce the `with-muse-project' macro, which makes it easier
233 to switch to a given Muse project and execute some code.
235 *** Fix an error with `custom-quote'.
237 *** Ignore buffers that have no associated filename.
238 This fixes an annoyance where Muse prompts to save BBDB and ERC
239 buffers before publishing.
241 *** If we cannot find a project to publish, indicate this in an
242 error message.  This fixes an infinite loop.
244 *** Update the file-alist whenever a Muse file is saved.
246 *** Prevent infinite recursion when updating the file alist.
248 *** In addition to Arch and CVS metadata directories, also ignore
249 these for Darcs and SVN.  Also, don't erroneously ignore files with
250 "#" in them.
252 *** Make links to subdirectories work.
253 The idea is to include as much of the path that is needed in order to
254 disambiguate the link.  For example: "web/TestPage".
256 *** New variable: muse-current-output-style.
257 This holds the output style that is currently being used to publish a
258 file.
260 *** Permit non-Muse files in projects to be linked to.
262 *** Handle relative links to other Muse pages.
263 Relative links are prefixed with "./" or "../".
265 *** New option: muse-project-publish-private-files
266 If this is non-nil (the default), files will be published even if they
267 have "o-r" permissions set (that is, if no one except the owner and
268 possibly group are allowed to read them).  To get back the old
269 behavior, set this to nil.
271 ** Publishing (lisp/muse-publish.el)
273 *** Implement escaping of specials throughout the entire document.
274 This makes it much easier to publish documents to multiple kinds of
275 formats, since you no longer have to worry about putting <verbatim>
276 around specials.
278 *** Make escaping of specials context-sensitive.
279 Muse now realizes that URLs, normal document text, <example> regions,
280 and the like have different special characters to escape.
282 *** Distinguish links and footnotes better.
284 *** Simplify markup string for anchors.
286 *** Allow text like "%N%" in markup strings.
287 This makes it much easier to re-use the same text or put strings in
288 a different order.
290 *** Support nested lists.
291 Muse now determines the nested level of a list by its initial
292 whitespace.  Ordered lists, unordered lists, and definition lists can
293 all be nested.  It is even possible to force a line break in a list
294 item by inserting a blank line on the same level between the lines.
295 Blockquotes may also be nested inside of a list.
297 *** Create parent directories when publishing for the first time.
299 *** Allow empty elements in tables.
301 *** Allow initial and trailing whitespace in tables, but strip it
302 out of the published result.
304 *** Handle case where we are trying to publish a file that has not
305 been saved.
307 *** Handle nested emphasis types better.
308 It should now publish exactly the way it looks in Muse Mode.
310 *** Fix XEmacs issue where text at beginning of buffer is read-only.
312 *** Allow publishing styles to specify a function to use for
313 escaping specials in a particular context.  This is especially handy
314 for HTML URLs, since they have a larger subset of special characters
315 than normal characters.
317 See `muse-xml-decide-specials' in muse-xml-common.el for details.
318 This functionality already exists for escaping specials in strings.
320 *** Fix an infinite loop problem.
322 *** Preserve whitespace around emdash.
323 This allows for more flexibility, since some people seem to prefer to
324 have the emdash directly against the surrounding text, while others
325 like it to be spaced.
327 *** If the #disable-tables publishing directive exists on the current
328 Muse page, do not generate a table.
330 *** Don't give an error when trying to define or derive an existing
331 style.  Just replace it.
333 *** Get rid of a warning that occurs when batch publishing.
335 *** Ignore list items that are part of higher-priority constructs
336 like emphasis.
338 *** Don't markup emdash in a link, since otherwise it will be
339 incorrectly escaped.
341 *** Improve the published descriptions for implicit links and explicit
342 links with no provided description.
344 *** Require at least once space after "::" in definition lists, so
345 we avoid an ambiguity with interwiki link syntax.
347 *** For headers and footers, use a better algorithm to detect whether
348 we have been given a filename or the real contents.
350 *** New option: muse-publish-markup-header-footer-tags.
351 This specifies which tags may be used when publishing headers and
352 footers.
354 *** New option: muse-publish-contents-depth.
355 This specifies the maximum depth of headings to include with
356 <contents> tags.
358 *** Allow `muse-publish-markup-buffer' to work even if the buffer
359 is not associated with a file.
361 *** Fix a compilation bug with XEmacs beta.
363 *** Allow the <lisp> tag to take the "markup" attribute.
364 see the Tag Summary section in the manual for details.
366 *** Publish image links with descriptions as captioned images.
367 This has been implemented for all Muse publishing styles.
369 The major change is that image links with descriptions will be
370 centered and the description will be displayed just below the image as
371 a "caption".  Thus, it is meant to only be used as its own paragraph,
372 not surrounded by other text.  Images without descriptions may still
373 have surrounding text.
375 *** Source-level change: Use 'image instead of 'image-link to indicate
376 images without descriptions.  Use 'image-link instead of
377 'url-with-image to indicate URLs that have an image as their
378 description.
380 *** Self-nested tags are now supported.
381 Tags with the same name can now be nested inside one another.  This
382 only applies to the new <quote> tag and the <class> tag currently, but
383 it may be useful for custom tags as well.
385 To activate this, set the 4th element in a `muse-publish-markup-tag'
386 to non-nil.  Note that this involved a change to the structure of
387 `muse-publish-markup-tag', so be sure to change any custom tags
388 appropriately.
390 *** Fix bug with WikiName link descriptions and PDF output.
392 *** New tags, see the Tag Summary section in the manual for details
394 **** <comment> -- Designate entire regions as comments.
396 **** <include> -- Insert the given file at publish time.
398 **** <markup> -- Mark up the text between the initial and ending tags.
400 **** <perl> -- Evaluate perl code.
402 **** <python> -- Evaluate python code.
404 **** <quote> -- Publish the region as a blockquote.
406 **** <ruby> -- Evaluate ruby code.
408 ** Texinfo publishing (lisp/muse-texinfo.el)
410 *** Escape commas in URLs.
412 *** Make it so that links to other info or PDF documents use the proper
413 suffix.
415 ** URL protocols (lisp/muse-protocols.el)
417 *** Add support for DOI's.
418 DOI's (digitial object identifiers) are a standard identifier used in
419 the publishing industry.
421 *** Add support for "dict:" URLs.
422 This is used to look up terms on the Wikipedia website.
424 **** New option: muse-wikipedia-country.
425 This specified the country code to use for Wikipedia.
427 ** Wiki (lisp/muse-wiki.el)
429 *** If the document does not have a valid title string, use the
430 empty string.
432 *** Fix some bugs.
434 *** New option: muse-wiki-wikiword-match-project-files.
435 Whether to extend WikiName functionality to also match
436 existing filenames, regardless of whether they are named in
437 WikiWord format.
439 If non-nil, Muse will color and publish implicit links to any
440 file in your project.  The default is nil.
442 *** Match filenames in the project before the general WikiWord
443 regexp.
445 *** Take the value of `muse-wiki-hide-nop-tag' into account.
447 *** New option: muse-wiki-ignore-implicit-links-to-current-page.
448 Whether to ignore implicit links to the current page.
450 If non-nil, Muse will not recognize implicit links to the current
451 page, both when formatting and publishing.
453 *** For interwiki links, prefer files that have the same file extension
454 as the current file.
456 *** Check the entire explicit link for a project name or complete
457 interwiki link, not just part of it.  This allows page names with
458 invalid WikiName characters to be referred to by using an explicit
459 link.
461 ** XML publishing (lisp/muse-xml.el)
463 *** Update examples/muse.rnc to handle nested list items.
465 *** Fix table generation when some attributes are not given.
467 * Changes in Muse 3.02.8
469 ** Building Muse
471 *** Compile the contents of the contrib directory.
473 *** The debian/ directory has been moved into its own branch.
474 It is now available at mwolson@gnu.org--2006/muse--debian--0.
476 *** Further parametrize the build system, so that it can be easily
477 used by other Emacs Lisp projects.
479 *** Include autoloads file (lisp/muse-autoloads.el) with releases.
481 ** CGI library (contrib/cgi.el)
483 *** Make this not depend on cl.el at runtime.
485 *** Re-add the example calendar application.
487 ** HTTP daemon (contrib/httpd.el)
489 *** Update this to work with newer versions of Emacs.
491 * Changes in Muse 3.02.7
493 ** Muse Mode highlighting (lisp/muse-colors.el)
495 *** Fix bug that caused Muse not to work with recent builds of Emacs 22.
497 * Changes in Muse 3.02.6
499 ** Building Muse
501 *** Autoloads for Muse are now generated in the muse-autoloads.el
502 file at build time.
504 ** HTML publishing (lisp/muse-html.el)
506 *** Don't escape "%" and "+" in URLs.
508 ** Muse Mode (lisp/muse-mode.el)
510 *** <lisp> tags are now evaluated at display time.
511 The actual contents of the buffer will not change, just the displayed
512 text.  To toggle this behavior, set `muse-colors-evaluate-lisp-tags'.
514 ** Publishing (lisp/muse-publish.el)
516 *** When errors happen during publishing, a more explanatory message
517 is displayed.
519 *** It is now possible to specify non-breaking-space with "~~"
520 (two tildes).  This helps prevent proper names from being split up in
521 the output.
523 *** Escape specials in all forms of emphasis.
525 *** Escape "[" and "]" in links that are entered using muse-make-link.
527 *** Errors from invalid lisp code in a <lisp> tag will be published
528 as a comment.  If you have `muse-publish-comments-p' set to nil, the
529 effect is to remove the error message.
531 *** Fix several publishing issues involving comments and numbered lists.
533 ** Wiki (lisp/muse-wiki.el)
535 *** Interwiki links in extended links that have special characters are
536 now handled properly.
538 ** XML publishing (lisp/muse-xml.el)
540 *** The XML publishing style is now considered stable.
541 Its schema is available in `examples/muse.rnc'.
543 * Changes in Muse 3.02.5
545 ** LaTeX publishing (lisp/muse-latex.el)
547 *** Use a better algorithm for determining how many times we need to
548 call pdflatex for publishing.  Anything with a Table of Contents needs
549 2 passes.
551 ** Muse Mode (lisp/muse-mode.el)
553 *** The 3 levels of emphasis now have corresponding muse-emphasis-N faces.
554 This permits the user to customize them, which may be useful if a font
555 does not have italic and/or bold versions.
557 *** Visiting pages with anchors works better.
559 *** Fix fill bug with semicolons in the middle of paragraphs.
561 *** Fix a bug with editing the link at point.
563 *** Fix a display bug with text like =<verbatim><example></verbatim>=.
565 ** Project settings (lisp/muse-project.el)
567 *** Fix an edge case that yielded a stringp: nil error.
569 *** Prevent auto-save files from being recognized as Muse files.
571 ** Wiki (lisp/muse-wiki.el)
573 *** By default, WikiWords can have consecutive capital letters.
575 *** Fix an error that occurs when muse-colors is not loaded.
577 *** It is now possible to specify a suffix for WikiWord links.
578 For example: WikiName''''s.  The WikiName part will be displayed and
579 colored as a link, but the "s" will be left alone.
581 * Changes in Muse 3.02.02
583 ** Configuration
585 *** A bug with customizing `muse-project-alist' has been fixed.
587 *** We use a file extension for Muse files by default.
588 To obtain the old behavior, set `muse-file-extension' to nil and
589 `muse-mode-auto-p' to t.
591 To go along with the new behavior, be sure to rename all of your Muse
592 files to have a ".muse" extension.
594 *** New option: `muse-wiki-ignore-bare-project-names'.
595 This causes Muse to ignore bare project names if specified.  The
596 default is to turn bare project names into links.
598 *** New option: `muse-publish-comments-p'.
599 This causes Muse to publish comments as markup.  The default is to
600 remove comments before publishing rather than trying to mark them up.
602 *** New option: `muse-wiki-allow-nonexistent-wikiword'.
603 Enabling this will cause WikiWords with no corresponding file to be
604 colored as bad links.  The default is not to color them and turn them
605 into links.
607 ** Muse Mode (lisp/muse-mode.el)
609 *** An error with intangible links has been fixed.
611 *** Visiting a page with an anchor works better than before.
613 *** Flyspell behaves better with Emacs21 than before.
615 *** Links to nonexistent files will be colored red by default.
616 This happened previously, but the algorithm was buggy and didn't cover
617 implicit links.
619 ** Project handling (lisp/muse-project.el)
621 *** A convenience macro called `with-muse-project' has been added.
622 This allows a code block to be executed after changing the current
623 Muse project.  It is analogous to emacs-wiki's
624 `with-emacs-wiki-project' function.
626 ** Publishing (lisp/muse-publish.el)
628 *** An issue involving anchors at the end of a line has been
629 addressed.
631 *** Non-word characters are now allowed before an anchor.
633 *** Comments may now be published, if desired.
634 This behavior may be controlled with the `muse-publish-comments-p'
635 option.  The default is to remove comments before publishing rather
636 than trying to mark them up.
638 *** Publishing directives may now include a dash character.
640 ** LaTeX publishing (lisp/muse-latex.el)
642 *** A bug with footnotes has been addressed.
643 An attempt has been made to make generated footnote markup look more
644 "natural" to experienced LaTeX users.
646 *** Table headers are underlined and table footers are overlined.
648 *** PDF publishing will cause pdflatex to be called as needed.
649 The previous behavior was to always call pdflatex twice.  Currently,
650 if pdflatex succeeds, it will not be called again.  Otherwise, call it
651 up to three times.
653 *** Escaping of special characters should be drastically improved.
654 An attempt has been made to get escaping done right in most contexts.
655 The only quirk is that you must surround dollar signs with equal signs
656 to ensure escaping.  This makes publishing PDF documents much more
657 useful.
659 ** Texinfo publishing (lisp/muse-texinfo.el.el)
661 *** An attempt was made to hone some of the markup.
663 * Changes in Muse 3.02.01
665 ** Muse Mode (lisp/muse-mode.el)
667 *** Links should no longer prevent moving the point, and help text for
668 links should no longer cause errors to occur.
670 ** Project handling (lisp/muse-project.el)
672 *** `muse-project-alist' -- This variable should now save customizations
673 to the correct form in the .emacs file.  Before, it was saving an
674 intermediate form of the variable.
676 If you have used the customize interface in the previous release of
677 Muse to set `muse-project-alist', please do the following to import
678 your settings.
680  - Open your .emacs file.
681  - Move the point to where `muse-project-alist' is set.
682  - Type `M-: (setq muse-project-alist-using-customize t) RET'.
683  - Type `C-M-x'.
684  - Type `M-x customize-save-variable RET muse-project-alist RET'.
686 *** `muse-project-alist' -- A bug involving the deleting of items
687 using Emacs21 and XEmacs21 has been fixed.
689 ** Publishing (lisp/muse-publish.el)
691 *** If 2 or more blank lines separate list or table items, each item
692 will be published in a separate list or table.
694 *** The #date directive is now populated by default with the last
695 modified time of each file, rather than the current time of day.  To
696 use this value, add '<lisp>(muse-publishing-directive "date")<lisp>'
697 to your header or footer.
699 ** HTML publishing (lisp/muse-html.el)
701 *** `muse-xhtml-style-sheet' -- New option that indicates the style
702 settings to use for XHTML documents.  This may be either a filename or
703 a string of stylesheet settings.
705 * Changes in Muse 3.02
707 ** New modules
709 *** lisp/muse-wiki.el --- Provide automatic linking for WikiWords and
710 InterWiki links.  These words are clickable and publish as links.
711 Project names from `muse-project-alist' are available for InterWiki
712 linking by default.  The list of InterWiki names and handlers may be
713 customized through `muse-wiki-interwiki-alist'.
715 WikiWords that do not correspond with real files will not be displayed
716 as links nor published as links.  It is expected that this behavior
717 will be made optional in future versions of Muse.
719 **** This module includes a few helper functions that may be added to
720 `muse-publish-desc-transforms' in order to modify link descriptions at
721 publish time.
723 **** The concept of "implicit links" and "explicit links" has been
724 introduced.  Explicit links are surrounded by brackets, i.e.
725 [[http://blah.org][this is a explicit link]].  Implicit links are URLs
726 and email addresses that are not surrounded by brackets: they will not
727 be colorized or published if surrounded by double-quotes.
729 ***** `muse-wiki-publish-pretty-title' causes words to be Title-cased,
730 ignoring words like `the' and `at' which should not be changed.
732 ***** `muse-wiki-publish-pretty-interwiki' changes the delimiter of
733 interwiki links according to the text of the
734 `muse-wiki-interwiki-replacement' option.
736 *** lisp/muse-protocols.el --- URL protocols that Muse recognizes.
737 This automatically-included module provides an easily customizable
738 list of URL protocols, how to browse them, and how to resolve them for
739 publishing.  Customize `muse-url-protocols' to add and remove
740 protocols.
742 ** Compatibility fixes
744 *** Muse has been tested with XEmacs 21.4, both Mule and non-Mule versions.
745 There are no known problems remaining.  To make things work by
746 default, the iso-8859-1 charset is used as a default option in some
747 places.
749 ** Configuration
751 *** `muse-file-extension' -- New option that allows the file extension
752 for Muse files to be specified.  For example, setting this to "muse"
753 assumes that you have renamed your Muse files with a ".muse"
754 extension.  Using this (and setting `muse-mode-auto-p' to nil) will
755 prevent miscellaneous non-Muse files from being accidentally opened in
756 Muse Mode.
758 *** `muse-ignored-extensions' -- New option that determines which file
759 extensions to omit from the ending of a Muse page name.
761 *** `muse-ignored-extensions-regexp' -- This is no longer customizable.
762 It will be automatically generated from `muse-file-extension' and
763 `muse-ignored-extensions'.
765 *** `muse-project-alist' -- The customize interface for this option has
766 been greatly improved, and much effort has been spent in order to make
767 this user-friendly.
769 *** The `:force-publish' tag may be specified in `muse-project-alist'.
770 This causes a particular list of files to be re-created every time the
771 publishing process is invoked, even if they haven't been changed
772 according to their timestamps.  One use for this is to keep an index
773 of available pages by adding the following to a file in this list.
775 <lisp>(muse-index-as-string t t t)</lisp>
777 *** `muse-project-ignore-regexp' -- By default, version control directories
778 are now included in this regexp so that they don't appear when you hit
779 C-c C-f to browse files in a project.
781 *** The `muse-project-alist-styles' and `muse-project-alist-dirs' functions
782 may be used in `muse-project-alist' to recursively add styles and
783 directory listings for a given directory.  The following is an
784 example.  We use a backtick instead of a single quote to begin the
785 list.
787 (setq muse-project-alist
788       `(("Blog"
789          (,@(muse-project-alist-dirs "~/proj/wiki/blog")  ;; base dir
790           :default "guestbook")
792          ,@(muse-project-alist-styles "~/proj/wiki/blog"  ;; base dir
793                                       ;; output dir
794                                       "~/personal-site/site/blog"
795                                       ;; style
796                                       "my-blosxom"))))
798 Note that if you use the customize interface for `muse-project-alist',
799 you will still have to manually add information for any new
800 sub-directories.
802 ** Debian packaging
804 *** Debian packages for Muse have entered Debian unstable, thanks
805 to Romain Francoise, my sponsor.
807 It is possible to roll your own Muse packages if you want to do so.
808 Packages may be built by using `make debrelease', once the proper
809 options in Makefile.defs are set.  Revisions may be built using `make
810 debrevision'.
812 The manual and relevant documentation files have been included with
813 the Debian package for Muse.
815 ** Muse Mode (lisp/muse-mode.el)
817 *** Allow use of Muse with outline-minor-mode.
819 *** Filling text does the right thing with list items and footnotes.
820 List items and footnotes will no longer be concatenated when hitting
821 M-q in the midst of consecutive items.
823 *** Links will never be split in the middle when using Fill.
825 *** Some flyspell crash issues were addressed.
826 Using intangible text can cause strange problems with flyspell mode.
827 Hence, by default, the intangible property will be ignored.  A new
828 option called `muse-mode-intangible-links' indicates whether this
829 should be the case.
831 *** Links will no longer be highlighted by flyspell.
832 If you're using XEmacs or Emacs 22, flyspell will ignore links,
833 including link text.  This keeps flyspell from making the links
834 unclickable.  If you're using Emacs 21, flyspell will continue to
835 interfere with links.  If you know how to fix this, please send a
836 patch!
838 *** A few edge cases for emphasis and underlining have been addressed.
840 *** <example>, <verbatim>, and =surrounded text= are now colored using
841 the new face `muse-verbatim-face'.
843 *** All marked up text properties, like emphasis and underlining,
844 will be removed for the text between <example>, <verbatim>, <code>,
845 <literal>, and <lisp> tags.
847 *** Links to temporary files may be visited.
848 A "temporary file" in this case is a buffer that is not associated
849 with any file.  For some dynamic content import scripts with Planner,
850 this is helpful.
852 *** Typing "#title" should never crash Emacs anymore.
854 ** Muse manual (muse.texi)
856 *** Fix problem with producing a PDF version of the manual.
858 *** Document WikiNames.
860 *** Bring up-to-date with latest features.
862 *** Massively update Common Elements section.
864 *** New Directives section.
865 This describes the use of #title and #author, as well as other
866 directives that may be used.
868 *** New Comments section.
869 Describes the use of "; comment text".
871 ** Publishing (lisp/muse-publish.el)
873 *** The order of rules should be much improved.
874 This means that emphasis characters like `*' and `_' will never be
875 interpreted as such if they are within links.
877 *** The user will be notified when `muse-publish-this-file' fails to
878 publish the current file.  This happens when the timestamp of the
879 current file indicates that it is up-to-date.
881 *** Special characters are escaped in link descriptions and links on a
882 more consistent basis.  What defines a "special character" varies
883 according to the publishing style.
885 *** Errors that occur during publish time will cause a warning to be
886 displayed prominently, rather than being ignored.  It should no longer
887 be possible to mess up a Muse source file by tweaking the Muse
888 publishing process.
890 *** Errors in <lisp> tags cause a warning to be displayed and
891 return "<!--INVALID LISP CODE-->".  Muse will try to continue
892 publishing the page.
894 *** An emdash ("--") can now be used after a list, as long as there is
895 a blank line between the end of the list and the emdash.
897 *** The <code> tag has been introduced.
898 It does the same thing that =equal signs= do: escape specials and
899 publish as teletype text.  Use it for short command snippets and the
900 like.  <example> is a better choice for large blocks of code, since it
901 preserves whitespace.
903 *** An edge case involving links at the beginning of a paragraph
904 has been addressed.
906 *** An edge case involving consecutive directives of the same size
907 has been addressed.
909 *** Every publishing style is now capable of specifying strings to use
910 for sections beyond the third level.
912 *** Every publishing style may specify an end-of-section string.
913 This is used, for example, by the experimental XML style and the
914 DocBook style.
916 *** Every publishing style may specify a method of handling "internal
917 link" markup.  An internal link is a link that refers to an anchor on
918 the current page.
920 *** Every publishing style may specify a link suffix to use.
921 This allows the file extensions in links to other Muse files to be
922 different from their actual extension.  Blosxom makes use of this
923 (since its published files are .txt and the dynamically-generated
924 output is .html), and it could come in handy for PHP stuff.
926 If a link suffix is not specified via :link-suffix, the value of
927 :suffix will be used.
929 ** Blosxom publishing (lisp/muse-blosxom.el)
931 *** muse-blosxom-new-entry: A #category directive is added by default.
932 Nothing is done with this yet, but it could be handy for tag-based
933 (multiple category) blogging, once we figure out a good way to do that
934 in both Muse and Pyblosxom.  Ideas are welcome, and patches even more
937 ** DocBook publishing (lisp/muse-docbook.el)
939 *** The markup has been comprehensively improved.
940 Published documents will now pass validation tests and look better in
941 general.
943 *** It is now possible to specify the encoding of DocBook documents.
944 The default encoding is utf-8.
946 *** Footnotes will be embedded into paragraphs, since this is
947 The DocBook Way.
949 *** Tables will be sorted by section.
950 Headers first, then footers, then the rest of the table.
952 *** Anchors are now handled correctly and publish to the best available
953 form.  Links to anchors are published with the <link> tag.
955 ** HTML publishing (lisp/muse-html.el)
957 *** Fix minor issue with anchors.
959 *** Paragraph publishing will no longer insert <div> tags before images.
960 This was causing too much hassle for some programs that were trying to
961 extend Muse, like the Muse port of Planner.
963 *** The `&', `<', and '>' characters will be escaped using their specific
964 HTML escape codes, rather than with "&#NNN;".  This makes the
965 published output display correctly in more web browsers.
967 *** Use HTML 4.0 Transitional by default for `muse-html-header'.
969 *** Include empty alt element in markup string for images that lack a
970 description.
972 *** Tables will be sorted by section.
973 Headers first, then footers, then the rest of the table.
975 *** `muse-xhtml-extension' -- The default extension for XHTML publishing.
976 This is a new option.
978 ** Journal publishing (lisp/muse-journal.el)
980 *** Use "div class=..." rather than "div id=..." for sections.
982 ** LaTeX publishing (lisp/muse-latex.el)
984 *** A newline will be appended to the default footer for the latex and
985 latexpdf publishing styles.  This keeps the PDF-building process from
986 failing due to lack of a newline at end of file.
988 *** Anchors and links to them now work properly.
990 *** When generating PDF files, call pdflatex twice.
991 This should ensure that the table of contents gets generated, if one
992 is due to be published.
994 *** PDF files with spaces may be published.
995 A bug preventing this has been fixed.
997 *** Teletype text is now published using \\texttt{...}.
999 *** An attempt has been made to escape special characters more
1000 consistently.
1002 ** Texinfo publishing (lisp/muse-texinfo.el)
1004 *** Fix a fatal error that occurs when publishing tables.
1006 *** Generate the contents in the header by default rather than the footer.
1007 This is the way that most Texinfo manuals do it.
1009 *** The info-pdf publishing style currently produces the best PDF output
1010 on the maintainer's machine, so it is now used to publish the PDF
1011 version of the Muse Manual.
1013 *** The characters `{' and `}' will be treated as special characters that
1014 need to be escaped at publish-time.
1016 *** Improve dots and enddots markup strings.
1018 *** Surround underlined text with "_" since Texinfo doesn't seem to have
1019 any better options for producing underlined text.
1021 *** Anchors and links to them now work properly.