1 \input texinfo @c -*-texinfo-*-
9 * Muse: (muse). Authoring and publishing environment for Emacs.
15 This manual is for the Emacs Muse version 3.02.6.
17 Copyright (C) 2004, 2005, 2006 Free Software Foundation, Inc.
20 Permission is granted to copy, distribute and/or modify this document
21 under the terms of the GNU General Public License.
27 @subtitle an authoring and publishing environment
28 @subtitle for GNU Emacs and XEmacs
30 @c The following two commands
31 @c start the copyright page.
33 @vskip 0pt plus 1filll
37 @c So the toc is printed at the start
41 @node Top, Preface, (dir), (dir)
42 @comment node-name, next, previous, up
49 * Preface:: About the documentation.
50 * Introduction:: What is Muse?
51 * Obtaining Muse:: How to get Muse releases and development
53 * Installation:: Compiling and installing Muse.
54 * Getting Started:: Settings for Muse.
55 * Projects:: Creating and managing Muse projects.
56 * Keystroke Summary:: Keys used in Muse mode.
57 * Markup Rules:: Rules for using markup.
58 * Publishing Styles:: Publishing various types of documents.
59 * Getting Help and Reporting Bugs::
60 * History:: History of this document.
61 * Contributors:: Contributors to this documentation.
62 * GNU General Public License:: The license for this manual and Muse.
63 * Concept Index:: Search for terms.
66 --- The Detailed Node Listing ---
68 How to Get Muse Releases and Development Changes
70 * Releases:: Released versions of Muse.
71 * Development:: Latest unreleased development changes.
73 Rules for Using Markup
75 * Paragraphs:: Paragraphs: centering and quoting.
76 * Headings:: Levels of headings.
77 * Directives:: Directives at the beginning of a
79 * Emphasizing Text:: Bold, italicized, and underlined text.
80 * Footnotes:: Making notes to be shown at the end.
81 * Verse:: Indicating poetic stanzas.
82 * Lists:: Lists of items.
83 * Tables:: Generation of data tables.
84 * Explicit Links:: Hyperlinks and email addresses with
86 * Implicit Links:: Bare URLs, WikiNames, and InterWiki
88 * Images:: Publishing and displaying images.
89 * Horizontal Rules and Anchors:: Inserting a horizontal line or anchor.
90 * Embedded Lisp:: Evaluating Emacs Lisp code in documents
92 * Comments:: Lines to omit from published output.
94 Publishing Various Types of Documents
96 * Blosxom:: Integrating Muse and pyblosxom.cgi.
97 * Book:: Publishing entries into a compilation.
98 * DocBook:: Publishing in DocBook XML form.
99 * HTML:: Publishing in HTML or XHTML form.
100 * Journal:: Keeping a journal or blog.
101 * LaTeX:: Publishing LaTeX documents.
102 * Poem:: Publish a poem to LaTex or PDF.
103 * Texinfo:: Publish entries to Texinfo format or PDF.
104 * Common Elements:: Common functionality shared by styles.
105 * Deriving Styles:: Deriving a new style from an existing
108 Integrating Muse and pyblosxom.cgi
110 * Blosxom Requirements:: Other tools needed to the Blosxom style.
111 * Blosxom Entries:: Format of a Blosxom entry and automation.
112 * Blosxom Options:: Blosxom styles and options provided.
114 Common functionality shared by styles
116 * Markup Functions:: Specifying functions to marking up text.
117 * Markup Regexps:: Markup rules for publishing.
118 * Markup Strings:: Strings specific to a publishing style.
119 * Markup Tags:: Tag specifications for special markup.
120 * Style Elements:: Parameters used for defining styles.
125 @node Preface, Introduction, Top, Top
126 @comment node-name, next, previous, up
127 @chapter About the documentation
129 This document describes Muse, which was written by John Wiegley
130 and is now maintained by Michael Olson. Several versions of it are
134 @item PDF: http://www.mwolson.org/static/doc/muse.pdf
135 @item HTML (single file): http://www.mwolson.org/static/doc/muse.html
136 @item HTML (multiple files): http://www.mwolson.org/static/doc/muse/
139 @node Introduction, Obtaining Muse, Preface, Top
140 @comment node-name, next, previous, up
141 @chapter What is Muse?
143 Emacs Muse is an authoring and publishing environment for Emacs. It
144 simplifies the process of writing documents and publishing them to
145 various output formats.
147 Muse consists of two main parts: an enhanced text-mode for authoring
148 documents and navigating within Muse projects, and a set of publishing
149 styles for generating different kinds of output.
151 This idea is not in any way new. Numerous systems exist -- even one
152 other for Emacs itself (Bhl Mode). What Muse adds to the picture is a
153 more modular environment, with a rather simple core, in which "styles"
154 are derived from to create new styles. Much of Muse's overall
155 functionality is optional. For example, you can use the publisher
156 without the major-mode, or the mode without doing any publishing; or if
157 you don't load the Texinfo or LaTeX modules, those styles won't be
160 The Muse codebase is a departure from emacs-wiki.el version 2.44. The
161 code has been restructured and rewritten, especially its publishing
162 functions. The focus in this revision is on the authoring and publishing
163 aspects, and the "wikiness" has been removed as a default behavior
164 (available in the optional @file{muse-wiki} module). CamelCase words are
165 no longer special by default.
167 @node Obtaining Muse, Installation, Introduction, Top
168 @comment node-name, next, previous, up
169 @chapter How to Get Muse Releases and Development Changes
172 * Releases:: Released versions of Muse.
173 * Development:: Latest unreleased development changes.
176 @node Releases, Development, Obtaining Muse, Obtaining Muse
177 @comment node-name, next, previous, up
178 @section Released versions of Muse
180 Choose to install a release if you want to minimize risk.
182 Errors are corrected in development first. User-visible changes will be
183 announced on the @email{emacs-wiki-discuss@@nongnu.org} mailing list.
184 This mailing list also provides support for @command{Planner} and
185 @command{emacs-wiki}, which is the predecessor of Muse.
186 @pxref{Getting Help and Reporting Bugs}.
188 @cindex releases, Debian package
189 @cindex Debian package for Muse
190 Debian users can get Muse via apt-get. The @file{muse-el} package is
191 available both at Michael Olson's Debian repository and the official
192 Debian repository. To make use of the former, add the following line to
193 your @file{/etc/apt/sources.list} file and run @code{apt-get install
197 deb http://www.mwolson.org/debian/ ./
200 @cindex releases, from source
201 Alternatively, you can download the latest release from
202 @uref{http://www.mwolson.org/static/dist/muse/} .
204 @node Development, , Releases, Obtaining Muse
205 @comment node-name, next, previous, up
206 @section Latest unreleased development changes
209 Choose the development version if you want to live on the bleeding edge
210 of Muse development or try out new features before release.
212 @cindex arch revision control system, using
213 The Arch revision control system allows you to retrieve previous
214 versions and select specific features and bug fixes. If you would like
215 to contribute to Muse development, it is highly recommended that you use
216 Arch, but this is not a requirement.
218 If you are new to Arch, you might find this tutorial helpful:
219 @uref{http://www.mwolson.org/projects/ArchTutorial.html}.
221 Downloading the Muse module with Arch and staying up-to-date involves
228 @item Debian: @kbd{apt-get install tla}.
229 @item Other distributions: see @uref{http://regexps.srparish.net/www/}.
232 @item Register the archive.
234 tla register-archive -f http://www.mwolson.org/archives/2005
237 @item Download the Muse package.
239 # Download Muse into the @file{muse} directory.
240 tla get mwolson@@gnu.org--2005/muse--main--1.0 muse
243 @item List upstream changes that are missing from your local copy.
244 Do this whenever you want to see whether new changes have been committed
248 # Change to the source directory you are interested in.
251 # Display the summary of changes
252 tla missing --summary
255 @cindex updating Muse with Arch
256 @item Update to the latest version by replaying missing changes.
264 There are other ways to interact with the Muse archive.
267 @item Browse arch repository: @uref{http://www.mwolson.org/archives/}
268 @item Latest development snapshot: @uref{http://www.mwolson.org/static/dist/muse-latest.tar.gz}
271 The latest development snapshot will be kept up-to-date since it is
272 updated at the same time as the Arch repository.
274 @node Installation, Getting Started, Obtaining Muse, Top
275 @comment node-name, next, previous, up
276 @chapter Compiling and Installing Muse
278 Muse may be compiled and installed on your machine.
280 @subsubheading Compilation
282 This is an optional step, since Emacs Lisp source code does not
283 necessarily have to be byte-compiled. It will yield a speed increase,
286 A working copy of Emacs or XEmacs is needed in order to compile the
287 Emacs Muse. By default, the program that is installed with the name
288 @command{emacs} will be used.
290 If you want to use the @command{xemacs} binary to perform the
291 compilation, you would need to edit @file{Makefile.defs} in the
292 top-level directory as follows. You can put either a full path to an
293 Emacs or XEmacs binary or just the command name, as long as it is in the
298 SITEFLAG = -no-site-file
301 Running @code{make} should compile the Muse source files in the
302 @file{lisp} directory.
304 @subsubheading Installation
306 Muse may be installed into your file hierarchy by doing the following.
308 Edit the @file{Makefile.defs} file so that @env{ELISPDIR} points to
309 where you want the source and compiled Muse files to be installed and
310 @env{INFODIR} indicates where to put the Muse manual. Of course, you
311 will want to edit @env{EMACS} and @env{SITEFLAG} as shown in the
312 Compilation section if you are using XEmacs.
314 If you are installing Muse on a Debian system, you might want to change
315 the value of @env{INSTALLINFO} as specified in @file{Makefile.defs}.
317 If you wish to install Muse to different locations than the defaults
318 specify, edit @file{Makefile.defs} accordingly.
320 Run @code{make} as a normal user.
322 Run @code{make install} as the root user if you have chosen installation
323 locations that require this.
326 @node Getting Started, Projects, Installation, Top
327 @comment node-name, next, previous, up
328 @chapter Getting Started
331 To use Muse, add the directory containing its files to your
332 @code{load-path} variable, in your @file{.emacs} file. Then, load in
333 the authoring mode, and the styles you wish to publish to. An example
337 (add-to-list 'load-path "<path to Muse>")
339 (require 'muse-mode) ; load authoring mode
341 (require 'muse-html) ; load publishing styles I use
342 (require 'muse-latex)
343 (require 'muse-texinfo)
344 (require 'muse-docbook)
347 Once loaded, the command @kbd{M-x muse-publish-this-file} will publish
348 an input document to any available style. If you enable
349 @file{muse-mode} within a buffer, by typing @kbd{M-x muse-mode}, this
350 command will be bound to @kbd{C-c C-t}.
352 If the currently opened file is part of a defined project in
353 @code{muse-project-alist}, it may be published using @kbd{C-c C-p}.
355 You should also type @kbd{M-x customize-group}, and give the name
356 @samp{muse}. Each of the options has its own documentation.
359 @node Projects, Keystroke Summary, Getting Started, Top
360 @comment node-name, next, previous, up
361 @chapter Creating and Managing Muse Projects
364 Often you will want to publish all the files within a directory to a
365 particular set of output styles automatically. To support, Muse
366 allows for the creations of "projects". Here is a sample project, to
367 be defined in your @file{.emacs} file.
370 (require 'muse-project)
372 (setq muse-project-alist
373 '(("website" ; my various writings
374 ("~/Pages" :default "index")
375 (:base "html" :path "~/public_html")
376 (:base "pdf" :path "~/public_html/pdf"))))
379 The above defines a project named "website", whose files are located
380 in the directory @file{~/Pages}. The default page to visit is
381 @file{index}. When this project is published, each page will be
382 output as HTML to the directory @file{~/public_html}, and as PDF to
383 the directory @file{~/public_html/pdf}. Within any project page, you
384 may create a link to other pages using the syntax @samp{[[pagename]]}.
386 By default, Muse expects all project files to have the file extension
387 @file{.muse}. Files without this extension will not be associated with
388 Muse mode and will not be considered part of any project, even if they
389 are within a project directory.
391 If you don't want to use @file{.muse}, you can customize the extension
392 by setting the value of @code{muse-file-extension}.
394 If you don't want to use any extension at all, and want Muse to
395 autodetect project files based on their location, then use:
398 (setq muse-file-extension nil
402 If you set these options directly in your @file{.emacs} outside of the
403 Customize interface, then you will also need to add:
406 (add-hook 'find-file-hooks 'muse-mode-maybe)
409 @c PRE3_03: Give more examples
410 @c PRE3_03: Describe :set and other options fully
412 @node Keystroke Summary, Markup Rules, Projects, Top
413 @comment node-name, next, previous, up
414 @chapter Keys Used in Muse Mode
417 This is a summary of keystrokes available in every Muse buffer.
421 @item C-c C-a (`muse-index')
422 Display an index of all known Muse pages.
424 @item C-c C-b (`muse-browse-result')
425 Show the published result of this page.
427 @item C-c C-e (`muse-edit-link-at-point')
430 @item C-c C-f (`muse-project-find-file'), also C-c C-v
431 Open another Muse page. Prompt for the name.
433 @item C-c C-l (`font-lock-mode')
434 Highlight/refresh the current buffer.
436 @item C-c C-p (`muse-project-publish')
437 Publish any Muse pages that have changed.
439 @item C-c C-v (`muse-project-find-file'), also C-c C-f
440 Open another Muse page. Prompt for the name.
442 @item C-c = (`muse-what-changed')
443 Diff this page against the last backup version.
445 @item C-c TAB (`muse-insert-tag')
446 Insert a tag interactively.
449 Move to the next Wiki reference.
452 Move to the previous Wiki reference.
457 @node Markup Rules, Publishing Styles, Keystroke Summary, Top
458 @comment node-name, next, previous, up
459 @chapter Rules for Using Markup
462 A Muse document uses special, contextual markup rules to determine how
463 to format the output result. For example, if a paragraph is indented,
464 Muse assumes it should be quoted.
466 There are not too many markup rules, and all of them strive to be as
467 simple as possible so that you can focus on document creation, rather
471 * Paragraphs:: Paragraphs: centering and quoting.
472 * Headings:: Levels of headings.
473 * Directives:: Directives at the beginning of a
475 * Emphasizing Text:: Bold, italicized, and underlined text.
476 * Footnotes:: Making notes to be shown at the end.
477 * Verse:: Indicating poetic stanzas.
478 * Lists:: Lists of items.
479 * Tables:: Generation of data tables.
480 * Explicit Links:: Hyperlinks and email addresses with
482 * Implicit Links:: Bare URLs, WikiNames, and InterWiki
484 * Images:: Publishing and displaying images.
485 * Horizontal Rules and Anchors:: Inserting a horizontal line or anchor.
486 * Embedded Lisp:: Evaluating Emacs Lisp code in documents
488 * Comments:: Lines to omit from published output.
491 @node Paragraphs, Headings, Markup Rules, Markup Rules
492 @comment node-name, next, previous, up
493 @section Paragraphs: centering and quoting
496 Paragraphs in Muse must be separated by a blank line.
498 @cindex paragraphs, centered
499 @strong{Centered paragraphs and quotations}
501 A line that begins with six or more columns of whitespace (either tabs
502 or spaces) indicates a centered paragraph.
504 @cindex paragraphs, quoted
506 But if a line begins with whitespace, though less than six columns, it
507 indicates a quoted paragraph.
510 @cindex monospace, rendering blocks
511 @cindex HTML, rendering blocks in monospace
512 @strong{Literal paragraphs}
514 The @verb{|<example>|} tag is used for examples, where whitespace should
515 be preserved, the text rendered in monospace, and any characters special
516 to the output style escaped.
519 @cindex HTML, inserting a raw block
520 There is also the @verb{|<literal>|} tag, which causes a marked block to
521 be entirely left alone. This can be used for inserting a hand-coded
522 HTML blocks into HTML output, for example.
524 @node Headings, Directives, Paragraphs, Markup Rules
525 @comment node-name, next, previous, up
526 @section Levels of headings
529 A heading becomes a chapter or section in printed output -- depending on
530 the style. To indicate a heading, start a new paragraph with one or
531 more asterices, followed by a space and the heading title. Then begin
532 another paragraph to enter the text for that section.
534 All levels of headings will be published. Most publishing styles only
535 distinguish the between the first 4 levels, however.
547 @node Directives, Emphasizing Text, Headings, Markup Rules
548 @comment node-name, next, previous, up
549 @section Directives at the beginning of a document
552 Directives are lines beginning with the @samp{#} character that come
553 before any paragraphs or sections in the document. Directives are of
554 the form ``#directive content of directive''. You can use any
555 combination of uppercase and lowercase letters for directives, even if
556 the directive is not in the list below.
558 The @code{muse-publishing-directive} function may be used in header and
559 footer text to access directives. For example, to access the
560 @samp{#title} directive, use @code{(muse-publishing-directive "title")}.
562 The following is a list of directives that Muse uses.
567 The author of this document.
569 If this is not specified, Muse will attempt to figure it out from the
570 @code{user-full-name} variable.
574 The date that the document was last modified.
576 This is used by publishing styles that are able to embed the date
581 A short description of this document.
583 This is used by the @code{journal} publishing style to embed information
584 inside of an RSS/RDF feed.
588 The title of this document.
590 If this is not specified, the name of the file is used.
594 @node Emphasizing Text, Footnotes, Directives, Markup Rules
595 @comment node-name, next, previous, up
596 @section Bold, italicized, and underlined text
597 @cindex emphasizing text
598 @cindex underlining text
599 @cindex italicizing text
600 @cindex verbatim text
601 @cindex monospace, rendering words
603 To emphasize text, surround it with certain specially recognized
609 ***very strong emphasis***
611 =verbatim and monospace=
615 While editing a Muse document in Muse mode, these forms of emphasis will
616 be highlighted in a WYSIWYG manner. Each of these forms may span
619 Verbatim text will be colored as gray by default. To change this,
620 customize @code{muse-verbatim-face}.
622 @node Footnotes, Verse, Emphasizing Text, Markup Rules
623 @comment node-name, next, previous, up
624 @section Making notes to be shown at the end
627 A footnote reference is simply a number in square brackets. To define
628 the footnote, place this definition at the bottom of your file.
629 @samp{footnote-mode} can be used to greatly facilitate the creation of
630 these kinds of footnotes.
632 Footnotes are defined by the same number in brackets occurring at the
633 beginning of a line. Use footnote-mode's @kbd{C-c ! a} command, to very
634 easily insert footnotes while typing. Use @kbd{C-x C-x} to return to
635 the point of insertion.
637 @node Verse, Lists, Footnotes, Markup Rules
638 @comment node-name, next, previous, up
639 @section Indicating poetic stanzas
643 Poetry requires that whitespace be preserved, but without resorting to
644 monospace. To indicate this, use the following markup, reminiscent of
648 > A line of Emacs verse;
649 > forgive its being so terse.
652 You can also use the @verb{|<verse>|} tag, if you prefer.
656 A line of Emacs verse;
657 forgive its being so terse.
661 @cindex verses, multiple stanzas
662 Multiple stanzas may be included in one set of @verb{|<verse>|} tags, as
667 A line of Emacs verse;
668 forgive its being so terse.
670 In terms of terse verse,
675 @node Lists, Tables, Verse, Markup Rules
676 @comment node-name, next, previous, up
677 @section Lists of items
680 Lists are given using special characters at the beginning of a line.
681 Whitespace must occur before bullets or numbered items, to distinguish
682 from the possibility of those characters occurring in a real sentence.
684 @cindex lists, bullets
685 These are rendered as a bullet list.
692 @cindex lists, enumerated
693 An enumerated list follows.
700 @cindex lists, definitions
701 Here is a definition list.
705 This is a first definition
706 And it has two lines;
710 This is a second definition
713 @node Tables, Explicit Links, Lists, Markup Rules
714 @comment node-name, next, previous, up
715 @section Generation of data tables
718 @cindex tables, simple
719 Only very simple tables are supported. The syntax is as follows.
722 Double bars || Separate header fields
724 Single bars | Separate body fields
725 Here are more | body fields
727 Triple bars ||| Separate footer fields
730 Some publishing styles require header fields to come first, then footer
731 fields, and then the body fields. You can use any order for these
732 sections that you like, and Muse will re-order them for you at
735 @node Explicit Links, Implicit Links, Tables, Markup Rules
736 @comment node-name, next, previous, up
737 @section Hyperlinks and email addresses with descriptions
738 @cindex links, explicit
740 A hyperlink can reference a URL, or another page within a Muse
741 project. In addition, descriptive text can be specified, which should
742 be displayed rather than the link text in output styles that supports
743 link descriptions. The syntax is as follows.
746 [[link target][link description]]
747 [[link target without description]]
750 Thus, the current maintainer's homepage for Muse can be found
751 @samp{[[http://www.mwolson.org/projects/MuseMode.html][here]]},
752 or at @samp{[[http://www.mwolson.org/projects/MuseMode.html]]}.
754 @node Implicit Links, Images, Explicit Links, Markup Rules
755 @comment node-name, next, previous, up
756 @section Bare URLs, WikiNames, and InterWiki links
757 @cindex links, implicit
760 @cindex Email addresses
762 A URL or email address encountered in the input text is published as a
763 hyperlink. These kind of links are called @dfn{implicit links} because
764 they are not separated from the rest of the Muse document in any way.
767 If the @command{muse-wiki} module is loaded, another form of implicit
768 link will be made available. WikiNames, which are typed in camelcase,
769 will be highlighted and published as links, provided that the file they
772 @cindex InterWiki links
773 @cindex inter-project links
774 The @command{muse-wiki} module also allows for InterWiki links. These
775 are similar to WikiWords, but they specify both the project and page of
776 a file. The names of your project entries in @code{muse-project-alist}
777 will be used as InterWiki names by default. Several examples follow.
780 Blog::DocumentingMuse
785 In the first case, the interwiki delimiter is @samp{::}, @samp{Blog} is
786 the project name, and @samp{DocumentingMuse} is the page name. In the
787 second example, @samp{#} is the interwiki delimiter. If the name of a
788 project occurs by itself in text, like the third case, it will be
789 colorized and published as a link to the default page of the given
792 Customization of interwiki links may be accomplished by editing the
793 @code{muse-wiki-interwiki-alist} option.
795 @node Images, Horizontal Rules and Anchors, Implicit Links, Markup Rules
796 @comment node-name, next, previous, up
797 @section Publishing and displaying images
799 @cindex links, with images
802 Links to images may be used in either the target or the description, or
803 both. Thus, the following code will publish as a clickable image that
804 points to @url{http://www.mwolson.org/}.
807 [[http://www.mwolson.org/][http://www.mwolson.org/static/logos/site-logo.png]]
810 @cindex images, displaying
811 @cindex images, inlined
812 @cindex images, local
813 If a link to a locally-available image is encountered in the link
814 description, Muse mode will attempt to display it if your version of
815 Emacs permits this. The following example will display correctly and
816 publish correctly if a @acronym{PNG} file called @file{TestLogo.png}
817 exists in the @file{../pics/} directory.
820 [[TestPage][../pics/TestLogo.png]]
823 @cindex images, without a description
824 An image link is not required to have a description. The link
825 @samp{[[../myimage.png]]} will display and publish as expected.
827 @node Horizontal Rules and Anchors, Embedded Lisp, Images, Markup Rules
828 @comment node-name, next, previous, up
829 @section Inserting a horizontal line or anchor
831 @cindex horizontal rules
833 @strong{Horizontal Rules}
835 Four or more dashes indicate a horizontal rule. Be sure to put blank
836 lines around it, or it will be considered part of the proceeding or
840 @cindex links, with target on same page
843 If you begin a line with "#anchor" -- where "anchor" can be any word
844 that doesn't contain whitespace -- it defines an anchor at that point
845 into the document. This point can be referenced using "page#anchor" as
846 the target in a Muse link.
848 @node Embedded Lisp, Comments, Horizontal Rules and Anchors, Markup Rules
849 @comment node-name, next, previous, up
850 @section Evaluating Emacs Lisp code in documents for extensibility
851 @cindex lisp, embedded
853 Arbitrary kinds of markup can be achieved using the @verb{|<lisp>|} tag,
854 which is the only Muse tag supported in a style's header and footer
855 text. With the @verb{|<lisp>|} tag, you may generated whatever output
856 text you wish. The inserted output will get marked up, if the
857 @verb{|<lisp>|} tag appears within the main text of the document.
860 <lisp>(concat "This form gets " "inserted")</lisp>
863 @cindex lisp, and insert command
864 Note that you should not use the @code{insert} command within a set of
865 @verb{|<lisp>|} tags, since the return value from the @verb{|<lisp>|}
866 tags will be automatically inserted into the document.
868 @node Comments, , Embedded Lisp, Markup Rules
869 @comment node-name, next, previous, up
870 @section Lines to omit from published output
872 @cindex publishing, omitting lines
874 Use the following syntax to indicate a comment. Comments will not be
878 ; Comment text goes here.
881 That is, only a semi-colon at the beginning of a line, followed by a
882 literal space, will cause that line to be treated as a comment.
884 @node Publishing Styles, Getting Help and Reporting Bugs, Markup Rules, Top
885 @comment node-name, next, previous, up
886 @chapter Publishing Various Types of Documents
887 @cindex publishing styles
889 One of the principle features of Muse is the ability to publish a simple
890 input text to a variety of different output styles. Muse also makes it
891 easy to create new styles, or derive from an existing style.
894 * Blosxom:: Integrating Muse and pyblosxom.cgi.
895 * Book:: Publishing entries into a compilation.
896 * DocBook:: Publishing in DocBook XML form.
897 * HTML:: Publishing in HTML or XHTML form.
898 * Journal:: Keeping a journal or blog.
899 * LaTeX:: Publishing LaTeX documents.
900 * Poem:: Publish a poem to LaTex or PDF.
901 * Texinfo:: Publish entries to Texinfo format or PDF.
902 * Common Elements:: Common functionality shared by styles.
903 * Deriving Styles:: Deriving a new style from an existing
907 @node Blosxom, Book, Publishing Styles, Publishing Styles
908 @comment node-name, next, previous, up
909 @section Integrating Muse and pyblosxom.cgi
910 @cindex blog, one-file-per-entry style
912 The Blosxom publishing style publishes a tree of categorised files to a
913 mirrored tree of stories to be served by blosxom.cgi or pyblosxom.cgi.
914 In other words, each blog entry corresponds with one file.
917 * Blosxom Requirements:: Other tools needed to the Blosxom style.
918 * Blosxom Entries:: Format of a Blosxom entry and automation.
919 * Blosxom Options:: Blosxom styles and options provided.
922 @node Blosxom Requirements, Blosxom Entries, Blosxom, Blosxom
923 @comment node-name, next, previous, up
924 @subsection Other tools needed to the Blosxom style
926 You will need to have @command{pyblosxom.cgi} or @command{blosxom.cgi}
927 installed on a machine that you have upload access to.
929 The following additional components are required in order to make the
930 date of blog entries display as something sensible.
934 A script to gather date directives from the entire blog tree into a
935 single file. The file must associate a blog entry with a date.
938 A plugin for (py)blosxom that reads this file.
941 These 2 things are provided for @command{pyblosxom.cgi} in the
942 @file{contrib/pyblosxom} subdirectory. @file{getstamps.py} provides the
943 former service, while @file{hardcodedates.py} provides the latter
944 service. Eventually it is hoped that a @command{blosxom.cgi} plugin and
945 script will be found/written.
947 Here is a sample listing from my @file{timestamps} file, which maps
948 each file to a date. This can really be in any format, as long as your
949 date-gathering script and your plugin can both understand it.
952 2005-04-01-14-16 personal/paper_cranes
953 2005-03-21 personal/spring_break_over
954 2004-10-24 personal/finished_free_culture
957 @node Blosxom Entries, Blosxom Options, Blosxom Requirements, Blosxom
958 @comment node-name, next, previous, up
959 @subsection Format of a Blosxom entry and automation
961 Each Blosxom file must include `#date yyyy-mm-dd', or optionally the
962 longer `#date yyyy-mm-dd-hh-mm', a title (using the #title directive),
963 plus whatever normal content is desired.
965 The date directive is not used directly by @command{pyblosxom.cgi} or
966 this program. You need to have the two additional items from the former
967 section to make use of this feature.
969 There is a function called @code{muse-blosxom-new-entry} that will
970 automate the process of making a new blog entry. To make use of it, do
975 Customize @code{muse-blosxom-base-directory} to the location that your
976 blog entries are stored.
979 Assign the @code{muse-blosxom-new-entry} function to a key sequence. I
980 use the following code to assign this function to @kbd{C-c p l'}.
983 (global-set-key "\C-cpl" 'muse-blosxom-new-entry)
987 You should create your directory structure ahead of time under your base
988 directory. These directories, which correspond with category names, may
992 When you enter this key sequence, you will be prompted for the category
993 of your entry and its title. Upon entering this information, a new file
994 will be created that corresponds with the title, but in lowercase
995 letters and having special characters converted to underscores. The
996 title and date directives will be inserted automatically.
999 @node Blosxom Options, , Blosxom Entries, Blosxom
1000 @comment node-name, next, previous, up
1001 @subsection Blosxom styles and options provided
1003 The following styles and options are available in the Blosxom publishing
1006 @subsubheading Styles provided
1010 @cindex publishing styles, blosxom-html
1012 Publish Blosxom entries in HTML form.
1014 @cindex publishing styles, blosxom-xhtml
1016 Publish Blosxom entries in XHTML form.
1020 @subsubheading Options provided
1024 @item muse-blosxom-extension
1025 Default file extension for publishing Blosxom files.
1027 @item muse-blosxom-header
1028 Header used for publishing Blosxom files.
1030 This may be text or a filename.
1032 @item muse-blosxom-footer
1033 Footer used for publishing Blosxom files.
1035 This may be text or a filename.
1037 @item muse-blosxom-base-directory
1038 Base directory of blog entries, used by @code{muse-blosxom-new-entry}.
1040 This is the top-level directory where your blog entries may be found
1045 @node Book, DocBook, Blosxom, Publishing Styles
1046 @comment node-name, next, previous, up
1047 @section Publishing entries into a compilation
1049 This publishing style is used to output ``books'' in LaTeX or PDF
1052 Each page will become a separate chapter in the book, unless the style
1053 keyword @option{:nochapters} is used, in which case they are all run
1054 together as if one giant chapter.
1056 You will need to call the @code{muse-book-publish-project} function in
1057 order to publish this style. An example of this may be found in John
1058 Wiegley's configuration file at @file{examples/johnw/muse-johnw.el}.
1060 @subsubheading Styles provided
1064 @cindex publishing styles, book-latex
1066 Publish a book in LaTeX form. The header and footer are different than
1067 the normal LaTeX publishing mode.
1069 @cindex publishing styles, book-pdf
1071 Publish a book in PDF form. The header and footer are different than
1072 the normal PDF publishing mode.
1076 @subsubheading Options provided
1080 @item muse-book-before-publish-hook
1081 A hook run in the book buffer before it is marked up.
1083 @item muse-book-after-publish-hook
1084 A hook run in the book buffer after it is marked up.
1086 @item muse-book-latex-header
1087 Header used for publishing books to LaTeX.
1089 This may be text or a filename.
1091 @item muse-book-latex-footer
1092 Footer used for publishing books to LaTeX.
1094 This may be text or a filename.
1098 @node DocBook, HTML, Book, Publishing Styles
1099 @comment node-name, next, previous, up
1100 @section Publishing in DocBook XML form
1102 This publishing style is used to generate DocBook XML files.
1104 @subsubheading Styles provided
1108 @cindex publishing styles, docbook
1113 @subsubheading Options provided
1117 @item muse-docbook-extension
1118 Default file extension for publishing DocBook XML files.
1120 @item muse-docbook-header
1121 Header used for publishing DocBook XML files.
1123 This may be text or a filename.
1125 @item muse-docbook-footer
1126 Footer used for publishing DocBook XML files.
1128 This may be text or a filename.
1130 @item muse-docbook-markup-regexps
1131 List of markup rules for publishing a Muse page to DocBook XML.
1133 @item muse-docbook-markup-functions
1134 An alist of style types to custom functions for that kind of text.
1136 @item muse-docbook-markup-strings
1137 Strings used for marking up text.
1139 These cover the most basic kinds of markup, the handling of which
1140 differs little between the various styles.
1142 @item muse-docbook-markup-specials
1143 A table of characters which must be represented specially.
1145 @item muse-docbook-encoding-default
1146 The default Emacs buffer encoding to use in published files.
1147 This will be used if no special characters are found.
1149 @item muse-docbook-charset-default
1150 The default DocBook XML charset to use if no translation is
1151 found in @code{muse-docbook-encoding-map}.
1153 @item muse-docbook-encoding-map
1154 An alist mapping emacs coding systems to appropriate DocBook charsets.
1155 Use the base name of the coding system (i.e. without the -unix).
1159 @node HTML, Journal, DocBook, Publishing Styles
1160 @comment node-name, next, previous, up
1161 @section Publishing in HTML or XHTML form
1163 This publishing style is capable of producing HTML or XHTML documents.
1165 @subsubheading Styles provided
1169 @cindex publishing styles, html
1171 Supports publishing to HTML 4.0 and HTML 4.01, Strict or Transitional.
1174 Supports publishing to XHTML 1.0 and XHTML 1.1, Strict or Transitional.
1178 @subsubheading Options provided
1180 If an HTML option does not have a corresponding XHTML option, it will
1181 be used for both of these publishing styles.
1185 @item muse-html-extension
1186 Default file extension for publishing HTML files.
1188 @item muse-xhtml-extension
1189 Default file extension for publishing XHTML files.
1191 @item muse-html-style-sheet
1192 Store your stylesheet definitions here.
1194 This is used in @code{muse-html-header}. You can put raw CSS in here or
1195 a @verb{|<link>|} tag to an external stylesheet. This text may contain
1196 @verb{|<lisp>|} markup tags.
1198 If you are using XHTML, make sure to close the @verb{|<link>|} tag
1201 @item muse-html-header
1202 Header used for publishing HTML files.
1204 This may be text or a filename.
1206 @item muse-html-footer
1207 Footer used for publishing HTML files.
1209 This may be text or a filename.
1211 @item muse-xhtml-header
1212 Header used for publishing XHTML files.
1214 This may be text or a filename.
1216 @item muse-xhtml-footer
1217 Footer used for publishing XHTML files.
1219 This may be text or a filename.
1221 @item muse-html-anchor-on-word
1222 When true, anchors surround the closest word.
1224 This allows you to select them in a browser (i.e. for pasting), but has
1225 the side-effect of marking up headers in multiple colors if your header
1226 style is different from your link style.
1228 @item muse-html-table-attributes
1229 The attribute to be used with HTML @verb{|<table>|} tags.
1231 Note that since Muse supports direct insertion of HTML tags, you can
1232 easily create any kind of table you want, as long as each line begins at
1233 column 0 (to prevent it from being blockquoted).
1235 @item muse-html-markup-regexps
1236 List of markup rules for publishing a Muse page to HTML.
1238 @item muse-html-markup-functions
1239 An alist of style types to custom functions for that kind of text.
1241 @item muse-html-markup-strings
1242 Strings used for marking up text as HTML.
1244 These cover the most basic kinds of markup, the handling of which
1245 differs little between the various styles.
1247 @item muse-xhtml-markup-strings
1248 Strings used for marking up text as XHTML.
1250 These cover the most basic kinds of markup, the handling of which
1251 differs little between the various styles.
1253 @item muse-html-markup-tags
1254 A list of tag specifications, for specially marking up HTML.
1255 @xref{muse-publish-markup-tags}, for more information.
1257 @item muse-html-markup-specials
1258 A table of characters which must be represented specially. By default,
1259 this includes @samp{"}, @samp{<}, @samp{>}, and @samp{&}.
1261 @item muse-html-meta-http-equiv
1262 The http-equiv attribute used for the HTML @verb{|<meta>|} tag.
1264 @item muse-html-meta-content-type
1265 The content type used for the HTML @verb{|<meta>|} tag.
1267 If you are striving for XHTML 1.1 compliance, you may want to change
1268 this to ``application/xhtml+xml''.
1270 @item muse-html-meta-content-encoding
1271 The charset to append to the HTML @verb{|<meta>|} tag.
1273 If set to the symbol 'detect, use @code{muse-html-encoding-map} to try
1274 and determine the HTML charset from emacs's coding. If set to a string,
1275 this string will be used to force a particular charset.
1277 @item muse-html-charset-default
1278 The default HTML meta charset to use if no translation is found in
1279 @code{muse-html-encoding-map}.
1281 @item muse-html-encoding-default
1282 The default Emacs buffer encoding to use in published files.
1283 This will be used if no special characters are found.
1285 @item muse-html-encoding-map
1286 An alist mapping emacs coding systems to appropriate HTML charsets.
1287 Use the base name of the coding system (i.e. without the -unix).
1291 @node Journal, LaTeX, HTML, Publishing Styles
1292 @comment node-name, next, previous, up
1293 @section Keeping a journal or blog
1295 @cindex blog, journal style
1297 The module facilitates the keeping and publication of a journal. When
1298 publishing to HTML, it assumes the form of a web log, or blog.
1300 The input format for each entry is as follows.
1303 * 20040317: Title of entry
1308 "You know who you are. It comes down to a simple gut check: You
1309 either love what you do or you don't. Period." -- P. Bronson
1313 The "qotd", or Quote of the Day, is entirely optional. When generated
1314 to HTML, this entry is rendered as the following.
1318 <div class="entry-qotd">
1319 <h3>Quote of the Day:</h3>
1320 <p>"You know who you are. It comes down to a simple gut
1321 check: You either love what you do or you don't. Period."
1324 <div class="entry-body">
1325 <div class="entry-head">
1326 <div class="entry-date">
1327 <span class="date">March 17, 2004</span>
1329 <div class="entry-title">
1330 <h2>Title of entry</h2>
1333 <div class="entry-text">
1334 <p>Text for the entry.</p>
1340 The plurality of "div" tags makes it possible to display the entries in
1341 any form you wish, using a CSS style.
1343 Also, an .RDF file can be generated from your journal by publishing it
1344 with the "rdf" style. It uses the first two sentences of the first
1345 paragraph of each entry as its "description", and auto-generates tags
1346 for linking to the various entries.
1348 @subsubheading Styles provided
1352 @cindex publishing styles, journal-html
1354 Publish journal entries as an HTML document.
1356 @cindex publishing styles, journal-xhtml
1358 Publish journal entries as an XHTML document.
1360 @cindex publishing styles, journal-latex
1362 Publish journal entries as a LaTeX document.
1364 @cindex publishing styles, journal-pdf
1366 Publish journal entries as a PDF document.
1368 @cindex publishing styles, journal-book-latex
1369 @item journal-book-latex
1370 Publish journal entries as a LaTeX book.
1372 @cindex publishing styles, journal-book-pdf
1373 @item journal-book-pdf
1374 Publish journal entries as a PDF book.
1376 @cindex publishing styles, journal-rdf
1377 @cindex publishing styles, RSS 1.0
1379 Publish journal entries as an RDF file (RSS 1.0).
1381 @cindex publishing styles, journal-rss
1382 @cindex publishing styles, RSS 2.0
1384 Publish journal entries as an RSS file (RSS 2.0).
1388 @subsubheading Options provided
1392 @item muse-journal-heading-regexp
1393 A regexp that matches a journal heading.
1395 Paren group 1 is the ISO date, group 2 is the optional category, and
1396 group 3 is the optional heading for the entry.
1398 @item muse-journal-date-format
1399 Date format to use for journal entries.
1401 @item muse-journal-html-heading-regexp
1402 A regexp that matches a journal heading from an HTML document.
1404 Paren group 1 is the ISO date, group 2 is the optional category, and
1405 group 3 is the optional heading for the entry.
1407 @item muse-journal-html-entry-template
1408 Template used to publish individual journal entries as HTML.
1410 @item muse-journal-latex-section
1411 Template used to publish a LaTeX section.
1413 @item muse-journal-latex-subsection
1414 Template used to publish a LaTeX subsection.
1416 @item muse-journal-latex-markup-tags
1417 A list of tag specifications, for specially marking up LaTeX.
1419 @xref{muse-publish-markup-tags}, for more information.
1421 @item muse-journal-rdf-extension
1422 Default file extension for publishing RDF (RSS 1.0) files.
1424 @item muse-journal-rdf-base-url
1425 The base URL of the website referenced by the RDF file.
1427 @item muse-journal-rdf-header
1428 Header used for publishing RDF (RSS 1.0) files.
1430 This may be text or a filename.
1432 @item muse-journal-rdf-footer
1433 Footer used for publishing RDF (RSS 1.0) files.
1435 This may be text or a filename.
1437 @item muse-journal-rdf-date-format
1438 Date format to use for RDF entries.
1440 @item muse-journal-rdf-entry-template
1441 Template used to publish individual journal entries as RDF.
1443 @item muse-journal-rdf-summarize-entries
1444 If non-nil, include only summaries in the RDF file, not the full data.
1446 @item muse-journal-rss-extension
1447 Default file extension for publishing RSS 2.0 files.
1449 @item muse-journal-rss-base-url
1450 The base URL of the website referenced by the RSS file.
1452 @item muse-journal-rss-header
1453 Header used for publishing RSS 2.0 files.
1455 This may be text or a filename.
1457 @item muse-journal-rss-footer
1458 Footer used for publishing RSS 2.0 files.
1460 This may be text or a filename.
1462 @item muse-journal-rss-date-format
1463 Date format to use for RSS 2.0 entries.
1465 @item muse-journal-rss-entry-template
1466 Template used to publish individual journal entries as RSS 2.0.
1468 @item muse-journal-rss-enclosure-types-alist
1469 File types that are accepted as RSS enclosures.
1471 This is an alist that maps file extension to content type.
1473 Useful for podcasting.
1475 @item muse-journal-rss-summarize-entries
1476 If non-nil, include only summaries in the RSS file, not the full data.
1478 Many RSS subscribers find this annoying.
1480 @item muse-journal-rss-markup-regexps
1481 List of markup rules for publishing a Muse journal page to RSS.
1483 For more information on the structure of this list,
1484 @xref{muse-publish-markup-regexps}.
1486 @item muse-journal-rss-markup-functions
1487 An alist of style types to custom functions for that kind of text.
1489 For more on the structure of this list,
1490 @xref{muse-publish-markup-functions}.
1494 @node LaTeX, Poem, Journal, Publishing Styles
1495 @comment node-name, next, previous, up
1496 @section Publishing LaTeX documents
1498 This publishing style is capable of producing LaTeX or PDF documents.
1500 If you wish to publish PDF documents, you will need to have a good TeX
1501 installation. For Debian, this can be accomplished by installing the
1502 ``tetex-bin'' and ``tetex-extra'' packages. TeX fonts are also a must.
1504 @subsubheading Styles provided
1508 @cindex publishing styles, latex
1510 Publish a LaTeX document.
1512 @cindex publishing styles, pdf
1514 Publish a PDF document, using an external LaTeX document conversion
1517 @cindex publishing styles, latexcjk
1519 Publish a LaTeX document with CJK (Chinese) encodings.
1521 @cindex publishing styles, pdfcjk
1523 Publish a PDF document with CJK (Chinese) encodings, using an external
1524 LaTeX document conversion tool.
1528 @subsubheading Options provided
1532 @item muse-latex-extension
1533 Default file extension for publishing LaTeX files.
1535 @item muse-latex-pdf-extension
1536 Default file extension for publishing LaTeX files to PDF.
1538 @item muse-latex-header
1539 Header used for publishing LaTeX files.
1541 This may be text or a filename.
1543 @item muse-latex-footer
1544 Footer used for publishing LaTeX files.
1546 This may be text or a filename.
1548 @item muse-latexcjk-header
1549 Header used for publishing LaTeX files (CJK).
1551 This may be text or a filename.
1553 @item muse-latexcjk-footer
1554 Footer used for publishing LaTeX files (CJK).
1556 This may be text or a filename.
1558 @item muse-latex-markup-regexps
1559 List of markup regexps for identifying regions in a Muse page.
1561 For more on the structure of this list,
1562 @xref{muse-publish-markup-regexps}.
1564 @item muse-latex-markup-functions
1565 An alist of style types to custom functions for that kind of text.
1567 For more on the structure of this list,
1568 @xref{muse-publish-markup-functions}.
1570 @item muse-latex-markup-strings
1571 Strings used for marking up text.
1573 These cover the most basic kinds of markup, the handling of which
1574 differs little between the various styles.
1576 @item muse-latexcjk-encoding-map
1577 An alist mapping emacs coding systems to appropriate CJK codings.
1578 Use the base name of the coding system (ie, without the -unix).
1580 @item muse-latexcjk-encoding-default
1581 The default Emacs buffer encoding to use in published files.
1583 This will be used if no special characters are found.
1585 @item muse-latex-markup-specials
1586 A table of characters which must be represented specially.
1590 @node Poem, Texinfo, LaTeX, Publishing Styles
1591 @comment node-name, next, previous, up
1592 @section Publish a poem to LaTex or PDF
1594 The @code{muse-poem} module makes it easy to attractively publish and
1595 reference poems in the following format, using the "memoir" module for
1596 LaTeX publishing. It will also markup poems for every other output
1597 style, though none are nearly as pretty.
1606 Annotations, history, notes, etc.
1609 Once a poem is written in this format, just publish it to PDF using the
1610 @code{poem-pdf} style. To make an inlined reference to a poem that
1611 you've written -- for example, from a blog page -- there is a "poem" tag
1612 defined by this module.
1615 <poem title="name.of.poem.page">
1618 Let's assume the template above was called @file{name.of.poem.page};
1619 then the above tag would result in this inclusion.
1627 John Wiegley uses this module for publishing all of the poems on his
1628 website, which are at
1629 @uref{http://www.newartisans.com/johnw/poems.html}.
1631 @subsubheading Styles provided
1635 @cindex publishing styles, poem-latex
1637 Publish a poem in LaTeX form.
1639 @cindex publishing styles, poem-pdf
1641 Publish a poem to a PDF document.
1643 @cindex publishing styles, chapbook-latex
1644 @item chapbook-latex
1645 Publish a book of poems in LaTeX form.
1647 @cindex publishing styles, chapbook-pdf
1649 Publish a book of poems to a PDF document.
1653 @subsubheading Options provided
1657 @item muse-poem-latex-header
1658 Header used for publishing LaTeX poems.
1660 This may be text or a filename.
1662 @item muse-poem-latex-footer
1663 Footer used for publishing LaTeX files.
1665 This may be text or a filename.
1667 @item muse-poem-markup-strings
1668 Strings used for marking up poems.
1670 These cover the most basic kinds of markup, the handling of which
1671 differs little between the various styles.
1673 @item muse-chapbook-latex-header
1674 Header used for publishing a book of poems in LaTeX form.
1676 This may be text or a filename.
1678 @item muse-chapbook-latex-footer
1679 Footer used for publishing a book of poems in LaTeX form.
1681 This may be text or a filename.
1683 @item muse-poem-chapbook-strings
1684 Strings used for marking up books of poems.
1686 These cover the most basic kinds of markup, the handling of which
1687 differs little between the various styles.
1691 @node Texinfo, Common Elements, Poem, Publishing Styles
1692 @comment node-name, next, previous, up
1693 @section Publish entries to Texinfo format or PDF
1695 Rules for publishing a Muse file as a Texinfo article.
1697 @subsubheading Styles provided
1701 @cindex publishing styles, texi
1703 Publish a file in Texinfo form.
1705 @cindex publishing styles, texi
1707 Generate an Info file from a Muse file.
1709 @cindex publishing styles, info-pdf
1711 Publish a file in PDF form.
1715 @subsubheading Options provided
1719 @item muse-texinfo-process-natively
1720 If non-nil, use the Emacs `texinfmt' module to make Info files.
1722 @item muse-texinfo-extension
1723 Default file extension for publishing Texinfo files.
1725 @item muse-texinfo-info-extension
1726 Default file extension for publishing Info files.
1728 @item muse-texinfo-pdf-extension
1729 Default file extension for publishing PDF files.
1731 @item muse-texinfo-header
1732 Text to prepend to a Muse page being published as Texinfo.
1734 This may be text or a filename.
1735 It may contain @verb{|<lisp>|} markup tags.
1737 @item muse-texinfo-footer
1738 Text to append to a Muse page being published as Texinfo.
1740 This may be text or a filename.
1741 It may contain @verb{|<lisp>|} markup tags.
1743 @item muse-texinfo-markup-regexps
1744 List of markup rules for publishing a Muse page to Texinfo.
1746 For more on the structure of this list,
1747 @xref{muse-publish-markup-regexps}.
1749 @item muse-texinfo-markup-functions
1750 An alist of style types to custom functions for that kind of text.
1752 For more on the structure of this list, see
1753 @xref{muse-publish-markup-functions}.
1755 @item muse-texinfo-markup-strings
1756 Strings used for marking up text.
1758 These cover the most basic kinds of markup, the handling of which
1759 differs little between the various styles.
1761 @item muse-texinfo-markup-specials
1762 A table of characters which must be represented specially.
1766 @node Common Elements, Deriving Styles, Texinfo, Publishing Styles
1767 @comment node-name, next, previous, up
1768 @section Common functionality shared by styles
1769 @cindex publishing styles, common
1772 * Markup Functions:: Specifying functions to marking up text.
1773 * Markup Regexps:: Markup rules for publishing.
1774 * Markup Strings:: Strings specific to a publishing style.
1775 * Markup Tags:: Tag specifications for special markup.
1776 * Style Elements:: Parameters used for defining styles.
1779 @node Markup Functions, Markup Regexps, , Common Elements
1780 @comment node-name, next, previous, up
1781 @subsection Specifying functions to mark up text
1782 @cindex publishing, markup functions
1784 @anchor{muse-publish-markup-functions}
1785 @code{muse-publish-markup-functions}
1787 An alist of style types to custom functions for that kind of text.
1789 This is used by publishing styles to attempt to minimize the amount of
1790 custom regexps that each has to define. @file{muse-publish} provides
1791 rules for the most common types of markup.
1793 Each member of the list is of the following form.
1801 Describes the type of text to associate with this rule.
1802 @code{muse-publish-markup-regexps} maps regexps to these symbols.
1805 Function to use to mark up this kind of rule if no suitable function is
1806 found through the @option{:functions} tag of the current style.
1809 @node Markup Regexps, Markup Strings, Markup Functions, Common Elements
1810 @comment node-name, next, previous, up
1811 @subsection Markup rules for publishing
1812 @cindex publishing, markup regexps
1813 @cindex publishing, rules
1815 @anchor{muse-publish-markup-regexps}
1816 @code{muse-publish-markup-regexps}
1818 List of markup rules for publishing a page with Muse.
1820 The rules given in this variable are invoked first, followed by whatever
1821 rules are specified by the current style.
1823 Each member of the list is either a function, or a list of the following
1827 (REGEXP/SYMBOL TEXT-BEGIN-GROUP REPLACEMENT-TEXT/FUNCTION/SYMBOL)
1832 A regular expression, or symbol whose value is a regular expression,
1833 which is searched for using `re-search-forward'.
1835 @item TEXT-BEGIN-GROUP
1836 The matching group within that regexp which denotes the beginning of the
1837 actual text to be marked up.
1839 @item REPLACEMENT-TEXT
1840 A string that will be passed to `replace-match'.
1842 If it is not a string, but a function, it will be called to determine
1843 what the replacement text should be (it must return a string). If it is
1844 a symbol, the value of that symbol should be a string.
1847 The replacements are done in order, one rule at a time. Writing
1848 the regular expressions can be a tricky business. Note that case
1849 is never ignored. `case-fold-search' is always bound to nil
1850 while processing the markup rules.
1852 @subsubheading Publishing order
1854 This is the order that the publishing rules are consulted, by default.
1855 This may be changed by customizing @code{muse-publish-markup-regexps}.
1859 @item trailing and leading whitespace
1860 Remove trailing and leading whitespace from a file.
1865 This is only recognized at the beginning of a file.
1876 @item explicit links
1877 Prevent emphasis characters in explicit links from being marked up.
1879 Don't actually publish them here, just add a special no-emphasis text
1883 Whitespace-delimited word, possibly with emphasis characters
1885 This function is responsible for marking up emphasis and escaping some
1896 Outline-mode style headings.
1901 These are ellipses with a dot at end.
1911 Horizontal rule or section separator.
1916 beginning of footnotes section
1921 Footnote definition or reference. If at beginning of line, it is a
1936 Numbered list, item list, or term definition list.
1939 spaces before beginning of text
1947 @samp{table | cells}
1950 @samp{[[explicit][links]]}
1953 @samp{http://example.com/}
1956 @samp{bare-email@@example.com}
1960 @node Markup Strings, Markup Tags, Markup Regexps, Common Elements
1961 @comment node-name, next, previous, up
1962 @subsection Strings specific to a publishing style
1963 @cindex publishing, markup strings
1965 @dfn{Markup strings} are strings used for marking up text for a
1968 These cover the most basic kinds of markup, the handling of which
1969 differs little between the various styles.
1971 @subsubheading Available markup strings
1975 @item image-with-desc
1976 An image and a description.
1978 Argument 1: image. Argument 2: description.
1983 Argument 1: image link.
1985 @item url-with-image
1986 A URL with an image.
1988 Argument 1: link. Argument 2: image.
1991 A link with a description.
1993 Argument 1: link. Argument 2: description if one exists, or the
1994 original link otherwise.
1997 A link that refers to an internal anchor.
1999 Argument 1: internal link. Argument 2: description if one exists, or
2000 the original link otherwise.
2003 A link to an email address.
2005 Argument 1: email address. Argument 2: email address.
2011 A horizontal line or space.
2014 Beginning of footnote.
2020 Mark a reference for the current footnote.
2022 Argument 1: number of this footnote.
2025 Indicate the text of the current footnote.
2027 Argument 1: number of this footnote.
2029 @item footnotetext-end
2030 End of a footnote text line.
2033 Text used to replace ``Footnotes:'' line.
2042 Beginning of a part indicator line. This is used by book publishing.
2045 End of a part indicator line. This is used by book publishing.
2048 Beginning of a chapter indicator line. This is used by book publishing.
2051 End of a chapter indicator line. This is used by book publishing.
2054 Beginning of level 1 section indicator line.
2056 Argument 1: level of section; always 1.
2059 End of level 1 section indicator line.
2061 Argument 1: level of section; always 1.
2064 Beginning of level 2 section indicator line.
2066 Argument 1: level of section; always 2.
2068 @item subsection-end
2069 End of level 2 section indicator line.
2071 Argument 1: level of section; always 2.
2074 Beginning of level 3 section indicator line.
2076 Argument 1: level of section; always 3.
2078 @item subsubsection-end
2079 End of level 3 section indicator line.
2081 Argument 1: level of section; always 3.
2084 Beginning of section indicator line, where level is greater than 3.
2086 Argument 1: level of section.
2088 @item section-other-end
2089 Beginning of section indicator line, where level is greater than 3.
2091 Argument 1: level of section.
2093 @item begin-underline
2094 Beginning of underlined text.
2097 End of underlined text.
2100 Beginning of verbatim text. This includes @verb{|<code>|} tags and
2104 End of verbatim text. This includes @verb{|<code>|} tags and =teletype
2108 Beginning of the first level of emphasized text.
2111 End of the first level of emphasized text.
2113 @item begin-more-emph
2114 Beginning of the second level of emphasized text.
2117 End of the second level of emphasized text.
2119 @item begin-most-emph
2120 Beginning of the third (and final) level of emphasized text.
2123 End of the third (and final) level of emphasized text.
2126 Beginning of verse text.
2129 String used to each space that is further indented than the beginning of
2132 @item begin-verse-line
2133 Beginning of a line of verse.
2135 @item empty-verse-line
2136 End of a line of verse.
2138 @item begin-last-stanza-line
2139 Beginning of the last line of a verse stanza.
2141 @item end-last-stanza-line
2142 End of the last line of a verse stanza.
2148 Beginning of an example region. To make use of this, an
2149 @samp{<example>} tag is needed.
2152 End of an example region. To make use of this, an @samp{</example>} tag
2156 Begin a centered line.
2159 End a centered line.
2162 Begin a quoted region.
2165 End a quoted region.
2168 Begin an unordered list.
2171 End an unordered list.
2174 Begin an ordered list.
2177 End an ordered list.
2180 Begin a definition list.
2183 Begin a term in a definition list.
2186 End a definition list.
2190 @node Markup Tags, Style Elements, Markup Strings, Common Elements
2191 @comment node-name, next, previous, up
2192 @subsection Tag specifications for special markup
2193 @cindex publishing, markup tags
2195 @anchor{muse-publish-markup-tags}
2196 @code{muse-publish-markup-tags}
2198 A list of tag specifications, for specially marking up text.
2200 XML-style tags are the best way to add custom markup to Muse. This is
2201 easily accomplished by customizing this list of markup tags.
2203 For each entry, the name of the tag is given, whether it expects a
2204 closing tag and/or an optional set of attributes, and a function that
2205 performs whatever action is desired within the delimited region.
2207 The tags themselves are deleted during publishing, before the function
2208 is called. The function is called with three arguments, the beginning
2209 and end of the region surrounded by the tags. If properties are
2210 allowed, they are passed as a third argument in the form of an alist.
2211 The `end' argument to the function is always a marker.
2213 Point is always at the beginning of the region within the tags, when the
2214 function is called. Wherever point is when the function finishes is
2215 where tag markup will resume.
2217 These tag rules are processed once at the beginning of markup, and once
2218 at the end, to catch any tags which may have been inserted in-between.
2220 @node Style Elements, , Markup Tags, Common Elements
2221 @comment node-name, next, previous, up
2222 @subsection Parameters used for defining styles
2223 @cindex publishing, style elements
2225 Style elements are tags that define a style. Use
2226 @code{muse-define-style} to create a new style.
2229 (muse-define-style DERIVED-NAME BASE-NAME STYLE-PARAMETERS)
2232 @subsubheading Usable elements
2237 File extension to use for publishing files with this style.
2240 File extension to use for publishing links to Muse files with this
2244 File extension to use for publishing second-stage files with this style.
2246 For example, PDF publishing generates a LaTeX file first, then a PDF
2247 from that LaTeX file.
2250 List of markup rules for publishing a page with Muse.
2251 @xref{muse-publish-markup-regexps}.
2254 An alist of style types to custom functions for that kind of text.
2255 @xref{muse-publish-markup-functions}.
2258 Strings used for marking up text with this style.
2260 These cover the most basic kinds of markup, the handling of which
2261 differs little between the various styles.
2264 A list of tag specifications, used for handling extra tags.
2265 @xref{muse-publish-markup-tags}.
2268 A table of characters which must be represented specially.
2271 A function that is to be executed on the newly-created publishing buffer
2272 (or the current region) before any publishing occurs.
2274 This is used to set extra parameters that direct the publishing process.
2277 A function that is to be executed on the publishing buffer (or the
2278 current region) immediately after applying all of the markup regexps.
2280 This is used to fix the order of table elements (header, footer, body)
2284 A function that is to be executed on the publishing buffer after
2285 :before-end, and immediately after inserting the header and footer.
2287 This is used for generating the table of contents as well as setting the
2291 A function that is to be executed after saving the published file, but
2292 while still in its buffer.
2294 This is used for generating second-stage documents like PDF files from
2295 just-published LaTeX files.
2298 Header used for publishing files of this style.
2300 This may be text or a filename. It is inserted at the beginning of a
2301 file, after evaluating the publishing markup.
2304 Footer used for publishing files of this style.
2306 This may be text or a filename. It is inserted at the end of a file,
2307 after evaluating the publishing markup.
2310 The function used to browse the published result of files of this style.
2314 @node Deriving Styles, , Common Elements, Publishing Styles
2315 @comment node-name, next, previous, up
2316 @section Deriving a new style from an existing one
2317 @cindex publishing styles, deriving
2319 To create a new style from an existing one, use @code{muse-derive-style}
2320 as follows. This is a good way to fix something you don't like about a
2321 particular publishing style, or to personalize it.
2324 (muse-derive-style DERIVED-NAME BASE-NAME STYLE-PARAMETERS)
2327 The derived name is a string defining the new style, such as "my-html".
2328 The base name must identify an existing style, such as "html" -- if you
2329 have loaded @file{muse-html}. The style parameters are the same as
2330 those used to create a style, except that they override whatever
2331 definitions exist in the base style. However, some definitions only
2332 partially override. The following parameters support partial
2335 @xref{Style Elements}, for a complete list of all parameters.
2340 If a markup function is not found in the derived style's function list,
2341 the base style's function list will be queried.
2344 All regexps in the current style and the base style(s) will be used.
2347 If a markup string is not found in the derived style's string list, the
2348 base style's string list will be queried.
2353 @node Getting Help and Reporting Bugs, History, Publishing Styles, Top
2354 @comment node-name, next, previous, up
2355 @chapter Getting Help and Reporting Bugs
2356 @cindex help, getting
2357 @cindex bugs, reporting
2359 After you have read this guide, if you still have questions about
2360 Muse, or if you have bugs to report, there are several places you can
2366 @uref{http://www.emacswiki.org/cgi-bin/wiki/MuseMode} is the
2367 emacswiki.org page, and anyone may add tips, hints, or bug descriptions
2371 @uref{http://www.mwolson.org/projects/MuseMode.html} is the web page
2372 that Michael Olson (the current maintainer) made for Muse.
2375 You can join the mailing list at @email{emacs-wiki-discuss@@nongnu.org}
2376 using the subscription form at
2377 @uref{http://mail.nongnu.org/mailman/listinfo/ emacs-wiki-discuss}.
2378 This mailing list provides support for Muse, @command{Planner} and
2379 @command{emacs-wiki}, which is the predecessor of Muse.
2381 There are additional methods for accessing the mailing list, adding
2382 content to it, and searching it. Consult
2383 @uref{http://www.emacswiki.org/cgi-bin/wiki/EmacsWikiMailingList} for
2387 You can visit the IRC Freenode channel @samp{#emacs}. Many of the
2388 contributors are frequently around and willing to answer your
2389 questions. The @samp{#muse} channel is also available for
2390 Muse-specific help, and its current maintainer hangs out there.
2393 The maintainer of MuseMode, Michael Olson, may be contacted at
2394 @email{mwolson@@gnu.org}.
2398 @node History, Contributors, Getting Help and Reporting Bugs, Top
2399 @comment node-name, next, previous, up
2400 @chapter History of This Document
2401 @cindex history, of Muse
2405 John Wiegley started Muse upon realizing that EmacsWiki had some serious
2406 limitations. Around February 2004, he started making "emacs-wiki version
2407 3.00 APLHA", which eventually became known as Muse.
2409 Most of those who frequent the emacs-wiki mailing list continued to use
2410 emacs-wiki, mainly because Planner hasn't been ported over to it.
2412 As of 2004-12-01, Michael Olson became the maintainer of Muse, as per
2413 John Wiegley's request.
2416 Michael Olson overhauled this document and added many new sections in
2417 preparation for the first release of Muse (3.01).
2421 @node Contributors, GNU General Public License, History, Top
2422 @comment node-name, next, previous, up
2423 @chapter Contributors to This Documentation
2424 @cindex contributors
2426 The first draft of this document was taken from the emacs-wiki texinfo
2427 manual. Michael Olson adapted it for Muse and added most of its
2430 John Sullivan did a majority of the work on the emacs-wiki texinfo
2433 While Sacha Chua maintained emacs-wiki, she worked quite a bit on the
2434 emacs-wiki texinfo manual.
2436 @node GNU General Public License, Concept Index, Contributors, Top
2437 @comment node-name, next, previous, up
2438 @appendix GNU GENERAL PUBLIC LICENSE
2439 @center Version 2, June 1991
2441 @cindex GNU General Public License
2443 @c This file is intended to be included in another file.
2446 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
2447 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
2449 Everyone is permitted to copy and distribute verbatim copies
2450 of this license document, but changing it is not allowed.
2453 @appendixsec Preamble
2455 The licenses for most software are designed to take away your
2456 freedom to share and change it. By contrast, the GNU General Public
2457 License is intended to guarantee your freedom to share and change free
2458 software---to make sure the software is free for all its users. This
2459 General Public License applies to most of the Free Software
2460 Foundation's software and to any other program whose authors commit to
2461 using it. (Some other Free Software Foundation software is covered by
2462 the GNU Library General Public License instead.) You can apply it to
2465 When we speak of free software, we are referring to freedom, not
2466 price. Our General Public Licenses are designed to make sure that you
2467 have the freedom to distribute copies of free software (and charge for
2468 this service if you wish), that you receive source code or can get it
2469 if you want it, that you can change the software or use pieces of it
2470 in new free programs; and that you know you can do these things.
2472 To protect your rights, we need to make restrictions that forbid
2473 anyone to deny you these rights or to ask you to surrender the rights.
2474 These restrictions translate to certain responsibilities for you if you
2475 distribute copies of the software, or if you modify it.
2477 For example, if you distribute copies of such a program, whether
2478 gratis or for a fee, you must give the recipients all the rights that
2479 you have. You must make sure that they, too, receive or can get the
2480 source code. And you must show them these terms so they know their
2483 We protect your rights with two steps: (1) copyright the software, and
2484 (2) offer you this license which gives you legal permission to copy,
2485 distribute and/or modify the software.
2487 Also, for each author's protection and ours, we want to make certain
2488 that everyone understands that there is no warranty for this free
2489 software. If the software is modified by someone else and passed on, we
2490 want its recipients to know that what they have is not the original, so
2491 that any problems introduced by others will not reflect on the original
2492 authors' reputations.
2494 Finally, any free program is threatened constantly by software
2495 patents. We wish to avoid the danger that redistributors of a free
2496 program will individually obtain patent licenses, in effect making the
2497 program proprietary. To prevent this, we have made it clear that any
2498 patent must be licensed for everyone's free use or not licensed at all.
2500 The precise terms and conditions for copying, distribution and
2501 modification follow.
2504 @appendixsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
2507 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
2512 This License applies to any program or other work which contains
2513 a notice placed by the copyright holder saying it may be distributed
2514 under the terms of this General Public License. The ``Program'', below,
2515 refers to any such program or work, and a ``work based on the Program''
2516 means either the Program or any derivative work under copyright law:
2517 that is to say, a work containing the Program or a portion of it,
2518 either verbatim or with modifications and/or translated into another
2519 language. (Hereinafter, translation is included without limitation in
2520 the term ``modification''.) Each licensee is addressed as ``you''.
2522 Activities other than copying, distribution and modification are not
2523 covered by this License; they are outside its scope. The act of
2524 running the Program is not restricted, and the output from the Program
2525 is covered only if its contents constitute a work based on the
2526 Program (independent of having been made by running the Program).
2527 Whether that is true depends on what the Program does.
2530 You may copy and distribute verbatim copies of the Program's
2531 source code as you receive it, in any medium, provided that you
2532 conspicuously and appropriately publish on each copy an appropriate
2533 copyright notice and disclaimer of warranty; keep intact all the
2534 notices that refer to this License and to the absence of any warranty;
2535 and give any other recipients of the Program a copy of this License
2536 along with the Program.
2538 You may charge a fee for the physical act of transferring a copy, and
2539 you may at your option offer warranty protection in exchange for a fee.
2542 You may modify your copy or copies of the Program or any portion
2543 of it, thus forming a work based on the Program, and copy and
2544 distribute such modifications or work under the terms of Section 1
2545 above, provided that you also meet all of these conditions:
2549 You must cause the modified files to carry prominent notices
2550 stating that you changed the files and the date of any change.
2553 You must cause any work that you distribute or publish, that in
2554 whole or in part contains or is derived from the Program or any
2555 part thereof, to be licensed as a whole at no charge to all third
2556 parties under the terms of this License.
2559 If the modified program normally reads commands interactively
2560 when run, you must cause it, when started running for such
2561 interactive use in the most ordinary way, to print or display an
2562 announcement including an appropriate copyright notice and a
2563 notice that there is no warranty (or else, saying that you provide
2564 a warranty) and that users may redistribute the program under
2565 these conditions, and telling the user how to view a copy of this
2566 License. (Exception: if the Program itself is interactive but
2567 does not normally print such an announcement, your work based on
2568 the Program is not required to print an announcement.)
2571 These requirements apply to the modified work as a whole. If
2572 identifiable sections of that work are not derived from the Program,
2573 and can be reasonably considered independent and separate works in
2574 themselves, then this License, and its terms, do not apply to those
2575 sections when you distribute them as separate works. But when you
2576 distribute the same sections as part of a whole which is a work based
2577 on the Program, the distribution of the whole must be on the terms of
2578 this License, whose permissions for other licensees extend to the
2579 entire whole, and thus to each and every part regardless of who wrote it.
2581 Thus, it is not the intent of this section to claim rights or contest
2582 your rights to work written entirely by you; rather, the intent is to
2583 exercise the right to control the distribution of derivative or
2584 collective works based on the Program.
2586 In addition, mere aggregation of another work not based on the Program
2587 with the Program (or with a work based on the Program) on a volume of
2588 a storage or distribution medium does not bring the other work under
2589 the scope of this License.
2592 You may copy and distribute the Program (or a work based on it,
2593 under Section 2) in object code or executable form under the terms of
2594 Sections 1 and 2 above provided that you also do one of the following:
2598 Accompany it with the complete corresponding machine-readable
2599 source code, which must be distributed under the terms of Sections
2600 1 and 2 above on a medium customarily used for software interchange; or,
2603 Accompany it with a written offer, valid for at least three
2604 years, to give any third party, for a charge no more than your
2605 cost of physically performing source distribution, a complete
2606 machine-readable copy of the corresponding source code, to be
2607 distributed under the terms of Sections 1 and 2 above on a medium
2608 customarily used for software interchange; or,
2611 Accompany it with the information you received as to the offer
2612 to distribute corresponding source code. (This alternative is
2613 allowed only for noncommercial distribution and only if you
2614 received the program in object code or executable form with such
2615 an offer, in accord with Subsection b above.)
2618 The source code for a work means the preferred form of the work for
2619 making modifications to it. For an executable work, complete source
2620 code means all the source code for all modules it contains, plus any
2621 associated interface definition files, plus the scripts used to
2622 control compilation and installation of the executable. However, as a
2623 special exception, the source code distributed need not include
2624 anything that is normally distributed (in either source or binary
2625 form) with the major components (compiler, kernel, and so on) of the
2626 operating system on which the executable runs, unless that component
2627 itself accompanies the executable.
2629 If distribution of executable or object code is made by offering
2630 access to copy from a designated place, then offering equivalent
2631 access to copy the source code from the same place counts as
2632 distribution of the source code, even though third parties are not
2633 compelled to copy the source along with the object code.
2636 You may not copy, modify, sublicense, or distribute the Program
2637 except as expressly provided under this License. Any attempt
2638 otherwise to copy, modify, sublicense or distribute the Program is
2639 void, and will automatically terminate your rights under this License.
2640 However, parties who have received copies, or rights, from you under
2641 this License will not have their licenses terminated so long as such
2642 parties remain in full compliance.
2645 You are not required to accept this License, since you have not
2646 signed it. However, nothing else grants you permission to modify or
2647 distribute the Program or its derivative works. These actions are
2648 prohibited by law if you do not accept this License. Therefore, by
2649 modifying or distributing the Program (or any work based on the
2650 Program), you indicate your acceptance of this License to do so, and
2651 all its terms and conditions for copying, distributing or modifying
2652 the Program or works based on it.
2655 Each time you redistribute the Program (or any work based on the
2656 Program), the recipient automatically receives a license from the
2657 original licensor to copy, distribute or modify the Program subject to
2658 these terms and conditions. You may not impose any further
2659 restrictions on the recipients' exercise of the rights granted herein.
2660 You are not responsible for enforcing compliance by third parties to
2664 If, as a consequence of a court judgment or allegation of patent
2665 infringement or for any other reason (not limited to patent issues),
2666 conditions are imposed on you (whether by court order, agreement or
2667 otherwise) that contradict the conditions of this License, they do not
2668 excuse you from the conditions of this License. If you cannot
2669 distribute so as to satisfy simultaneously your obligations under this
2670 License and any other pertinent obligations, then as a consequence you
2671 may not distribute the Program at all. For example, if a patent
2672 license would not permit royalty-free redistribution of the Program by
2673 all those who receive copies directly or indirectly through you, then
2674 the only way you could satisfy both it and this License would be to
2675 refrain entirely from distribution of the Program.
2677 If any portion of this section is held invalid or unenforceable under
2678 any particular circumstance, the balance of the section is intended to
2679 apply and the section as a whole is intended to apply in other
2682 It is not the purpose of this section to induce you to infringe any
2683 patents or other property right claims or to contest validity of any
2684 such claims; this section has the sole purpose of protecting the
2685 integrity of the free software distribution system, which is
2686 implemented by public license practices. Many people have made
2687 generous contributions to the wide range of software distributed
2688 through that system in reliance on consistent application of that
2689 system; it is up to the author/donor to decide if he or she is willing
2690 to distribute software through any other system and a licensee cannot
2693 This section is intended to make thoroughly clear what is believed to
2694 be a consequence of the rest of this License.
2697 If the distribution and/or use of the Program is restricted in
2698 certain countries either by patents or by copyrighted interfaces, the
2699 original copyright holder who places the Program under this License
2700 may add an explicit geographical distribution limitation excluding
2701 those countries, so that distribution is permitted only in or among
2702 countries not thus excluded. In such case, this License incorporates
2703 the limitation as if written in the body of this License.
2706 The Free Software Foundation may publish revised and/or new versions
2707 of the General Public License from time to time. Such new versions will
2708 be similar in spirit to the present version, but may differ in detail to
2709 address new problems or concerns.
2711 Each version is given a distinguishing version number. If the Program
2712 specifies a version number of this License which applies to it and ``any
2713 later version'', you have the option of following the terms and conditions
2714 either of that version or of any later version published by the Free
2715 Software Foundation. If the Program does not specify a version number of
2716 this License, you may choose any version ever published by the Free Software
2720 If you wish to incorporate parts of the Program into other free
2721 programs whose distribution conditions are different, write to the author
2722 to ask for permission. For software which is copyrighted by the Free
2723 Software Foundation, write to the Free Software Foundation; we sometimes
2724 make exceptions for this. Our decision will be guided by the two goals
2725 of preserving the free status of all derivatives of our free software and
2726 of promoting the sharing and reuse of software generally.
2729 @heading NO WARRANTY
2736 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
2737 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
2738 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
2739 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
2740 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
2741 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
2742 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
2743 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
2744 REPAIR OR CORRECTION.
2747 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
2748 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
2749 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
2750 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
2751 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
2752 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
2753 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
2754 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
2755 POSSIBILITY OF SUCH DAMAGES.
2759 @heading END OF TERMS AND CONDITIONS
2762 @center END OF TERMS AND CONDITIONS
2766 @appendixsec Appendix: How to Apply These Terms to Your New Programs
2768 If you develop a new program, and you want it to be of the greatest
2769 possible use to the public, the best way to achieve this is to make it
2770 free software which everyone can redistribute and change under these terms.
2772 To do so, attach the following notices to the program. It is safest
2773 to attach them to the start of each source file to most effectively
2774 convey the exclusion of warranty; and each file should have at least
2775 the ``copyright'' line and a pointer to where the full notice is found.
2778 @var{one line to give the program's name and a brief idea of what it does.}
2779 Copyright (C) @var{yyyy} @var{name of author}
2781 This program is free software; you can redistribute it and/or modify
2782 it under the terms of the GNU General Public License as published by
2783 the Free Software Foundation; either version 2 of the License, or
2784 (at your option) any later version.
2786 This program is distributed in the hope that it will be useful,
2787 but WITHOUT ANY WARRANTY; without even the implied warranty of
2788 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2789 GNU General Public License for more details.
2791 You should have received a copy of the GNU General Public License along
2792 with this program; if not, write to the Free Software Foundation, Inc.,
2793 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
2796 Also add information on how to contact you by electronic and paper mail.
2798 If the program is interactive, make it output a short notice like this
2799 when it starts in an interactive mode:
2802 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
2803 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
2804 This is free software, and you are welcome to redistribute it
2805 under certain conditions; type `show c' for details.
2808 The hypothetical commands @samp{show w} and @samp{show c} should show
2809 the appropriate parts of the General Public License. Of course, the
2810 commands you use may be called something other than @samp{show w} and
2811 @samp{show c}; they could even be mouse-clicks or menu items---whatever
2814 You should also get your employer (if you work as a programmer) or your
2815 school, if any, to sign a ``copyright disclaimer'' for the program, if
2816 necessary. Here is a sample; alter the names:
2819 Yoyodyne, Inc., hereby disclaims all copyright interest in the program
2820 `Gnomovision' (which makes passes at compilers) written by James Hacker.
2822 @var{signature of Ty Coon}, 1 April 1989
2823 Ty Coon, President of Vice
2826 This General Public License does not permit incorporating your program into
2827 proprietary programs. If your program is a subroutine library, you may
2828 consider it more useful to permit linking proprietary applications with the
2829 library. If this is what you want to do, use the GNU Library General
2830 Public License instead of this License.
2833 @node Concept Index, , GNU General Public License, Top
2834 @comment node-name, next, previous, up
2842 @c ispell-local-pdict: "ispell-dict"