muse-latex: Use simpler comment syntax
[muse-el.git] / NEWS
blob0f4f1c9483e53511ea6d48c7d1dcb81be5d22fe7
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 *** Use better style for subsections.
105 *** Make sure the PDF file for the manual is properly generated.
107 *** Implicit Links
109 **** Mention how to customize the WikiName recognition.
111 *** Extending Muse
113 **** Move "Common Elements" and "Deriving Styles" chapters here.
115 ** Muse Mode (lisp/muse-mode.el)
117 *** `C-c TAB' now inserts an object, prompting the user for which type.
118 `C-c TAB l' inserts a relative link.
119 `C-c TAB t' inserts a Muse tag.
120 `C-c TAB u' inserts a URL.
122 These keybindings may be modified by editing `muse-insert-map'.  Note
123 that the prompt you get when you hit `C-c TAB' will not change.
125 *** New list-oriented keybindings:
126 `M-RET' inserts a list item.
127 `C->' increases list item indentation.
128 `C-<' decreases list item indentation.
130 *** Slightly improvement speed of flyspell integration
132 *** Implement searching through Muse files.
134 **** `C-c C-s' performs a search through Muse files.
136 **** New option: muse-grep-command.
137 Customize this to specify the command used for searching.  In
138 particular, "glimpse" is handy.  Check the documentation for this
139 command for details.
141 *** Changed keybindings:
142 `C-c C-b' is now `muse-find-backlinks'
143 `C-c C-v' is now `muse-browse-result'
145 *** Remove the C-c C-c keybinding, since it conflicts with other
146 modes like Planner.
148 *** Don't require muse-publish.el, since publishing and viewing Muse
149 files are supposed to be completely separable.
151 *** Speed up searching for next and previous references.
153 *** Make filling definition lists work better.
155 *** Make editing existing links with `C-c C-e' work better.
157 *** Make browsing the resulting page with `C-c C-v' work better.
159 *** Don't throw an error if doing flyspell or following link at
160 beginning of buffer.
162 *** When publishing a file with `C-c C-t', consult muse-project-alist
163 and use its publishing styles to intelligently prompt the user as to
164 the publishing style and output directory.
166 The old behavior of allowing the file to be published anywhere and
167 with any style has been moved to `C-c C-T'.
169 *** Clicking `mouse-2' now does the right thing when
170 mouse-yank-at-point is non-nil.
172 ** Muse Mode highlighting (lisp/muse-colors.el)
174 *** New option: muse-colors-inline-images.
175 This determines whether or not to inline an image.  The default is to
176 enable this behavior.
178 **** `C-c C-i' toggles whether images are inlined.
180 **** New option: muse-colors-inline-image-method.
181 This determines how to find an image that we want to inline.  The
182 default is to look in the current directory.  If set to
183 'muse-colors-use-publishing-directory, it will look in the directory
184 where the current page will be published.
186 *** Make faces conform the namespace better.
187 `muse-link-face' is renamed to `muse-link'.
188 `muse-bad-link-face' is renamed to `muse-bad-link'.
189 `muse-verbatim-face' is renamed to `muse-verbatim'.
191 *** Handle muse-emphasis faces better.
193 *** Make links blue by default, like most other Emacs modes do.
195 *** Source-level change: The regexps in `muse-colors-markup' are now
196 permitted to have non-shy groupings.
198 ** New modules
200 *** lisp/muse-backlink.el -- Provide backlink support for Muse.
202 *** lisp/muse-groff.el --  This introduces the publishing styles
203 "groff" and "groff-pdf".
205 *** lisp/muse-import-docbook.el -- Convert Docbook XML into Muse format.
207 *** lisp/muse-import-xml.el -- Helper file for muse-import-docbook.el.
209 *** lisp/muse-latex2png.el -- Publish embedded LaTeX content to a PNG file.
210 This introduces the <latex> tag.
212 *** lisp/muse-xml-common.el -- Common functionality used by XML-based
213 publishing styles, such as HTML, XML, and DocBook.
215 *** experimental/muse-mathml.el -- This introduces the "mathml"
216 publishing style and the <math> tag.
218 *** experimental/muse-protocol-iw.el: Implements a simpler URL-like
219 interwiki protocol that handles subdirectories.
221 *** experimental/muse-split.el -- Splits published Muse files into several
222 smaller files.
224 ** Project settings (lisp/muse-project.el)
226 *** Introduce the `with-muse-project' macro, which makes it easier
227 to switch to a given Muse project and execute some code.
229 *** Fix an error with `custom-quote'.
231 *** Ignore buffers that have no associated filename.
232 This fixes an annoyance where Muse prompts to save BBDB and ERC
233 buffers before publishing.
235 *** If we cannot find a project to publish, indicate this in an
236 error message.  This fixes an infinite loop.
238 *** Update the file-alist whenever a Muse file is saved.
240 *** Prevent infinite recursion when updating the file alist.
242 *** In addition to Arch and CVS metadata directories, also ignore
243 these for Darcs and SVN.  Also, don't erroneously ignore files with
244 "#" in them.
246 *** Make links to subdirectories work.
247 The idea is to include as much of the path that is needed in order to
248 disambiguate the link.  For example: "web/TestPage".
250 *** New variable: muse-current-output-style.
251 This holds the output style that is currently being used to publish a
252 file.
254 *** Permit non-Muse files in projects to be linked to.
256 *** Handle relative links to other Muse pages.
257 Relative links are prefixed with "./" or "../".
259 *** New option: muse-project-publish-private-files
260 If this is non-nil (the default), files will be published even if they
261 have "o-r" permissions set (that is, if no one except the owner and
262 possibly group are allowed to read them).  To get back the old
263 behavior, set this to nil.
265 ** Publishing (lisp/muse-publish.el)
267 *** Implement escaping of specials throughout the entire document.
268 This makes it much easier to publish documents to multiple kinds of
269 formats, since you no longer have to worry about putting <verbatim>
270 around specials.
272 *** Make escaping of specials context-sensitive.
273 Muse now realizes that URLs, normal document text, <example> regions,
274 and the like have different special characters to escape.
276 *** Distinguish links and footnotes better.
278 *** Simplify markup string for anchors.
280 *** Allow text like "%N%" in markup strings.
281 This makes it much easier to re-use the same text or put strings in
282 a different order.
284 *** Support nested lists.
285 Muse now determines the nested level of a list by its initial
286 whitespace.  Ordered lists, unordered lists, and definition lists can
287 all be nested.  It is even possible to force a line break in a list
288 item by inserting a blank line on the same level between the lines.
289 Blockquotes may also be nested inside of a list.
291 *** Create parent directories when publishing for the first time.
293 *** Allow empty elements in tables.
295 *** Allow initial and trailing whitespace in tables, but strip it
296 out of the published result.
298 *** Handle case where we are trying to publish a file that has not
299 been saved.
301 *** Handle nested emphasis types better.
302 It should now publish exactly the way it looks in Muse Mode.
304 *** Fix XEmacs issue where text at beginning of buffer is read-only.
306 *** Allow publishing styles to specify a function to use for
307 escaping specials in a particular context.  This is especially handy
308 for HTML URLs, since they have a larger subset of special characters
309 than normal characters.
311 See `muse-xml-decide-specials' in muse-xml-common.el for details.
312 This functionality already exists for escaping specials in strings.
314 *** Fix an infinite loop problem.
316 *** Preserve whitespace around emdash.
317 This allows for more flexibility, since some people seem to prefer to
318 have the emdash directly against the surrounding text, while others
319 like it to be spaced.
321 *** If the #disable-tables publishing directive exists on the current
322 Muse page, do not generate a table.
324 *** Don't give an error when trying to define or derive an existing
325 style.  Just replace it.
327 *** Get rid of a warning that occurs when batch publishing.
329 *** Ignore list items that are part of higher-priority constructs
330 like emphasis.
332 *** Don't markup emdash in a link, since otherwise it will be
333 incorrectly escaped.
335 *** Improve the published descriptions for implicit links and explicit
336 links with no provided description.
338 *** Require at least once space after "::" in definition lists, so
339 we avoid an ambiguity with interwiki link syntax.
341 *** For headers and footers, use a better algorithm to detect whether
342 we have been given a filename or the real contents.
344 *** New option: muse-publish-markup-header-footer-tags.
345 This specifies which tags may be used when publishing headers and
346 footers.
348 *** New option: muse-publish-contents-depth.
349 This specifies the maximum depth of headings to include with
350 <contents> tags.
352 *** Allow `muse-publish-markup-buffer' to work even if the buffer
353 is not associated with a file.
355 *** Fix a compilation bug with XEmacs beta.
357 *** Allow the <lisp> tag to take the "markup" attribute.
358 see the Tag Summary section in the manual for details.
360 *** Publish image links with descriptions as captioned images.
361 This has been implemented for all Muse publishing styles.
363 The major change is that image links with descriptions will be
364 centered and the description will be displayed just below the image as
365 a "caption".  Thus, it is meant to only be used as its own paragraph,
366 not surrounded by other text.  Images without descriptions may still
367 have surrounding text.
369 *** Source-level change: Use 'image instead of 'image-link to indicate
370 images without descriptions.  Use 'image-link instead of
371 'url-with-image to indicate URLs that have an image as their
372 description.
374 *** Self-nested tags are now supported.
375 Tags with the same name can now be nested inside one another.  This
376 only applies to the new <quote> tag and the <class> tag currently, but
377 it may be useful for custom tags as well.
379 To activate this, set the 4th element in a `muse-publish-markup-tag'
380 to non-nil.  Note that this involved a change to the structure of
381 `muse-publish-markup-tag', so be sure to change any custom tags
382 appropriately.
384 *** Fix bug with WikiName link descriptions and PDF output.
386 *** New tags, see the Tag Summary section in the manual for details
388 **** <comment> -- Designate entire regions as comments.
390 **** <include> -- Insert the given file at publish time.
392 **** <markup> -- Mark up the text between the initial and ending tags.
394 **** <perl> -- Evaluate perl code.
396 **** <python> -- Evaluate python code.
398 **** <quote> -- Publish the region as a blockquote.
400 **** <ruby> -- Evaluate ruby code.
402 ** Texinfo publishing (lisp/muse-texinfo.el)
404 *** Escape commas in URLs.
406 *** Make it so that links to other info or PDF documents use the proper
407 suffix.
409 ** URL protocols (lisp/muse-protocols.el)
411 *** Add support for DOI's.
412 DOI's (digitial object identifiers) are a standard identifier used in
413 the publishing industry.
415 *** Add support for "dict:" URLs.
416 This is used to look up terms on the Wikipedia website.
418 **** New option: muse-wikipedia-country.
419 This specified the country code to use for Wikipedia.
421 ** Wiki (lisp/muse-wiki.el)
423 *** If the document does not have a valid title string, use the
424 empty string.
426 *** Fix some bugs.
428 *** New option: muse-wiki-wikiword-match-project-files.
429 Whether to extend WikiName functionality to also match
430 existing filenames, regardless of whether they are named in
431 WikiWord format.
433 If non-nil, Muse will color and publish implicit links to any
434 file in your project.  The default is nil.
436 *** Match filenames in the project before the general WikiWord
437 regexp.
439 *** Take the value of `muse-wiki-hide-nop-tag' into account.
441 *** New option: muse-wiki-ignore-implicit-links-to-current-page.
442 Whether to ignore implicit links to the current page.
444 If non-nil, Muse will not recognize implicit links to the current
445 page, both when formatting and publishing.
447 *** For interwiki links, prefer files that have the same file extension
448 as the current file.
450 *** Check the entire explicit link for a project name or complete
451 interwiki link, not just part of it.  This allows page names with
452 invalid WikiName characters to be referred to by using an explicit
453 link.
455 ** XML publishing (lisp/muse-xml.el)
457 *** Update examples/muse.rnc to handle nested list items.
459 *** Fix table generation when some attributes are not given.
461 * Changes in Muse 3.02.8
463 ** Building Muse
465 *** Compile the contents of the contrib directory.
467 *** The debian/ directory has been moved into its own branch.
468 It is now available at mwolson@gnu.org--2006/muse--debian--0.
470 *** Further parametrize the build system, so that it can be easily
471 used by other Emacs Lisp projects.
473 *** Include autoloads file (lisp/muse-autoloads.el) with releases.
475 ** CGI library (contrib/cgi.el)
477 *** Make this not depend on cl.el at runtime.
479 *** Re-add the example calendar application.
481 ** HTTP daemon (contrib/httpd.el)
483 *** Update this to work with newer versions of Emacs.
485 * Changes in Muse 3.02.7
487 ** Muse Mode highlighting (lisp/muse-colors.el)
489 *** Fix bug that caused Muse not to work with recent builds of Emacs 22.
491 * Changes in Muse 3.02.6
493 ** Building Muse
495 *** Autoloads for Muse are now generated in the muse-autoloads.el
496 file at build time.
498 ** HTML publishing (lisp/muse-html.el)
500 *** Don't escape "%" and "+" in URLs.
502 ** Muse Mode (lisp/muse-mode.el)
504 *** <lisp> tags are now evaluated at display time.
505 The actual contents of the buffer will not change, just the displayed
506 text.  To toggle this behavior, set `muse-colors-evaluate-lisp-tags'.
508 ** Publishing (lisp/muse-publish.el)
510 *** When errors happen during publishing, a more explanatory message
511 is displayed.
513 *** It is now possible to specify non-breaking-space with "~~"
514 (two tildes).  This helps prevent proper names from being split up in
515 the output.
517 *** Escape specials in all forms of emphasis.
519 *** Escape "[" and "]" in links that are entered using muse-make-link.
521 *** Errors from invalid lisp code in a <lisp> tag will be published
522 as a comment.  If you have `muse-publish-comments-p' set to nil, the
523 effect is to remove the error message.
525 *** Fix several publishing issues involving comments and numbered lists.
527 ** Wiki (lisp/muse-wiki.el)
529 *** Interwiki links in extended links that have special characters are
530 now handled properly.
532 ** XML publishing (lisp/muse-xml.el)
534 *** The XML publishing style is now considered stable.
535 Its schema is available in `examples/muse.rnc'.
537 * Changes in Muse 3.02.5
539 ** LaTeX publishing (lisp/muse-latex.el)
541 *** Use a better algorithm for determining how many times we need to
542 call pdflatex for publishing.  Anything with a Table of Contents needs
543 2 passes.
545 ** Muse Mode (lisp/muse-mode.el)
547 *** The 3 levels of emphasis now have corresponding muse-emphasis-N faces.
548 This permits the user to customize them, which may be useful if a font
549 does not have italic and/or bold versions.
551 *** Visiting pages with anchors works better.
553 *** Fix fill bug with semicolons in the middle of paragraphs.
555 *** Fix a bug with editing the link at point.
557 *** Fix a display bug with text like =<verbatim><example></verbatim>=.
559 ** Project settings (lisp/muse-project.el)
561 *** Fix an edge case that yielded a stringp: nil error.
563 *** Prevent auto-save files from being recognized as Muse files.
565 ** Wiki (lisp/muse-wiki.el)
567 *** By default, WikiWords can have consecutive capital letters.
569 *** Fix an error that occurs when muse-colors is not loaded.
571 *** It is now possible to specify a suffix for WikiWord links.
572 For example: WikiName''''s.  The WikiName part will be displayed and
573 colored as a link, but the "s" will be left alone.
575 * Changes in Muse 3.02.02
577 ** Configuration
579 *** A bug with customizing `muse-project-alist' has been fixed.
581 *** We use a file extension for Muse files by default.
582 To obtain the old behavior, set `muse-file-extension' to nil and
583 `muse-mode-auto-p' to t.
585 To go along with the new behavior, be sure to rename all of your Muse
586 files to have a ".muse" extension.
588 *** New option: `muse-wiki-ignore-bare-project-names'.
589 This causes Muse to ignore bare project names if specified.  The
590 default is to turn bare project names into links.
592 *** New option: `muse-publish-comments-p'.
593 This causes Muse to publish comments as markup.  The default is to
594 remove comments before publishing rather than trying to mark them up.
596 *** New option: `muse-wiki-allow-nonexistent-wikiword'.
597 Enabling this will cause WikiWords with no corresponding file to be
598 colored as bad links.  The default is not to color them and turn them
599 into links.
601 ** Muse Mode (lisp/muse-mode.el)
603 *** An error with intangible links has been fixed.
605 *** Visiting a page with an anchor works better than before.
607 *** Flyspell behaves better with Emacs21 than before.
609 *** Links to nonexistent files will be colored red by default.
610 This happened previously, but the algorithm was buggy and didn't cover
611 implicit links.
613 ** Project handling (lisp/muse-project.el)
615 *** A convenience macro called `with-muse-project' has been added.
616 This allows a code block to be executed after changing the current
617 Muse project.  It is analogous to emacs-wiki's
618 `with-emacs-wiki-project' function.
620 ** Publishing (lisp/muse-publish.el)
622 *** An issue involving anchors at the end of a line has been
623 addressed.
625 *** Non-word characters are now allowed before an anchor.
627 *** Comments may now be published, if desired.
628 This behavior may be controlled with the `muse-publish-comments-p'
629 option.  The default is to remove comments before publishing rather
630 than trying to mark them up.
632 *** Publishing directives may now include a dash character.
634 ** LaTeX publishing (lisp/muse-latex.el)
636 *** A bug with footnotes has been addressed.
637 An attempt has been made to make generated footnote markup look more
638 "natural" to experienced LaTeX users.
640 *** Table headers are underlined and table footers are overlined.
642 *** PDF publishing will cause pdflatex to be called as needed.
643 The previous behavior was to always call pdflatex twice.  Currently,
644 if pdflatex succeeds, it will not be called again.  Otherwise, call it
645 up to three times.
647 *** Escaping of special characters should be drastically improved.
648 An attempt has been made to get escaping done right in most contexts.
649 The only quirk is that you must surround dollar signs with equal signs
650 to ensure escaping.  This makes publishing PDF documents much more
651 useful.
653 ** Texinfo publishing (lisp/muse-texinfo.el.el)
655 *** An attempt was made to hone some of the markup.
657 * Changes in Muse 3.02.01
659 ** Muse Mode (lisp/muse-mode.el)
661 *** Links should no longer prevent moving the point, and help text for
662 links should no longer cause errors to occur.
664 ** Project handling (lisp/muse-project.el)
666 *** `muse-project-alist' -- This variable should now save customizations
667 to the correct form in the .emacs file.  Before, it was saving an
668 intermediate form of the variable.
670 If you have used the customize interface in the previous release of
671 Muse to set `muse-project-alist', please do the following to import
672 your settings.
674  - Open your .emacs file.
675  - Move the point to where `muse-project-alist' is set.
676  - Type `M-: (setq muse-project-alist-using-customize t) RET'.
677  - Type `C-M-x'.
678  - Type `M-x customize-save-variable RET muse-project-alist RET'.
680 *** `muse-project-alist' -- A bug involving the deleting of items
681 using Emacs21 and XEmacs21 has been fixed.
683 ** Publishing (lisp/muse-publish.el)
685 *** If 2 or more blank lines separate list or table items, each item
686 will be published in a separate list or table.
688 *** The #date directive is now populated by default with the last
689 modified time of each file, rather than the current time of day.  To
690 use this value, add '<lisp>(muse-publishing-directive "date")<lisp>'
691 to your header or footer.
693 ** HTML publishing (lisp/muse-html.el)
695 *** `muse-xhtml-style-sheet' -- New option that indicates the style
696 settings to use for XHTML documents.  This may be either a filename or
697 a string of stylesheet settings.
699 * Changes in Muse 3.02
701 ** New modules
703 *** lisp/muse-wiki.el --- Provide automatic linking for WikiWords and
704 InterWiki links.  These words are clickable and publish as links.
705 Project names from `muse-project-alist' are available for InterWiki
706 linking by default.  The list of InterWiki names and handlers may be
707 customized through `muse-wiki-interwiki-alist'.
709 WikiWords that do not correspond with real files will not be displayed
710 as links nor published as links.  It is expected that this behavior
711 will be made optional in future versions of Muse.
713 **** This module includes a few helper functions that may be added to
714 `muse-publish-desc-transforms' in order to modify link descriptions at
715 publish time.
717 **** The concept of "implicit links" and "explicit links" has been
718 introduced.  Explicit links are surrounded by brackets, i.e.
719 [[http://blah.org][this is a explicit link]].  Implicit links are URLs
720 and email addresses that are not surrounded by brackets: they will not
721 be colorized or published if surrounded by double-quotes.
723 ***** `muse-wiki-publish-pretty-title' causes words to be Title-cased,
724 ignoring words like `the' and `at' which should not be changed.
726 ***** `muse-wiki-publish-pretty-interwiki' changes the delimiter of
727 interwiki links according to the text of the
728 `muse-wiki-interwiki-replacement' option.
730 *** lisp/muse-protocols.el --- URL protocols that Muse recognizes.
731 This automatically-included module provides an easily customizable
732 list of URL protocols, how to browse them, and how to resolve them for
733 publishing.  Customize `muse-url-protocols' to add and remove
734 protocols.
736 ** Compatibility fixes
738 *** Muse has been tested with XEmacs 21.4, both Mule and non-Mule versions.
739 There are no known problems remaining.  To make things work by
740 default, the iso-8859-1 charset is used as a default option in some
741 places.
743 ** Configuration
745 *** `muse-file-extension' -- New option that allows the file extension
746 for Muse files to be specified.  For example, setting this to "muse"
747 assumes that you have renamed your Muse files with a ".muse"
748 extension.  Using this (and setting `muse-mode-auto-p' to nil) will
749 prevent miscellaneous non-Muse files from being accidentally opened in
750 Muse Mode.
752 *** `muse-ignored-extensions' -- New option that determines which file
753 extensions to omit from the ending of a Muse page name.
755 *** `muse-ignored-extensions-regexp' -- This is no longer customizable.
756 It will be automatically generated from `muse-file-extension' and
757 `muse-ignored-extensions'.
759 *** `muse-project-alist' -- The customize interface for this option has
760 been greatly improved, and much effort has been spent in order to make
761 this user-friendly.
763 *** The `:force-publish' tag may be specified in `muse-project-alist'.
764 This causes a particular list of files to be re-created every time the
765 publishing process is invoked, even if they haven't been changed
766 according to their timestamps.  One use for this is to keep an index
767 of available pages by adding the following to a file in this list.
769 <lisp>(muse-index-as-string t t t)</lisp>
771 *** `muse-project-ignore-regexp' -- By default, version control directories
772 are now included in this regexp so that they don't appear when you hit
773 C-c C-f to browse files in a project.
775 *** The `muse-project-alist-styles' and `muse-project-alist-dirs' functions
776 may be used in `muse-project-alist' to recursively add styles and
777 directory listings for a given directory.  The following is an
778 example.  We use a backtick instead of a single quote to begin the
779 list.
781 (setq muse-project-alist
782       `(("Blog"
783          (,@(muse-project-alist-dirs "~/proj/wiki/blog")  ;; base dir
784           :default "guestbook")
786          ,@(muse-project-alist-styles "~/proj/wiki/blog"  ;; base dir
787                                       ;; output dir
788                                       "~/personal-site/site/blog"
789                                       ;; style
790                                       "my-blosxom"))))
792 Note that if you use the customize interface for `muse-project-alist',
793 you will still have to manually add information for any new
794 sub-directories.
796 ** Debian packaging
798 *** Debian packages for Muse have entered Debian unstable, thanks
799 to Romain Francoise, my sponsor.
801 It is possible to roll your own Muse packages if you want to do so.
802 Packages may be built by using `make debrelease', once the proper
803 options in Makefile.defs are set.  Revisions may be built using `make
804 debrevision'.
806 The manual and relevant documentation files have been included with
807 the Debian package for Muse.
809 ** Muse Mode (lisp/muse-mode.el)
811 *** Allow use of Muse with outline-minor-mode.
813 *** Filling text does the right thing with list items and footnotes.
814 List items and footnotes will no longer be concatenated when hitting
815 M-q in the midst of consecutive items.
817 *** Links will never be split in the middle when using Fill.
819 *** Some flyspell crash issues were addressed.
820 Using intangible text can cause strange problems with flyspell mode.
821 Hence, by default, the intangible property will be ignored.  A new
822 option called `muse-mode-intangible-links' indicates whether this
823 should be the case.
825 *** Links will no longer be highlighted by flyspell.
826 If you're using XEmacs or Emacs 22, flyspell will ignore links,
827 including link text.  This keeps flyspell from making the links
828 unclickable.  If you're using Emacs 21, flyspell will continue to
829 interfere with links.  If you know how to fix this, please send a
830 patch!
832 *** A few edge cases for emphasis and underlining have been addressed.
834 *** <example>, <verbatim>, and =surrounded text= are now colored using
835 the new face `muse-verbatim-face'.
837 *** All marked up text properties, like emphasis and underlining,
838 will be removed for the text between <example>, <verbatim>, <code>,
839 <literal>, and <lisp> tags.
841 *** Links to temporary files may be visited.
842 A "temporary file" in this case is a buffer that is not associated
843 with any file.  For some dynamic content import scripts with Planner,
844 this is helpful.
846 *** Typing "#title" should never crash Emacs anymore.
848 ** Muse manual (muse.texi)
850 *** Fix problem with producing a PDF version of the manual.
852 *** Document WikiNames.
854 *** Bring up-to-date with latest features.
856 *** Massively update Common Elements section.
858 *** New Directives section.
859 This describes the use of #title and #author, as well as other
860 directives that may be used.
862 *** New Comments section.
863 Describes the use of "; comment text".
865 ** Publishing (lisp/muse-publish.el)
867 *** The order of rules should be much improved.
868 This means that emphasis characters like `*' and `_' will never be
869 interpreted as such if they are within links.
871 *** The user will be notified when `muse-publish-this-file' fails to
872 publish the current file.  This happens when the timestamp of the
873 current file indicates that it is up-to-date.
875 *** Special characters are escaped in link descriptions and links on a
876 more consistent basis.  What defines a "special character" varies
877 according to the publishing style.
879 *** Errors that occur during publish time will cause a warning to be
880 displayed prominently, rather than being ignored.  It should no longer
881 be possible to mess up a Muse source file by tweaking the Muse
882 publishing process.
884 *** Errors in <lisp> tags cause a warning to be displayed and
885 return "<!--INVALID LISP CODE-->".  Muse will try to continue
886 publishing the page.
888 *** An emdash ("--") can now be used after a list, as long as there is
889 a blank line between the end of the list and the emdash.
891 *** The <code> tag has been introduced.
892 It does the same thing that =equal signs= do: escape specials and
893 publish as teletype text.  Use it for short command snippets and the
894 like.  <example> is a better choice for large blocks of code, since it
895 preserves whitespace.
897 *** An edge case involving links at the beginning of a paragraph
898 has been addressed.
900 *** An edge case involving consecutive directives of the same size
901 has been addressed.
903 *** Every publishing style is now capable of specifying strings to use
904 for sections beyond the third level.
906 *** Every publishing style may specify an end-of-section string.
907 This is used, for example, by the experimental XML style and the
908 DocBook style.
910 *** Every publishing style may specify a method of handling "internal
911 link" markup.  An internal link is a link that refers to an anchor on
912 the current page.
914 *** Every publishing style may specify a link suffix to use.
915 This allows the file extensions in links to other Muse files to be
916 different from their actual extension.  Blosxom makes use of this
917 (since its published files are .txt and the dynamically-generated
918 output is .html), and it could come in handy for PHP stuff.
920 If a link suffix is not specified via :link-suffix, the value of
921 :suffix will be used.
923 ** Blosxom publishing (lisp/muse-blosxom.el)
925 *** muse-blosxom-new-entry: A #category directive is added by default.
926 Nothing is done with this yet, but it could be handy for tag-based
927 (multiple category) blogging, once we figure out a good way to do that
928 in both Muse and Pyblosxom.  Ideas are welcome, and patches even more
931 ** DocBook publishing (lisp/muse-docbook.el)
933 *** The markup has been comprehensively improved.
934 Published documents will now pass validation tests and look better in
935 general.
937 *** It is now possible to specify the encoding of DocBook documents.
938 The default encoding is utf-8.
940 *** Footnotes will be embedded into paragraphs, since this is
941 The DocBook Way.
943 *** Tables will be sorted by section.
944 Headers first, then footers, then the rest of the table.
946 *** Anchors are now handled correctly and publish to the best available
947 form.  Links to anchors are published with the <link> tag.
949 ** HTML publishing (lisp/muse-html.el)
951 *** Fix minor issue with anchors.
953 *** Paragraph publishing will no longer insert <div> tags before images.
954 This was causing too much hassle for some programs that were trying to
955 extend Muse, like the Muse port of Planner.
957 *** The `&', `<', and '>' characters will be escaped using their specific
958 HTML escape codes, rather than with "&#NNN;".  This makes the
959 published output display correctly in more web browsers.
961 *** Use HTML 4.0 Transitional by default for `muse-html-header'.
963 *** Include empty alt element in markup string for images that lack a
964 description.
966 *** Tables will be sorted by section.
967 Headers first, then footers, then the rest of the table.
969 *** `muse-xhtml-extension' -- The default extension for XHTML publishing.
970 This is a new option.
972 ** Journal publishing (lisp/muse-journal.el)
974 *** Use "div class=..." rather than "div id=..." for sections.
976 ** LaTeX publishing (lisp/muse-latex.el)
978 *** A newline will be appended to the default footer for the latex and
979 latexpdf publishing styles.  This keeps the PDF-building process from
980 failing due to lack of a newline at end of file.
982 *** Anchors and links to them now work properly.
984 *** When generating PDF files, call pdflatex twice.
985 This should ensure that the table of contents gets generated, if one
986 is due to be published.
988 *** PDF files with spaces may be published.
989 A bug preventing this has been fixed.
991 *** Teletype text is now published using \\texttt{...}.
993 *** An attempt has been made to escape special characters more
994 consistently.
996 ** Texinfo publishing (lisp/muse-texinfo.el)
998 *** Fix a fatal error that occurs when publishing tables.
1000 *** Generate the contents in the header by default rather than the footer.
1001 This is the way that most Texinfo manuals do it.
1003 *** The info-pdf publishing style currently produces the best PDF output
1004 on the maintainer's machine, so it is now used to publish the PDF
1005 version of the Muse Manual.
1007 *** The characters `{' and `}' will be treated as special characters that
1008 need to be escaped at publish-time.
1010 *** Improve dots and enddots markup strings.
1012 *** Surround underlined text with "_" since Texinfo doesn't seem to have
1013 any better options for producing underlined text.
1015 *** Anchors and links to them now work properly.