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.90 (3.03 RC1).
17 Copyright @copyright{} 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 * Extending Muse:: Making your own publishing styles.
60 * Getting Help and Reporting Bugs::
61 * History:: History of this document.
62 * Contributors:: Contributors to this documentation.
63 * GNU General Public License:: The license for this manual and Muse.
64 * Concept Index:: Search for terms.
67 --- The Detailed Node Listing ---
69 How to Get Muse Releases and Development Changes
71 * Releases:: Released versions of Muse.
72 * Development:: Latest unreleased development changes.
74 Rules for Using Markup
76 * Paragraphs:: Paragraphs: centering and quoting.
77 * Headings:: Levels of headings.
78 * Directives:: Directives at the beginning of a
80 * Emphasizing Text:: Bold, italicized, and underlined text.
81 * Footnotes:: Making notes to be shown at the end.
82 * Verse:: Indicating poetic stanzas.
83 * Lists:: Lists of items.
84 * Tables:: Generation of data tables.
85 * Explicit Links:: Hyperlinks and email addresses with
87 * Implicit Links:: Bare URLs, WikiNames, and InterWiki
89 * Images:: Publishing and displaying images.
90 * Horizontal Rules and Anchors:: Inserting a horizontal line or anchor.
91 * Embedded Lisp:: Evaluating Emacs Lisp code in documents
93 * Comments:: Lines to omit from published output.
94 * Tag Summary:: Tags that Muse recognizes.
96 Publishing Various Types of Documents
98 * Blosxom:: Integrating Muse and pyblosxom.cgi.
99 * Book:: Publishing entries into a compilation.
100 * DocBook:: Publishing in DocBook XML form.
101 * HTML:: Publishing in HTML or XHTML form.
102 * Journal:: Keeping a journal or blog.
103 * LaTeX:: Publishing LaTeX documents.
104 * Poem:: Publish a poem to LaTex or PDF.
105 * Texinfo:: Publish entries to Texinfo format or PDF.
107 Integrating Muse and pyblosxom.cgi
109 * Blosxom Requirements:: Other tools needed to the Blosxom style.
110 * Blosxom Entries:: Format of a Blosxom entry and automation.
111 * Blosxom Options:: Blosxom styles and options provided.
113 Making your own publishing styles
115 * Common Elements:: Common functionality shared by styles.
116 * Deriving Styles:: Deriving a new style from an existing
119 Common functionality shared by styles
121 * Markup Functions:: Specifying functions to marking up text.
122 * Markup Regexps:: Markup rules for publishing.
123 * Markup Strings:: Strings specific to a publishing style.
124 * Markup Tags:: Tag specifications for special markup.
125 * Style Elements:: Parameters used for defining styles.
130 @node Preface, Introduction, Top, Top
131 @comment node-name, next, previous, up
132 @chapter About the documentation
134 This document describes Muse, which was written by John Wiegley
135 and is now maintained by Michael Olson. Several versions of it are
139 @item PDF: http://www.mwolson.org/static/doc/muse.pdf
140 @item HTML (single file): http://www.mwolson.org/static/doc/muse.html
141 @item HTML (multiple files): http://www.mwolson.org/static/doc/muse/
144 @node Introduction, Obtaining Muse, Preface, Top
145 @comment node-name, next, previous, up
146 @chapter What is Muse?
148 Emacs Muse is an authoring and publishing environment for Emacs. It
149 simplifies the process of writing documents and publishing them to
150 various output formats.
152 Muse consists of two main parts: an enhanced text-mode for authoring
153 documents and navigating within Muse projects, and a set of publishing
154 styles for generating different kinds of output.
156 This idea is not in any way new. Numerous systems exist -- even one
157 other for Emacs itself (Bhl Mode). What Muse adds to the picture is a
158 more modular environment, with a rather simple core, in which "styles"
159 are derived from to create new styles. Much of Muse's overall
160 functionality is optional. For example, you can use the publisher
161 without the major-mode, or the mode without doing any publishing; or if
162 you don't load the Texinfo or LaTeX modules, those styles won't be
165 The Muse codebase is a departure from emacs-wiki.el version 2.44. The
166 code has been restructured and rewritten, especially its publishing
167 functions. The focus in this revision is on the authoring and publishing
168 aspects, and the "wikiness" has been removed as a default behavior
169 (available in the optional @file{muse-wiki} module). CamelCase words are
170 no longer special by default.
172 @node Obtaining Muse, Installation, Introduction, Top
173 @comment node-name, next, previous, up
174 @chapter How to Get Muse Releases and Development Changes
177 * Releases:: Released versions of Muse.
178 * Development:: Latest unreleased development changes.
181 @node Releases, Development, Obtaining Muse, Obtaining Muse
182 @comment node-name, next, previous, up
183 @section Released versions of Muse
185 Choose to install a release if you want to minimize risk.
187 Errors are corrected in development first. User-visible changes will be
188 announced on the @email{emacs-wiki-discuss@@nongnu.org} mailing list.
189 This mailing list also provides support for @command{Planner} and
190 @command{emacs-wiki}, which is the predecessor of Muse.
191 @pxref{Getting Help and Reporting Bugs}.
193 @cindex releases, Debian package
194 @cindex Debian package for Muse
195 Debian users can get Muse via apt-get. The @file{muse-el} package is
196 available both at Michael Olson's Debian repository and the official
197 Debian repository. To make use of the former, add the following line to
198 your @file{/etc/apt/sources.list} file and run @code{apt-get install
202 deb http://www.mwolson.org/debian/ ./
205 @cindex releases, from source
206 Alternatively, you can download the latest release from
207 @uref{http://www.mwolson.org/static/dist/muse/} .
209 @node Development, , Releases, Obtaining Muse
210 @comment node-name, next, previous, up
211 @section Latest unreleased development changes
214 Choose the development version if you want to live on the bleeding edge
215 of Muse development or try out new features before release.
217 @cindex arch revision control system, using
218 The Arch revision control system allows you to retrieve previous
219 versions and select specific features and bug fixes. If you would like
220 to contribute to Muse development, it is highly recommended that you use
221 Arch, but this is not a requirement.
223 If you are new to Arch, you might find this tutorial helpful:
224 @uref{http://www.mwolson.org/projects/ArchTutorial.html}.
226 Downloading the Muse module with Arch and staying up-to-date involves
233 @item Debian: @kbd{apt-get install tla}.
234 @item Other distributions: see @uref{http://regexps.srparish.net/www/}.
237 @item Register the archive.
239 tla register-archive -f http://www.mwolson.org/archives/2005
242 @item Download the Muse package.
244 # Download Muse into the @file{muse} directory.
245 tla get mwolson@@gnu.org--2005/muse--main--1.0 muse
248 @item List upstream changes that are missing from your local copy.
249 Do this whenever you want to see whether new changes have been committed
253 # Change to the source directory you are interested in.
256 # Display the summary of changes
257 tla missing --summary
260 @cindex updating Muse with Arch
261 @item Update to the latest version by replaying missing changes.
269 There are other ways to interact with the Muse archive.
272 @item Browse arch repository: @uref{http://www.mwolson.org/archives/}
273 @item Latest development snapshot: @uref{http://www.mwolson.org/static/dist/muse-latest.tar.gz}
276 The latest development snapshot will be kept up-to-date since it is
277 updated at the same time as the Arch repository.
279 @node Installation, Getting Started, Obtaining Muse, Top
280 @comment node-name, next, previous, up
281 @chapter Compiling and Installing Muse
283 Muse may be compiled and installed on your machine.
285 @subheading Compilation
287 This is an optional step, since Emacs Lisp source code does not
288 necessarily have to be byte-compiled. It will yield a speed increase,
291 A working copy of Emacs or XEmacs is needed in order to compile the
292 Emacs Muse. By default, the program that is installed with the name
293 @command{emacs} will be used.
295 If you want to use the @command{xemacs} binary to perform the
296 compilation, you would need to edit @file{Makefile.defs} in the
297 top-level directory as follows. You can put either a full path to an
298 Emacs or XEmacs binary or just the command name, as long as it is in the
303 SITEFLAG = -no-site-file
306 Running @code{make} should compile the Muse source files in the
307 @file{lisp} directory.
309 @subheading Installation
311 Muse may be installed into your file hierarchy by doing the following.
313 Edit the @file{Makefile.defs} file so that @env{ELISPDIR} points to
314 where you want the source and compiled Muse files to be installed and
315 @env{INFODIR} indicates where to put the Muse manual. Of course, you
316 will want to edit @env{EMACS} and @env{SITEFLAG} as shown in the
317 Compilation section if you are using XEmacs.
319 If you are installing Muse on a Debian system, you might want to change
320 the value of @env{INSTALLINFO} as specified in @file{Makefile.defs}.
322 If you wish to install Muse to different locations than the defaults
323 specify, edit @file{Makefile.defs} accordingly.
325 Run @code{make} as a normal user.
327 Run @code{make install} as the root user if you have chosen installation
328 locations that require this.
331 @node Getting Started, Projects, Installation, Top
332 @comment node-name, next, previous, up
333 @chapter Getting Started
336 To use Muse, add the directory containing its files to your
337 @code{load-path} variable, in your @file{.emacs} file. Then, load in
338 the authoring mode, and the styles you wish to publish to. An example
342 (add-to-list 'load-path "<path to Muse>")
344 (require 'muse-mode) ; load authoring mode
346 (require 'muse-html) ; load publishing styles I use
347 (require 'muse-latex)
348 (require 'muse-texinfo)
349 (require 'muse-docbook)
352 Once loaded, the command @kbd{M-x muse-publish-this-file} will publish
353 an input document to any available style. If you enable
354 @file{muse-mode} within a buffer, by typing @kbd{M-x muse-mode}, this
355 command will be bound to @kbd{C-c C-t}.
357 If the currently opened file is part of a defined project in
358 @code{muse-project-alist}, it may be published using @kbd{C-c C-p}.
360 You should also type @kbd{M-x customize-group}, and give the name
361 @samp{muse}. Each of the options has its own documentation.
364 @node Projects, Keystroke Summary, Getting Started, Top
365 @comment node-name, next, previous, up
366 @chapter Creating and Managing Muse Projects
369 Often you will want to publish all the files within a directory to a
370 particular set of output styles automatically. To support, Muse
371 allows for the creations of "projects". Here is a sample project, to
372 be defined in your @file{.emacs} file.
375 (require 'muse-project)
377 (setq muse-project-alist
378 '(("website" ; my various writings
379 ("~/Pages" :default "index")
380 (:base "html" :path "~/public_html")
381 (:base "pdf" :path "~/public_html/pdf"))))
384 The above defines a project named "website", whose files are located
385 in the directory @file{~/Pages}. The default page to visit is
386 @file{index}. When this project is published, each page will be
387 output as HTML to the directory @file{~/public_html}, and as PDF to
388 the directory @file{~/public_html/pdf}. Within any project page, you
389 may create a link to other pages using the syntax @samp{[[pagename]]}.
391 By default, Muse expects all project files to have the file extension
392 @file{.muse}. Files without this extension will not be associated with
393 Muse mode and will not be considered part of any project, even if they
394 are within a project directory.
396 If you don't want to use @file{.muse}, you can customize the extension
397 by setting the value of @code{muse-file-extension}.
399 If you don't want to use any extension at all, and want Muse to
400 autodetect project files based on their location, then add the following
401 to your Muse settings file.
404 (setq muse-file-extension nil
408 If you would like to include only some files from a directory in a Muse
409 project, you may use a regexp in place of @file{~/Pages} in the example.
411 @c PRE3_03: Give more examples
412 @c PRE3_03: Describe :set and other options fully
414 @node Keystroke Summary, Markup Rules, Projects, Top
415 @comment node-name, next, previous, up
416 @chapter Keys Used in Muse Mode
419 This is a summary of keystrokes available in every Muse buffer.
423 @item C-c C-a (`muse-index')
424 Display an index of all known Muse pages.
426 @item C-c C-b (`muse-find-backlinks')
427 Find all pages that link to this page.
429 @item C-c C-e (`muse-edit-link-at-point')
432 @item C-c C-f (`muse-project-find-file')
433 Open another Muse page. Prompt for the name.
435 @item C-c C-i (`muse-insert-tag')
436 Insert a tag interactively.
438 @item C-c C-l (`font-lock-mode')
439 Toggle font lock / highlighting for the current buffer.
441 @item C-c C-p (`muse-project-publish')
442 Publish any Muse pages that have changed.
444 @item C-c C-s (`muse-search')
445 Find text in all files of the current project.
447 @item C-c C-v (`muse-browse-result')
448 Show the published result of this page.
450 @item C-c = (`muse-what-changed')
451 Diff this page against the last backup version.
453 @item C-c TAB l (`muse-insert-relative-link-to-file')
454 Insert a link to a file interactively.
456 @item C-c TAB t (`muse-insert-tag')
457 Insert a tag interactively.
460 Move to the next Wiki reference.
463 Move to the previous Wiki reference.
466 Complete the name of a page from the current project at point.
469 Insert a new list item at point, indenting properly.
472 Decrease the indentation of the list item at point.
475 Increase the indentation of the list item at point.
480 @node Markup Rules, Publishing Styles, Keystroke Summary, Top
481 @comment node-name, next, previous, up
482 @chapter Rules for Using Markup
485 A Muse document uses special, contextual markup rules to determine how
486 to format the output result. For example, if a paragraph is indented,
487 Muse assumes it should be quoted.
489 There are not too many markup rules, and all of them strive to be as
490 simple as possible so that you can focus on document creation, rather
494 * Paragraphs:: Paragraphs: centering and quoting.
495 * Headings:: Levels of headings.
496 * Directives:: Directives at the beginning of a
498 * Emphasizing Text:: Bold, italicized, and underlined text.
499 * Footnotes:: Making notes to be shown at the end.
500 * Verse:: Indicating poetic stanzas.
501 * Lists:: Lists of items.
502 * Tables:: Generation of data tables.
503 * Explicit Links:: Hyperlinks and email addresses with
505 * Implicit Links:: Bare URLs, WikiNames, and InterWiki
507 * Images:: Publishing and displaying images.
508 * Horizontal Rules and Anchors:: Inserting a horizontal line or anchor.
509 * Embedded Lisp:: Evaluating Emacs Lisp code in documents
511 * Comments:: Lines to omit from published output.
512 * Tag Summary:: Tags that Muse recognizes.
515 @node Paragraphs, Headings, Markup Rules, Markup Rules
516 @comment node-name, next, previous, up
517 @section Paragraphs: centering and quoting
520 Paragraphs in Muse must be separated by a blank line.
522 @cindex paragraphs, centered
523 @subheading Centered paragraphs and quotations
525 A line that begins with six or more columns of whitespace (either tabs
526 or spaces) indicates a centered paragraph. Alternatively, you can use
527 the @verb{|<center>|} tag to surround regions that are to be published as
530 @cindex paragraphs, quoted
532 But if a line begins with whitespace, though less than six columns, it
533 indicates a quoted paragraph. Alternatively, you can use the
534 @verb{|<quote>|} tag to surround regions that are to be published as
538 @cindex monospace, rendering blocks
539 @cindex HTML, rendering blocks in monospace
540 @subheading Literal paragraphs
542 The @verb{|<example>|} tag is used for examples, where whitespace should
543 be preserved, the text rendered in monospace, and any characters special
544 to the output style escaped.
547 @cindex HTML, inserting a raw block
548 There is also the @verb{|<literal>|} tag, which causes a marked block to
549 be entirely left alone. This can be used for inserting a hand-coded
550 HTML blocks into HTML output, for example.
552 @node Headings, Directives, Paragraphs, Markup Rules
553 @comment node-name, next, previous, up
554 @section Levels of headings
557 A heading becomes a chapter or section in printed output -- depending on
558 the style. To indicate a heading, start a new paragraph with one or
559 more asterices, followed by a space and the heading title. Then begin
560 another paragraph to enter the text for that section.
562 All levels of headings will be published. Most publishing styles only
563 distinguish the between the first 4 levels, however.
575 @node Directives, Emphasizing Text, Headings, Markup Rules
576 @comment node-name, next, previous, up
577 @section Directives at the beginning of a document
580 Directives are lines beginning with the @samp{#} character that come
581 before any paragraphs or sections in the document. Directives are of
582 the form ``#directive content of directive''. You can use any
583 combination of uppercase and lowercase letters for directives, even if
584 the directive is not in the list below.
586 The @code{muse-publishing-directive} function may be used in header and
587 footer text to access directives. For example, to access the
588 @samp{#title} directive, use @code{(muse-publishing-directive "title")}.
590 The following is a list of directives that Muse uses.
595 The author of this document.
597 If this is not specified, Muse will attempt to figure it out from the
598 @code{user-full-name} variable.
602 The date that the document was last modified.
604 This is used by publishing styles that are able to embed the date
609 A short description of this document.
611 This is used by the @code{journal} publishing style to embed information
612 inside of an RSS/RDF feed.
616 The title of this document.
618 If this is not specified, the name of the file is used.
622 @node Emphasizing Text, Footnotes, Directives, Markup Rules
623 @comment node-name, next, previous, up
624 @section Bold, italicized, and underlined text
625 @cindex emphasizing text
626 @cindex underlining text
627 @cindex italicizing text
628 @cindex verbatim text
629 @cindex monospace, rendering words
631 To emphasize text, surround it with certain specially recognized
637 ***very strong emphasis***
639 =verbatim and monospace=
643 While editing a Muse document in Muse mode, these forms of emphasis will
644 be highlighted in a WYSIWYG manner. Each of these forms may span
647 Verbatim text will be colored as gray by default. To change this,
648 customize @code{muse-verbatim-face}.
650 You can also use the @verb{|<code>|} tag to indicate verbatim and
651 monospace text. This is handy for regions that have an ``='' in them.
653 @node Footnotes, Verse, Emphasizing Text, Markup Rules
654 @comment node-name, next, previous, up
655 @section Making notes to be shown at the end
658 A footnote reference is simply a number in square brackets. To define
659 the footnote, place this definition at the bottom of your file.
660 @samp{footnote-mode} can be used to greatly facilitate the creation of
661 these kinds of footnotes.
663 Footnotes are defined by the same number in brackets occurring at the
664 beginning of a line. Use footnote-mode's @kbd{C-c ! a} command, to very
665 easily insert footnotes while typing. Use @kbd{C-x C-x} to return to
666 the point of insertion.
668 @node Verse, Lists, Footnotes, Markup Rules
669 @comment node-name, next, previous, up
670 @section Indicating poetic stanzas
674 Poetry requires that whitespace be preserved, but without resorting to
675 monospace. To indicate this, use the following markup, reminiscent of
679 > A line of Emacs verse;
680 > forgive its being so terse.
683 You can also use the @verb{|<verse>|} tag, if you prefer.
687 A line of Emacs verse;
688 forgive its being so terse.
692 @cindex verses, multiple stanzas
693 Multiple stanzas may be included in one set of @verb{|<verse>|} tags, as
698 A line of Emacs verse;
699 forgive its being so terse.
701 In terms of terse verse,
706 @node Lists, Tables, Verse, Markup Rules
707 @comment node-name, next, previous, up
708 @section Lists of items
711 Lists are given using special characters at the beginning of a line.
712 Whitespace must occur before bullets or numbered items, to distinguish
713 from the possibility of those characters occurring in a real sentence.
715 @cindex lists, bullets
716 These are rendered as a bullet list.
723 @cindex lists, enumerated
724 An enumerated list follows.
731 @cindex lists, definitions
732 Here is a definition list.
736 This is a first definition
737 And it has two lines;
741 This is a second definition
744 @node Tables, Explicit Links, Lists, Markup Rules
745 @comment node-name, next, previous, up
746 @section Generation of data tables
749 @cindex tables, simple
750 Only very simple tables are supported. The syntax is as follows.
753 Double bars || Separate header fields
755 Single bars | Separate body fields
756 Here are more | body fields
758 Triple bars ||| Separate footer fields
761 Some publishing styles require header fields to come first, then footer
762 fields, and then the body fields. You can use any order for these
763 sections that you like, and Muse will re-order them for you at
766 If you wish to disable table generation for one Muse file, add the
767 directive @samp{#disable-tables t} to the top of the file.
769 @node Explicit Links, Implicit Links, Tables, Markup Rules
770 @comment node-name, next, previous, up
771 @section Hyperlinks and email addresses with descriptions
772 @cindex links, explicit
774 A hyperlink can reference a URL, or another page within a Muse
775 project. In addition, descriptive text can be specified, which should
776 be displayed rather than the link text in output styles that supports
777 link descriptions. The syntax is as follows.
780 [[link target][link description]]
781 [[link target without description]]
784 Thus, the current maintainer's homepage for Muse can be found
785 @samp{[[http://www.mwolson.org/projects/EmacsMuse.html][here]]},
786 or at @samp{[[http://www.mwolson.org/projects/EmacsMuse.html]]}.
788 @node Implicit Links, Images, Explicit Links, Markup Rules
789 @comment node-name, next, previous, up
790 @section Bare URLs, WikiNames, and InterWiki links
791 @cindex links, implicit
794 @cindex Email addresses
796 A URL or email address encountered in the input text is published as a
797 hyperlink. These kind of links are called @dfn{implicit links} because
798 they are not separated from the rest of the Muse document in any way.
801 If the @command{muse-wiki} module is loaded, another form of implicit
802 link will be made available. WikiNames, which are typed in camelcase,
803 will be highlighted and published as links, provided that the file they
806 Customization of WikiName recognition may be accomplished by editing the
807 @code{muse-wiki-wikiword-regexp} option and subsequently running
808 @code{(muse-configure-highlighting 'muse-colors-markupmuse-colors-markup)}.
809 If you use the Customize interface, the latter will be done
812 @cindex InterWiki links
813 @cindex inter-project links
814 The @command{muse-wiki} module also allows for InterWiki links. These
815 are similar to WikiWords, but they specify both the project and page of
816 a file. The names of your project entries in @code{muse-project-alist}
817 will be used as InterWiki names by default. Several examples follow.
820 Blog::DocumentingMuse
825 In the first case, the interwiki delimiter is @samp{::}, @samp{Blog} is
826 the project name, and @samp{DocumentingMuse} is the page name. In the
827 second example, @samp{#} is the interwiki delimiter. If the name of a
828 project occurs by itself in text, like the third case, it will be
829 colorized and published as a link to the default page of the given
832 Customization of interwiki links may be accomplished by editing the
833 @code{muse-wiki-interwiki-alist} option.
835 @node Images, Horizontal Rules and Anchors, Implicit Links, Markup Rules
836 @comment node-name, next, previous, up
837 @section Publishing and displaying images
839 @cindex links, with images
840 @subheading Image links
842 Links to images may be used in either the target or the description, or
843 both. Thus, the following code will publish as a clickable image that
844 points to @url{http://www.mwolson.org/}.
847 [[http://www.mwolson.org/][http://www.mwolson.org/static/logos/site-logo.png]]
850 @cindex images, displaying
851 @cindex images, inlined
852 @cindex images, local
853 If a link to a locally-available image is encountered in the link
854 description, Muse mode will attempt to display it if your version of
855 Emacs permits this. The following example will display correctly and
856 publish correctly if a @acronym{PNG} file called @file{TestLogo.png}
857 exists in the @file{../pics/} directory.
860 [[TestPage][../pics/TestLogo.png]]
863 @cindex images, without a description
864 An image link is not required to have a description. The link
865 @samp{[[../myimage.png]]} will display and publish as expected.
867 @node Horizontal Rules and Anchors, Embedded Lisp, Images, Markup Rules
868 @comment node-name, next, previous, up
869 @section Inserting a horizontal line or anchor
871 @cindex horizontal rules
873 @subheading Horizontal Rules
875 Four or more dashes indicate a horizontal rule. Be sure to put blank
876 lines around it, or it will be considered part of the proceeding or
880 @cindex links, with target on same page
883 If you begin a line with "#anchor" -- where "anchor" can be any word
884 that doesn't contain whitespace -- it defines an anchor at that point
885 into the document. This point can be referenced using "page#anchor" as
886 the target in a Muse link.
888 @node Embedded Lisp, Comments, Horizontal Rules and Anchors, Markup Rules
889 @comment node-name, next, previous, up
890 @section Evaluating Emacs Lisp code in documents for extensibility
891 @cindex lisp, embedded
893 Arbitrary kinds of markup can be achieved using the @verb{|<lisp>|} tag,
894 which is the only Muse tag supported in a style's header and footer
895 text. With the @verb{|<lisp>|} tag, you may generated whatever output
896 text you wish. The inserted output will get marked up, if the
897 @verb{|<lisp>|} tag appears within the main text of the document.
900 <lisp>(concat "This form gets " "inserted")</lisp>
903 @cindex lisp, and insert command
904 Note that you should not use the @code{insert} command within a set of
905 @verb{|<lisp>|} tags, since the return value from the @verb{|<lisp>|}
906 tags will be automatically inserted into the document.
908 @node Comments, Tag Summary, Embedded Lisp, Markup Rules
909 @comment node-name, next, previous, up
910 @section Lines to omit from published output
912 @cindex publishing, omitting lines
914 Use the following syntax to indicate a comment. Comments will not be
918 ; Comment text goes here.
921 That is, only a semi-colon at the beginning of a line, followed by a
922 literal space, will cause that line to be treated as a comment.
924 @node Tag Summary, , Comments, Markup Rules
925 @comment node-name, next, previous, up
926 @section Tags that Muse recognizes
928 @cindex inserting files at publish time
929 @cindex publishing, including markup in headers and footers
930 @cindex publishing, inserting files
932 Muse has several built-in tags that may prove useful during publishing.
933 @xref{muse-publish-markup-tags}, to see how to customize the tags that
934 Muse uses, as well as make your own tags.
938 If a tag takes arguments, it will look like this, where ``tagname'' is
942 <tagname arg1="string1" arg2="string2">
945 If you want the tag to look like it came straight from an XHTML
946 document, you can alternatively do the following.
949 <tagname arg1="string1" arg2="string2" />
952 If a tag surrounds some text, it will look like this.
955 <tagname>Some text</tagname>
958 If a tag surrounds a large region, it will look like this.
967 @subheading Tag listing
969 This is the complete list of tags that Muse accepts, including those
970 that were mentioned in previous sections.
975 If publishing to HTML, surround the given text with a @verb{|<span>|}
976 tag. It takes one argument called ``name'' that specifies the class
977 attribute of the @verb{|<span>|} tag.
979 If publishing to a different format, do nothing extra to the text.
982 Treat the text surrounded by the tag as if they were enclosed in equal
983 signs, that is, make it monospace.
986 Run a command on the region, replacing the region with the result of the
987 command. The command is specified with the ``interp'' argument. If no
988 value for ``interp'' is given, pass the entire region to the shell.
991 Treat the entire region as a comment. If the option
992 @var{muse-publish-comments-p} is nil, delete the region, otherwise
993 publish it using the comment syntax of the current publishing style.
996 Publish a Table of Contents. This will either be inserted in-place or
997 at the beginning of the document, depending on your publishing style.
998 It does not have a delimiting tag.
1000 By default, only 2 levels of headings will be included in the generated
1001 Table of Contents. To change this globally, customize the
1002 @var{muse-publish-contents-depth} option. To change this only for the
1003 current tag, use the ``depth'' argument.
1006 Publish the region in monospace, preserving the newlines in the region.
1007 This is useful for snippets of code.
1010 Insert the given file at the current location during publishing. The
1011 basic use of this tag is as follows, replacing ``included_file'' with
1012 the name of the file that you want to include.
1015 <include file="included_file">
1018 The ``markup'' attribute controls how this section is marked up.
1019 If it is omitted, publish the included text with the normal Muse
1022 If "nil", do not mark up the included text at all.
1024 If "example", treat the included text as if it was surrounded by the
1025 @verb{|<example>|} tag.
1027 If "verse", treat the included text as if it was surrounded by the
1028 @verb{|<verse>|} tag, to preserve newlines.
1030 Otherwise, it should be the name of a function to call after inserting
1031 the file with the buffer narrowed to the section inserted.
1034 Evaluate the Emacs Lisp expressions between the initial and ending tags.
1035 The result is then inserted into the document, so you do not need to
1036 explicitly call @code{insert}. All text properties are removed from the
1040 Make sure that the text enclosed by this tag is published without
1041 escaping it in any way. This is useful for inserting markup directly
1042 into the published document, when Muse does not provide the desired
1046 Mark up the text between the initial and ending tags. The markup
1047 command to use may be specified by the ``function'' argument. The
1048 standard Muse markup routines are used by default if no ``function''
1049 argument is provided.
1051 This is useful for marking up regions in headers and footers. One
1052 example that comes to mind is generating a published index of all of the
1053 files in the current project by doing the following.
1056 <markup><lisp>(muse-index-as-string t t)</lisp></markup>
1060 Publish the region as a blockquote. This will either be inserted
1061 in-place or at the beginning of the document, depending on your
1062 publishing style. It does not have a delimiting tag.
1065 This is used when you want to prevent Muse from trying to interpret some
1066 markup. Surround the markup in @verb{|<verbatim>|} and
1067 @verb{|</verbatim>|}, and it will not be interpreted.
1069 This tag was used often in previous versions of Muse because they did
1070 not support whole-document escaping of specials. Now, it will only be
1071 needed for other tags, and perhaps footnotes as well.
1074 Preserve the newlines in the region. In formats like HTML, newlines are
1075 removed by default, hence the need for this tag. In other publishing
1076 styles, this tag may cause the text to be indented slightly in a way
1077 that looks nice for poetry and prose.
1081 @node Publishing Styles, Extending Muse, Markup Rules, Top
1082 @comment node-name, next, previous, up
1083 @chapter Publishing Various Types of Documents
1084 @cindex publishing styles
1086 One of the principle features of Muse is the ability to publish a simple
1087 input text to a variety of different output styles. Muse also makes it
1088 easy to create new styles, or derive from an existing style.
1091 * Blosxom:: Integrating Muse and pyblosxom.cgi.
1092 * Book:: Publishing entries into a compilation.
1093 * DocBook:: Publishing in DocBook XML form.
1094 * HTML:: Publishing in HTML or XHTML form.
1095 * Journal:: Keeping a journal or blog.
1096 * LaTeX:: Publishing LaTeX documents.
1097 * Poem:: Publish a poem to LaTex or PDF.
1098 * Texinfo:: Publish entries to Texinfo format or PDF.
1101 @node Blosxom, Book, Publishing Styles, Publishing Styles
1102 @comment node-name, next, previous, up
1103 @section Integrating Muse and pyblosxom.cgi
1104 @cindex blog, one-file-per-entry style
1106 The Blosxom publishing style publishes a tree of categorised files to a
1107 mirrored tree of stories to be served by blosxom.cgi or pyblosxom.cgi.
1108 In other words, each blog entry corresponds with one file.
1111 * Blosxom Requirements:: Other tools needed to the Blosxom style.
1112 * Blosxom Entries:: Format of a Blosxom entry and automation.
1113 * Blosxom Options:: Blosxom styles and options provided.
1116 @node Blosxom Requirements, Blosxom Entries, Blosxom, Blosxom
1117 @comment node-name, next, previous, up
1118 @subsection Other tools needed to the Blosxom style
1120 You will need to have @command{pyblosxom.cgi} or @command{blosxom.cgi}
1121 installed on a machine that you have upload access to.
1123 The following additional components are required in order to make the
1124 date of blog entries display as something sensible.
1128 A script to gather date directives from the entire blog tree into a
1129 single file. The file must associate a blog entry with a date.
1132 A plugin for (py)blosxom that reads this file.
1135 These 2 things are provided for @command{pyblosxom.cgi} in the
1136 @file{contrib/pyblosxom} subdirectory. @file{getstamps.py} provides the
1137 former service, while @file{hardcodedates.py} provides the latter
1138 service. Eventually it is hoped that a @command{blosxom.cgi} plugin and
1139 script will be found/written.
1141 Here is a sample listing from my @file{timestamps} file, which maps
1142 each file to a date. This can really be in any format, as long as your
1143 date-gathering script and your plugin can both understand it.
1146 2005-04-01-14-16 personal/paper_cranes
1147 2005-03-21 personal/spring_break_over
1148 2004-10-24 personal/finished_free_culture
1151 The script @file{contrib/pyblosxom/make-blog} demonstrates how to call
1152 @file{getstamps.py}. Note that you will need to set the current
1153 directory to where your Muse files are, execute @file{getstamps.py}, and
1154 then move the generated timestamps file to your publishing directory.
1156 @node Blosxom Entries, Blosxom Options, Blosxom Requirements, Blosxom
1157 @comment node-name, next, previous, up
1158 @subsection Format of a Blosxom entry and automation
1160 Each Blosxom file must include `#date yyyy-mm-dd', or optionally the
1161 longer `#date yyyy-mm-dd-hh-mm', a title (using the #title directive),
1162 plus whatever normal content is desired.
1164 The date directive is not used directly by @command{pyblosxom.cgi} or
1165 this program. You need to have the two additional items from the former
1166 section to make use of this feature.
1168 There is a function called @code{muse-blosxom-new-entry} that will
1169 automate the process of making a new blog entry. To make use of it, do
1174 Customize @code{muse-blosxom-base-directory} to the location that your
1175 blog entries are stored.
1178 Assign the @code{muse-blosxom-new-entry} function to a key sequence. I
1179 use the following code to assign this function to @kbd{C-c p l'}.
1182 (global-set-key "\C-cpl" 'muse-blosxom-new-entry)
1186 You should create your directory structure ahead of time under your base
1187 directory. These directories, which correspond with category names, may
1191 When you enter this key sequence, you will be prompted for the category
1192 of your entry and its title. Upon entering this information, a new file
1193 will be created that corresponds with the title, but in lowercase
1194 letters and having special characters converted to underscores. The
1195 title and date directives will be inserted automatically.
1198 @node Blosxom Options, , Blosxom Entries, Blosxom
1199 @comment node-name, next, previous, up
1200 @subsection Blosxom styles and options provided
1202 The following styles and options are available in the Blosxom publishing
1205 @subheading Styles provided
1209 @cindex publishing styles, blosxom-html
1211 Publish Blosxom entries in HTML form.
1213 @cindex publishing styles, blosxom-xhtml
1215 Publish Blosxom entries in XHTML form.
1219 @subheading Options provided
1223 @item muse-blosxom-extension
1224 Default file extension for publishing Blosxom files.
1226 @item muse-blosxom-header
1227 Header used for publishing Blosxom files.
1229 This may be text or a filename.
1231 @item muse-blosxom-footer
1232 Footer used for publishing Blosxom files.
1234 This may be text or a filename.
1236 @item muse-blosxom-base-directory
1237 Base directory of blog entries, used by @code{muse-blosxom-new-entry}.
1239 This is the top-level directory where your blog entries may be found
1244 @node Book, DocBook, Blosxom, Publishing Styles
1245 @comment node-name, next, previous, up
1246 @section Publishing entries into a compilation
1248 This publishing style is used to output ``books'' in LaTeX or PDF
1251 Each page will become a separate chapter in the book, unless the style
1252 keyword @option{:nochapters} is used, in which case they are all run
1253 together as if one giant chapter.
1255 You will need to call the @code{muse-book-publish-project} function in
1256 order to publish this style. An example of this may be found in John
1257 Wiegley's configuration file at @file{examples/johnw/muse-johnw.el}.
1259 @subheading Styles provided
1263 @cindex publishing styles, book-latex
1265 Publish a book in LaTeX form. The header and footer are different than
1266 the normal LaTeX publishing mode.
1268 @cindex publishing styles, book-pdf
1270 Publish a book in PDF form. The header and footer are different than
1271 the normal PDF publishing mode.
1275 @subheading Options provided
1279 @item muse-book-before-publish-hook
1280 A hook run in the book buffer before it is marked up.
1282 @item muse-book-after-publish-hook
1283 A hook run in the book buffer after it is marked up.
1285 @item muse-book-latex-header
1286 Header used for publishing books to LaTeX.
1288 This may be text or a filename.
1290 @item muse-book-latex-footer
1291 Footer used for publishing books to LaTeX.
1293 This may be text or a filename.
1297 @node DocBook, HTML, Book, Publishing Styles
1298 @comment node-name, next, previous, up
1299 @section Publishing in DocBook XML form
1301 This publishing style is used to generate DocBook XML files.
1303 @subheading Styles provided
1307 @cindex publishing styles, docbook
1312 @subheading Options provided
1316 @item muse-docbook-extension
1317 Default file extension for publishing DocBook XML files.
1319 @item muse-docbook-header
1320 Header used for publishing DocBook XML files.
1322 This may be text or a filename.
1324 @item muse-docbook-footer
1325 Footer used for publishing DocBook XML files.
1327 This may be text or a filename.
1329 @item muse-docbook-markup-regexps
1330 List of markup rules for publishing a Muse page to DocBook XML.
1332 @item muse-docbook-markup-functions
1333 An alist of style types to custom functions for that kind of text.
1335 @item muse-docbook-markup-strings
1336 Strings used for marking up text.
1338 These cover the most basic kinds of markup, the handling of which
1339 differs little between the various styles.
1341 @item muse-docbook-markup-specials
1342 A table of characters which must be represented specially.
1344 @item muse-docbook-encoding-default
1345 The default Emacs buffer encoding to use in published files.
1346 This will be used if no special characters are found.
1348 @item muse-docbook-charset-default
1349 The default DocBook XML charset to use if no translation is
1350 found in @code{muse-docbook-encoding-map}.
1352 @item muse-docbook-encoding-map
1353 An alist mapping emacs coding systems to appropriate DocBook charsets.
1354 Use the base name of the coding system (i.e. without the -unix).
1358 @node HTML, Journal, DocBook, Publishing Styles
1359 @comment node-name, next, previous, up
1360 @section Publishing in HTML or XHTML form
1362 This publishing style is capable of producing HTML or XHTML documents.
1364 @subheading Styles provided
1368 @cindex publishing styles, html
1370 Supports publishing to HTML 4.0 and HTML 4.01, Strict or Transitional.
1373 Supports publishing to XHTML 1.0 and XHTML 1.1, Strict or Transitional.
1377 @subheading Options provided
1379 If an HTML option does not have a corresponding XHTML option, it will
1380 be used for both of these publishing styles.
1384 @item muse-html-extension
1385 Default file extension for publishing HTML files.
1387 @item muse-xhtml-extension
1388 Default file extension for publishing XHTML files.
1390 @item muse-html-style-sheet
1391 Store your stylesheet definitions here.
1393 This is used in @code{muse-html-header}. You can put raw CSS in here or
1394 a @verb{|<link>|} tag to an external stylesheet. This text may contain
1395 @verb{|<lisp>|} markup tags.
1397 If you are using XHTML, make sure to close the @verb{|<link>|} tag
1400 @item muse-html-header
1401 Header used for publishing HTML files.
1403 This may be text or a filename.
1405 @item muse-html-footer
1406 Footer used for publishing HTML files.
1408 This may be text or a filename.
1410 @item muse-xhtml-header
1411 Header used for publishing XHTML files.
1413 This may be text or a filename.
1415 @item muse-xhtml-footer
1416 Footer used for publishing XHTML files.
1418 This may be text or a filename.
1420 @item muse-html-anchor-on-word
1421 When true, anchors surround the closest word.
1423 This allows you to select them in a browser (i.e. for pasting), but has
1424 the side-effect of marking up headers in multiple colors if your header
1425 style is different from your link style.
1427 @item muse-html-table-attributes
1428 The attribute to be used with HTML @verb{|<table>|} tags.
1430 If you want to make more-complicated tables in HTML, surround the HTML
1431 with the @verb{|literal|} tag, so that it does not get escaped.
1433 @item muse-html-markup-regexps
1434 List of markup rules for publishing a Muse page to HTML.
1436 @item muse-html-markup-functions
1437 An alist of style types to custom functions for that kind of text.
1439 @item muse-html-markup-strings
1440 Strings used for marking up text as HTML.
1442 These cover the most basic kinds of markup, the handling of which
1443 differs little between the various styles.
1445 @item muse-xhtml-markup-strings
1446 Strings used for marking up text as XHTML.
1448 These cover the most basic kinds of markup, the handling of which
1449 differs little between the various styles.
1451 @item muse-html-markup-tags
1452 A list of tag specifications, for specially marking up HTML.
1453 @xref{muse-publish-markup-tags}, for more information.
1455 @item muse-html-markup-specials
1456 A table of characters which must be represented specially. By default,
1457 this includes @samp{"}, @samp{<}, @samp{>}, and @samp{&}.
1459 @item muse-html-meta-http-equiv
1460 The http-equiv attribute used for the HTML @verb{|<meta>|} tag.
1462 @item muse-html-meta-content-type
1463 The content type used for the HTML @verb{|<meta>|} tag.
1465 If you are striving for XHTML 1.1 compliance, you may want to change
1466 this to ``application/xhtml+xml''.
1468 @item muse-html-meta-content-encoding
1469 The charset to append to the HTML @verb{|<meta>|} tag.
1471 If set to the symbol 'detect, use @code{muse-html-encoding-map} to try
1472 and determine the HTML charset from emacs's coding. If set to a string,
1473 this string will be used to force a particular charset.
1475 @item muse-html-charset-default
1476 The default HTML meta charset to use if no translation is found in
1477 @code{muse-html-encoding-map}.
1479 @item muse-html-encoding-default
1480 The default Emacs buffer encoding to use in published files.
1481 This will be used if no special characters are found.
1483 @item muse-html-encoding-map
1484 An alist mapping emacs coding systems to appropriate HTML charsets.
1485 Use the base name of the coding system (i.e. without the -unix).
1489 @node Journal, LaTeX, HTML, Publishing Styles
1490 @comment node-name, next, previous, up
1491 @section Keeping a journal or blog
1493 @cindex blog, journal style
1495 The module facilitates the keeping and publication of a journal. When
1496 publishing to HTML, it assumes the form of a web log, or blog.
1498 The input format for each entry is as follows.
1501 * 20040317: Title of entry
1506 "You know who you are. It comes down to a simple gut check: You
1507 either love what you do or you don't. Period." -- P. Bronson
1511 The "qotd", or Quote of the Day, is entirely optional. When generated
1512 to HTML, this entry is rendered as the following.
1516 <div class="entry-qotd">
1517 <h3>Quote of the Day:</h3>
1518 <p>"You know who you are. It comes down to a simple gut
1519 check: You either love what you do or you don't. Period."
1522 <div class="entry-body">
1523 <div class="entry-head">
1524 <div class="entry-date">
1525 <span class="date">March 17, 2004</span>
1527 <div class="entry-title">
1528 <h2>Title of entry</h2>
1531 <div class="entry-text">
1532 <p>Text for the entry.</p>
1538 The plurality of "div" tags makes it possible to display the entries in
1539 any form you wish, using a CSS style.
1541 Also, an .RDF file can be generated from your journal by publishing it
1542 with the "rdf" style. It uses the first two sentences of the first
1543 paragraph of each entry as its "description", and auto-generates tags
1544 for linking to the various entries.
1546 @subheading Styles provided
1550 @cindex publishing styles, journal-html
1552 Publish journal entries as an HTML document.
1554 @cindex publishing styles, journal-xhtml
1556 Publish journal entries as an XHTML document.
1558 @cindex publishing styles, journal-latex
1560 Publish journal entries as a LaTeX document.
1562 @cindex publishing styles, journal-pdf
1564 Publish journal entries as a PDF document.
1566 @cindex publishing styles, journal-book-latex
1567 @item journal-book-latex
1568 Publish journal entries as a LaTeX book.
1570 @cindex publishing styles, journal-book-pdf
1571 @item journal-book-pdf
1572 Publish journal entries as a PDF book.
1574 @cindex publishing styles, journal-rdf
1575 @cindex publishing styles, RSS 1.0
1577 Publish journal entries as an RDF file (RSS 1.0).
1579 @cindex publishing styles, journal-rss
1580 @cindex publishing styles, RSS 2.0
1582 Publish journal entries as an RSS file (RSS 2.0).
1586 @subheading Options provided
1590 @item muse-journal-heading-regexp
1591 A regexp that matches a journal heading.
1593 Paren group 1 is the ISO date, group 2 is the optional category, and
1594 group 3 is the optional heading for the entry.
1596 @item muse-journal-date-format
1597 Date format to use for journal entries.
1599 @item muse-journal-html-heading-regexp
1600 A regexp that matches a journal heading from an HTML document.
1602 Paren group 1 is the ISO date, group 2 is the optional category, and
1603 group 3 is the optional heading for the entry.
1605 @item muse-journal-html-entry-template
1606 Template used to publish individual journal entries as HTML.
1608 @item muse-journal-latex-section
1609 Template used to publish a LaTeX section.
1611 @item muse-journal-latex-subsection
1612 Template used to publish a LaTeX subsection.
1614 @item muse-journal-latex-markup-tags
1615 A list of tag specifications, for specially marking up LaTeX.
1617 @xref{muse-publish-markup-tags}, for more information.
1619 @item muse-journal-rdf-extension
1620 Default file extension for publishing RDF (RSS 1.0) files.
1622 @item muse-journal-rdf-base-url
1623 The base URL of the website referenced by the RDF file.
1625 @item muse-journal-rdf-header
1626 Header used for publishing RDF (RSS 1.0) files.
1628 This may be text or a filename.
1630 @item muse-journal-rdf-footer
1631 Footer used for publishing RDF (RSS 1.0) files.
1633 This may be text or a filename.
1635 @item muse-journal-rdf-date-format
1636 Date format to use for RDF entries.
1638 @item muse-journal-rdf-entry-template
1639 Template used to publish individual journal entries as RDF.
1641 @item muse-journal-rdf-summarize-entries
1642 If non-nil, include only summaries in the RDF file, not the full data.
1644 @item muse-journal-rss-extension
1645 Default file extension for publishing RSS 2.0 files.
1647 @item muse-journal-rss-base-url
1648 The base URL of the website referenced by the RSS file.
1650 @item muse-journal-rss-header
1651 Header used for publishing RSS 2.0 files.
1653 This may be text or a filename.
1655 @item muse-journal-rss-footer
1656 Footer used for publishing RSS 2.0 files.
1658 This may be text or a filename.
1660 @item muse-journal-rss-date-format
1661 Date format to use for RSS 2.0 entries.
1663 @item muse-journal-rss-entry-template
1664 Template used to publish individual journal entries as RSS 2.0.
1666 @item muse-journal-rss-enclosure-types-alist
1667 File types that are accepted as RSS enclosures.
1669 This is an alist that maps file extension to content type.
1671 Useful for podcasting.
1673 @item muse-journal-rss-summarize-entries
1674 If non-nil, include only summaries in the RSS file, not the full data.
1676 Many RSS subscribers find this annoying.
1678 @item muse-journal-rss-markup-regexps
1679 List of markup rules for publishing a Muse journal page to RSS.
1681 For more information on the structure of this list,
1682 @xref{muse-publish-markup-regexps}.
1684 @item muse-journal-rss-markup-functions
1685 An alist of style types to custom functions for that kind of text.
1687 For more on the structure of this list,
1688 @xref{muse-publish-markup-functions}.
1692 @node LaTeX, Poem, Journal, Publishing Styles
1693 @comment node-name, next, previous, up
1694 @section Publishing LaTeX documents
1696 This publishing style is capable of producing LaTeX or PDF documents.
1698 If you wish to publish PDF documents, you will need to have a good TeX
1699 installation. For Debian, this can be accomplished by installing the
1700 ``tetex-bin'' and ``tetex-extra'' packages. TeX fonts are also a must.
1702 @subheading Styles provided
1706 @cindex publishing styles, latex
1708 Publish a LaTeX document.
1710 @cindex publishing styles, pdf
1712 Publish a PDF document, using an external LaTeX document conversion
1715 @cindex publishing styles, latexcjk
1717 Publish a LaTeX document with CJK (Chinese) encodings.
1719 @cindex publishing styles, pdfcjk
1721 Publish a PDF document with CJK (Chinese) encodings, using an external
1722 LaTeX document conversion tool.
1726 @subheading Options provided
1730 @item muse-latex-extension
1731 Default file extension for publishing LaTeX files.
1733 @item muse-latex-pdf-extension
1734 Default file extension for publishing LaTeX files to PDF.
1736 @item muse-latex-header
1737 Header used for publishing LaTeX files.
1739 This may be text or a filename.
1741 @item muse-latex-footer
1742 Footer used for publishing LaTeX files.
1744 This may be text or a filename.
1746 @item muse-latexcjk-header
1747 Header used for publishing LaTeX files (CJK).
1749 This may be text or a filename.
1751 @item muse-latexcjk-footer
1752 Footer used for publishing LaTeX files (CJK).
1754 This may be text or a filename.
1756 @item muse-latex-markup-regexps
1757 List of markup regexps for identifying regions in a Muse page.
1759 For more on the structure of this list,
1760 @xref{muse-publish-markup-regexps}.
1762 @item muse-latex-markup-functions
1763 An alist of style types to custom functions for that kind of text.
1765 For more on the structure of this list,
1766 @xref{muse-publish-markup-functions}.
1768 @item muse-latex-markup-strings
1769 Strings used for marking up text.
1771 These cover the most basic kinds of markup, the handling of which
1772 differs little between the various styles.
1774 @item muse-latexcjk-encoding-map
1775 An alist mapping emacs coding systems to appropriate CJK codings.
1776 Use the base name of the coding system (ie, without the -unix).
1778 @item muse-latexcjk-encoding-default
1779 The default Emacs buffer encoding to use in published files.
1781 This will be used if no special characters are found.
1783 @item muse-latex-markup-specials-example
1784 A table of characters which must be represented specially.
1785 These are applied to @verb{|example>|} regions.
1787 With the default interpretation of @verb{|<example>|} regions, no
1788 specials need to be escaped.
1790 @item muse-latex-markup-specials-document
1791 A table of characters which must be represented specially.
1792 These are applied to the entire document, sans already-escaped
1795 @item muse-latex-markup-specials-literal
1796 A table of characters which must be represented specially.
1797 This applies to =monospaced text= and @verb{|<code>|} regions.
1799 @item muse-latex-markup-specials-url
1800 A table of characters which must be represented specially.
1801 These are applied to URLs.
1803 @item muse-latex-permit-contents-tag
1804 If nil, ignore @verb{|<contents>|} tags. Otherwise, insert table of
1807 Most of the time, it is best to have a table of contents on the
1808 first page, with a new page immediately following. To make this
1809 work with documents published in both HTML and LaTeX, we need to
1810 ignore the @verb{|<contents>|} tag.
1812 If you don't agree with this, then set this option to non-nil,
1813 and it will do what you expect.
1817 @node Poem, Texinfo, LaTeX, Publishing Styles
1818 @comment node-name, next, previous, up
1819 @section Publish a poem to LaTex or PDF
1821 The @code{muse-poem} module makes it easy to attractively publish and
1822 reference poems in the following format, using the "memoir" module for
1823 LaTeX publishing. It will also markup poems for every other output
1824 style, though none are nearly as pretty.
1833 Annotations, history, notes, etc.
1836 Once a poem is written in this format, just publish it to PDF using the
1837 @code{poem-pdf} style. To make an inlined reference to a poem that
1838 you've written -- for example, from a blog page -- there is a "poem" tag
1839 defined by this module.
1842 <poem title="name.of.poem.page">
1845 Let's assume the template above was called @file{name.of.poem.page};
1846 then the above tag would result in this inclusion.
1854 John Wiegley uses this module for publishing all of the poems on his
1855 website, which are at
1856 @uref{http://www.newartisans.com/johnw/poems.html}.
1858 @subheading Styles provided
1862 @cindex publishing styles, poem-latex
1864 Publish a poem in LaTeX form.
1866 @cindex publishing styles, poem-pdf
1868 Publish a poem to a PDF document.
1870 @cindex publishing styles, chapbook-latex
1871 @item chapbook-latex
1872 Publish a book of poems in LaTeX form.
1874 @cindex publishing styles, chapbook-pdf
1876 Publish a book of poems to a PDF document.
1880 @subheading Options provided
1884 @item muse-poem-latex-header
1885 Header used for publishing LaTeX poems.
1887 This may be text or a filename.
1889 @item muse-poem-latex-footer
1890 Footer used for publishing LaTeX files.
1892 This may be text or a filename.
1894 @item muse-poem-markup-strings
1895 Strings used for marking up poems.
1897 These cover the most basic kinds of markup, the handling of which
1898 differs little between the various styles.
1900 @item muse-chapbook-latex-header
1901 Header used for publishing a book of poems in LaTeX form.
1903 This may be text or a filename.
1905 @item muse-chapbook-latex-footer
1906 Footer used for publishing a book of poems in LaTeX form.
1908 This may be text or a filename.
1910 @item muse-poem-chapbook-strings
1911 Strings used for marking up books of poems.
1913 These cover the most basic kinds of markup, the handling of which
1914 differs little between the various styles.
1918 @node Texinfo, , Poem, Publishing Styles
1919 @comment node-name, next, previous, up
1920 @section Publish entries to Texinfo format or PDF
1922 Rules for publishing a Muse file as a Texinfo article.
1924 @subheading Styles provided
1928 @cindex publishing styles, texi
1930 Publish a file in Texinfo form.
1932 @cindex publishing styles, texi
1934 Generate an Info file from a Muse file.
1936 @cindex publishing styles, info-pdf
1938 Publish a file in PDF form.
1942 @subheading Options provided
1946 @item muse-texinfo-process-natively
1947 If non-nil, use the Emacs `texinfmt' module to make Info files.
1949 @item muse-texinfo-extension
1950 Default file extension for publishing Texinfo files.
1952 @item muse-texinfo-info-extension
1953 Default file extension for publishing Info files.
1955 @item muse-texinfo-pdf-extension
1956 Default file extension for publishing PDF files.
1958 @item muse-texinfo-header
1959 Text to prepend to a Muse page being published as Texinfo.
1961 This may be text or a filename.
1962 It may contain @verb{|<lisp>|} markup tags.
1964 @item muse-texinfo-footer
1965 Text to append to a Muse page being published as Texinfo.
1967 This may be text or a filename.
1968 It may contain @verb{|<lisp>|} markup tags.
1970 @item muse-texinfo-markup-regexps
1971 List of markup rules for publishing a Muse page to Texinfo.
1973 For more on the structure of this list,
1974 @xref{muse-publish-markup-regexps}.
1976 @item muse-texinfo-markup-functions
1977 An alist of style types to custom functions for that kind of text.
1979 For more on the structure of this list, see
1980 @xref{muse-publish-markup-functions}.
1982 @item muse-texinfo-markup-strings
1983 Strings used for marking up text.
1985 These cover the most basic kinds of markup, the handling of which
1986 differs little between the various styles.
1988 @item muse-texinfo-markup-specials
1989 A table of characters which must be represented specially.
1994 @node Extending Muse, Getting Help and Reporting Bugs, Publishing Styles, Top
1995 @comment node-name, next, previous, up
1996 @chapter Making your own publishing styles
1999 * Common Elements:: Common functionality shared by styles.
2000 * Deriving Styles:: Deriving a new style from an existing
2004 @node Common Elements, Deriving Styles, , Extending Muse
2005 @comment node-name, next, previous, up
2006 @section Common functionality shared by styles
2007 @cindex publishing styles, common
2010 * Markup Functions:: Specifying functions to marking up text.
2011 * Markup Regexps:: Markup rules for publishing.
2012 * Markup Strings:: Strings specific to a publishing style.
2013 * Markup Tags:: Tag specifications for special markup.
2014 * Style Elements:: Parameters used for defining styles.
2017 @node Markup Functions, Markup Regexps, , Common Elements
2018 @comment node-name, next, previous, up
2019 @subsection Specifying functions to mark up text
2020 @cindex publishing, markup functions
2022 @anchor{muse-publish-markup-functions}
2023 @code{muse-publish-markup-functions}
2025 An alist of style types to custom functions for that kind of text.
2027 This is used by publishing styles to attempt to minimize the amount of
2028 custom regexps that each has to define. @file{muse-publish} provides
2029 rules for the most common types of markup.
2031 Each member of the list is of the following form.
2039 Describes the type of text to associate with this rule.
2040 @code{muse-publish-markup-regexps} maps regexps to these symbols.
2043 Function to use to mark up this kind of rule if no suitable function is
2044 found through the @option{:functions} tag of the current style.
2047 @node Markup Regexps, Markup Strings, Markup Functions, Common Elements
2048 @comment node-name, next, previous, up
2049 @subsection Markup rules for publishing
2050 @cindex publishing, markup regexps
2051 @cindex publishing, rules
2053 @anchor{muse-publish-markup-regexps}
2054 @code{muse-publish-markup-regexps}
2056 List of markup rules for publishing a page with Muse.
2058 The rules given in this variable are invoked first, followed by whatever
2059 rules are specified by the current style.
2061 Each member of the list is either a function, or a list of the following
2065 (REGEXP/SYMBOL TEXT-BEGIN-GROUP REPLACEMENT-TEXT/FUNCTION/SYMBOL)
2070 A regular expression, or symbol whose value is a regular expression,
2071 which is searched for using `re-search-forward'.
2073 @item TEXT-BEGIN-GROUP
2074 The matching group within that regexp which denotes the beginning of the
2075 actual text to be marked up.
2077 @item REPLACEMENT-TEXT
2078 A string that will be passed to `replace-match'.
2080 If it is not a string, but a function, it will be called to determine
2081 what the replacement text should be (it must return a string). If it is
2082 a symbol, the value of that symbol should be a string.
2085 The replacements are done in order, one rule at a time. Writing
2086 the regular expressions can be a tricky business. Note that case
2087 is never ignored. `case-fold-search' is always bound to nil
2088 while processing the markup rules.
2090 @subheading Publishing order
2092 This is the order that the publishing rules are consulted, by default.
2093 This may be changed by customizing @code{muse-publish-markup-regexps}.
2097 @item trailing and leading whitespace
2098 Remove trailing and leading whitespace from a file.
2103 This is only recognized at the beginning of a file.
2114 @item explicit links
2115 Prevent emphasis characters in explicit links from being marked up.
2117 Don't actually publish them here, just add a special no-emphasis text
2121 Whitespace-delimited word, possibly with emphasis characters
2123 This function is responsible for marking up emphasis and escaping some
2134 Outline-mode style headings.
2139 These are ellipses with a dot at end.
2149 Horizontal rule or section separator.
2154 beginning of footnotes section
2159 Footnote definition or reference. If at beginning of line, it is a
2174 Numbered list, item list, or term definition list.
2177 spaces before beginning of text
2185 @samp{table | cells}
2188 @samp{[[explicit][links]]}
2191 @samp{http://example.com/}
2194 @samp{bare-email@@example.com}
2198 @node Markup Strings, Markup Tags, Markup Regexps, Common Elements
2199 @comment node-name, next, previous, up
2200 @subsection Strings specific to a publishing style
2201 @cindex publishing, markup strings
2203 @dfn{Markup strings} are strings used for marking up text for a
2206 These cover the most basic kinds of markup, the handling of which
2207 differs little between the various styles.
2209 @subheading Available markup strings
2213 @item image-with-desc
2214 An image and a description.
2216 Argument 1: image. Argument 2: description.
2221 Argument 1: image link.
2223 @item url-with-image
2224 A URL with an image.
2226 Argument 1: link. Argument 2: image.
2229 A link with a description.
2231 Argument 1: link. Argument 2: description if one exists, or the
2232 original link otherwise.
2235 A link that refers to an internal anchor.
2237 Argument 1: internal link. Argument 2: description if one exists, or
2238 the original link otherwise.
2241 A link to an email address.
2243 Argument 1: email address. Argument 2: email address.
2249 A horizontal line or space.
2252 Beginning of footnote.
2258 Mark a reference for the current footnote.
2260 Argument 1: number of this footnote.
2263 Indicate the text of the current footnote.
2265 Argument 1: number of this footnote.
2267 @item footnotetext-end
2268 End of a footnote text line.
2271 Text used to replace ``Footnotes:'' line.
2280 Beginning of a part indicator line. This is used by book publishing.
2283 End of a part indicator line. This is used by book publishing.
2286 Beginning of a chapter indicator line. This is used by book publishing.
2289 End of a chapter indicator line. This is used by book publishing.
2292 Beginning of level 1 section indicator line.
2294 Argument 1: level of section; always 1.
2297 End of level 1 section indicator line.
2299 Argument 1: level of section; always 1.
2302 Beginning of level 2 section indicator line.
2304 Argument 1: level of section; always 2.
2306 @item subsection-end
2307 End of level 2 section indicator line.
2309 Argument 1: level of section; always 2.
2312 Beginning of level 3 section indicator line.
2314 Argument 1: level of section; always 3.
2316 @item subsubsection-end
2317 End of level 3 section indicator line.
2319 Argument 1: level of section; always 3.
2322 Beginning of section indicator line, where level is greater than 3.
2324 Argument 1: level of section.
2326 @item section-other-end
2327 Beginning of section indicator line, where level is greater than 3.
2329 Argument 1: level of section.
2331 @item begin-underline
2332 Beginning of underlined text.
2335 End of underlined text.
2338 Beginning of verbatim text. This includes @verb{|<code>|} tags and
2342 End of verbatim text. This includes @verb{|<code>|} tags and =teletype
2346 Beginning of the first level of emphasized text.
2349 End of the first level of emphasized text.
2351 @item begin-more-emph
2352 Beginning of the second level of emphasized text.
2355 End of the second level of emphasized text.
2357 @item begin-most-emph
2358 Beginning of the third (and final) level of emphasized text.
2361 End of the third (and final) level of emphasized text.
2364 Beginning of verse text.
2367 String used to each space that is further indented than the beginning of
2370 @item begin-verse-line
2371 Beginning of a line of verse.
2373 @item empty-verse-line
2374 End of a line of verse.
2376 @item begin-last-stanza-line
2377 Beginning of the last line of a verse stanza.
2379 @item end-last-stanza-line
2380 End of the last line of a verse stanza.
2386 Beginning of an example region. To make use of this, an
2387 @samp{<example>} tag is needed.
2390 End of an example region. To make use of this, an @samp{</example>} tag
2394 Begin a centered line.
2397 End a centered line.
2400 Begin a quoted region.
2403 End a quoted region.
2406 Begin an unordered list.
2409 End an unordered list.
2412 Begin an ordered list.
2415 End an ordered list.
2418 Begin a definition list.
2421 Begin a term in a definition list.
2424 End a definition list.
2428 @node Markup Tags, Style Elements, Markup Strings, Common Elements
2429 @comment node-name, next, previous, up
2430 @subsection Tag specifications for special markup
2431 @cindex publishing, markup tags
2433 @anchor{muse-publish-markup-tags}
2434 @code{muse-publish-markup-tags}
2436 A list of tag specifications, for specially marking up text.
2438 XML-style tags are the best way to add custom markup to Muse. This is
2439 easily accomplished by customizing this list of markup tags.
2441 For each entry, the name of the tag is given, whether it expects a
2442 closing tag and/or an optional set of attributes, and a function that
2443 performs whatever action is desired within the delimited region.
2445 The tags themselves are deleted during publishing, before the function
2446 is called. The function is called with three arguments, the beginning
2447 and end of the region surrounded by the tags. If properties are
2448 allowed, they are passed as a third argument in the form of an alist.
2449 The `end' argument to the function is always a marker.
2451 Point is always at the beginning of the region within the tags, when the
2452 function is called. Wherever point is when the function finishes is
2453 where tag markup will resume.
2455 These tag rules are processed once at the beginning of markup, and once
2456 at the end, to catch any tags which may have been inserted in-between.
2458 @node Style Elements, , Markup Tags, Common Elements
2459 @comment node-name, next, previous, up
2460 @subsection Parameters used for defining styles
2461 @cindex publishing, style elements
2463 Style elements are tags that define a style. Use
2464 @code{muse-define-style} to create a new style.
2467 (muse-define-style DERIVED-NAME BASE-NAME STYLE-PARAMETERS)
2470 @subheading Usable elements
2475 File extension to use for publishing files with this style.
2478 File extension to use for publishing links to Muse files with this
2482 File extension to use for publishing second-stage files with this style.
2484 For example, PDF publishing generates a LaTeX file first, then a PDF
2485 from that LaTeX file.
2488 List of markup rules for publishing a page with Muse.
2489 @xref{muse-publish-markup-regexps}.
2492 An alist of style types to custom functions for that kind of text.
2493 @xref{muse-publish-markup-functions}.
2496 Strings used for marking up text with this style.
2498 These cover the most basic kinds of markup, the handling of which
2499 differs little between the various styles.
2502 A list of tag specifications, used for handling extra tags.
2503 @xref{muse-publish-markup-tags}.
2506 A table of characters which must be represented specially.
2509 A function that is to be executed on the newly-created publishing buffer
2510 (or the current region) before any publishing occurs.
2512 This is used to set extra parameters that direct the publishing process.
2515 A function that is to be executed on the publishing buffer (or the
2516 current region) immediately after applying all of the markup regexps.
2518 This is used to fix the order of table elements (header, footer, body)
2522 A function that is to be executed on the publishing buffer after
2523 :before-end, and immediately after inserting the header and footer.
2525 This is used for generating the table of contents as well as setting the
2529 A function that is to be executed after saving the published file, but
2530 while still in its buffer.
2532 This is used for generating second-stage documents like PDF files from
2533 just-published LaTeX files.
2536 Header used for publishing files of this style.
2538 This may be a variable, text, or a filename. It is inserted at the
2539 beginning of a file, after evaluating the publishing markup.
2542 Footer used for publishing files of this style.
2544 This may be a variable, text, or a filename. It is inserted at the end
2545 of a file, after evaluating the publishing markup.
2548 Style sheet used for publishing files of this style.
2550 This may be a variable or text. It is used in the header of HTML and
2551 XHTML based publishing styles.
2554 The function used to browse the published result of files of this style.
2558 @node Deriving Styles, , Common Elements, Extending Muse
2559 @comment node-name, next, previous, up
2560 @section Deriving a new style from an existing one
2561 @cindex publishing styles, deriving
2563 To create a new style from an existing one, use @code{muse-derive-style}
2564 as follows. This is a good way to fix something you don't like about a
2565 particular publishing style, or to personalize it.
2568 (muse-derive-style DERIVED-NAME BASE-NAME STYLE-PARAMETERS)
2571 The derived name is a string defining the new style, such as "my-html".
2572 The base name must identify an existing style, such as "html" -- if you
2573 have loaded @file{muse-html}. The style parameters are the same as
2574 those used to create a style, except that they override whatever
2575 definitions exist in the base style. However, some definitions only
2576 partially override. The following parameters support partial
2579 @xref{Style Elements}, for a complete list of all parameters.
2584 If a markup function is not found in the derived style's function list,
2585 the base style's function list will be queried.
2588 All regexps in the current style and the base style(s) will be used.
2591 If a markup string is not found in the derived style's string list, the
2592 base style's string list will be queried.
2597 @node Getting Help and Reporting Bugs, History, Extending Muse, Top
2598 @comment node-name, next, previous, up
2599 @chapter Getting Help and Reporting Bugs
2600 @cindex help, getting
2601 @cindex bugs, reporting
2603 After you have read this guide, if you still have questions about
2604 Muse, or if you have bugs to report, there are several places you can
2610 @uref{http://www.emacswiki.org/cgi-bin/wiki/MuseMode} is the
2611 emacswiki.org page, and anyone may add tips, hints, or bug descriptions
2615 @uref{http://www.mwolson.org/projects/EmacsMuse.html} is the web page
2616 that Michael Olson (the current maintainer) made for Muse.
2619 You can join the mailing list at @email{emacs-wiki-discuss@@nongnu.org}
2620 using the subscription form at
2621 @uref{http://mail.nongnu.org/mailman/listinfo/ emacs-wiki-discuss}.
2622 This mailing list provides support for Muse, @command{Planner} and
2623 @command{emacs-wiki}, which is the predecessor of Muse.
2625 There are additional methods for accessing the mailing list, adding
2626 content to it, and searching it. Consult
2627 @uref{http://www.emacswiki.org/cgi-bin/wiki/EmacsWikiMailingList} for
2631 You can visit the IRC Freenode channel @samp{#emacs}. Many of the
2632 contributors are frequently around and willing to answer your
2633 questions. The @samp{#muse} channel is also available for
2634 Muse-specific help, and its current maintainer hangs out there.
2637 The maintainer of Emacs Muse, Michael Olson, may be contacted at
2638 @email{mwolson@@gnu.org}.
2642 @node History, Contributors, Getting Help and Reporting Bugs, Top
2643 @comment node-name, next, previous, up
2644 @chapter History of This Document
2645 @cindex history, of Muse
2649 John Wiegley started Muse upon realizing that EmacsWiki had some serious
2650 limitations. Around February 2004, he started making "emacs-wiki version
2651 3.00 APLHA", which eventually became known as Muse.
2653 Most of those who frequent the emacs-wiki mailing list continued to use
2654 emacs-wiki, mainly because Planner hasn't been ported over to it.
2656 As of 2004-12-01, Michael Olson became the maintainer of Muse, as per
2657 John Wiegley's request.
2660 Michael Olson overhauled this document and added many new sections in
2661 preparation for the first release of Muse (3.01).
2665 @node Contributors, GNU General Public License, History, Top
2666 @comment node-name, next, previous, up
2667 @chapter Contributors to This Documentation
2668 @cindex contributors
2670 The first draft of this document was taken from the emacs-wiki texinfo
2671 manual. Michael Olson adapted it for Muse and added most of its
2674 John Sullivan did a majority of the work on the emacs-wiki texinfo
2677 While Sacha Chua maintained emacs-wiki, she worked quite a bit on the
2678 emacs-wiki texinfo manual.
2680 @node GNU General Public License, Concept Index, Contributors, Top
2681 @comment node-name, next, previous, up
2682 @appendix GNU GENERAL PUBLIC LICENSE
2683 @center Version 2, June 1991
2685 @cindex GNU General Public License
2687 @c This file is intended to be included in another file.
2690 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
2691 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
2693 Everyone is permitted to copy and distribute verbatim copies
2694 of this license document, but changing it is not allowed.
2697 @appendixsec Preamble
2699 The licenses for most software are designed to take away your
2700 freedom to share and change it. By contrast, the GNU General Public
2701 License is intended to guarantee your freedom to share and change free
2702 software---to make sure the software is free for all its users. This
2703 General Public License applies to most of the Free Software
2704 Foundation's software and to any other program whose authors commit to
2705 using it. (Some other Free Software Foundation software is covered by
2706 the GNU Library General Public License instead.) You can apply it to
2709 When we speak of free software, we are referring to freedom, not
2710 price. Our General Public Licenses are designed to make sure that you
2711 have the freedom to distribute copies of free software (and charge for
2712 this service if you wish), that you receive source code or can get it
2713 if you want it, that you can change the software or use pieces of it
2714 in new free programs; and that you know you can do these things.
2716 To protect your rights, we need to make restrictions that forbid
2717 anyone to deny you these rights or to ask you to surrender the rights.
2718 These restrictions translate to certain responsibilities for you if you
2719 distribute copies of the software, or if you modify it.
2721 For example, if you distribute copies of such a program, whether
2722 gratis or for a fee, you must give the recipients all the rights that
2723 you have. You must make sure that they, too, receive or can get the
2724 source code. And you must show them these terms so they know their
2727 We protect your rights with two steps: (1) copyright the software, and
2728 (2) offer you this license which gives you legal permission to copy,
2729 distribute and/or modify the software.
2731 Also, for each author's protection and ours, we want to make certain
2732 that everyone understands that there is no warranty for this free
2733 software. If the software is modified by someone else and passed on, we
2734 want its recipients to know that what they have is not the original, so
2735 that any problems introduced by others will not reflect on the original
2736 authors' reputations.
2738 Finally, any free program is threatened constantly by software
2739 patents. We wish to avoid the danger that redistributors of a free
2740 program will individually obtain patent licenses, in effect making the
2741 program proprietary. To prevent this, we have made it clear that any
2742 patent must be licensed for everyone's free use or not licensed at all.
2744 The precise terms and conditions for copying, distribution and
2745 modification follow.
2748 @appendixsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
2751 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
2756 This License applies to any program or other work which contains
2757 a notice placed by the copyright holder saying it may be distributed
2758 under the terms of this General Public License. The ``Program'', below,
2759 refers to any such program or work, and a ``work based on the Program''
2760 means either the Program or any derivative work under copyright law:
2761 that is to say, a work containing the Program or a portion of it,
2762 either verbatim or with modifications and/or translated into another
2763 language. (Hereinafter, translation is included without limitation in
2764 the term ``modification''.) Each licensee is addressed as ``you''.
2766 Activities other than copying, distribution and modification are not
2767 covered by this License; they are outside its scope. The act of
2768 running the Program is not restricted, and the output from the Program
2769 is covered only if its contents constitute a work based on the
2770 Program (independent of having been made by running the Program).
2771 Whether that is true depends on what the Program does.
2774 You may copy and distribute verbatim copies of the Program's
2775 source code as you receive it, in any medium, provided that you
2776 conspicuously and appropriately publish on each copy an appropriate
2777 copyright notice and disclaimer of warranty; keep intact all the
2778 notices that refer to this License and to the absence of any warranty;
2779 and give any other recipients of the Program a copy of this License
2780 along with the Program.
2782 You may charge a fee for the physical act of transferring a copy, and
2783 you may at your option offer warranty protection in exchange for a fee.
2786 You may modify your copy or copies of the Program or any portion
2787 of it, thus forming a work based on the Program, and copy and
2788 distribute such modifications or work under the terms of Section 1
2789 above, provided that you also meet all of these conditions:
2793 You must cause the modified files to carry prominent notices
2794 stating that you changed the files and the date of any change.
2797 You must cause any work that you distribute or publish, that in
2798 whole or in part contains or is derived from the Program or any
2799 part thereof, to be licensed as a whole at no charge to all third
2800 parties under the terms of this License.
2803 If the modified program normally reads commands interactively
2804 when run, you must cause it, when started running for such
2805 interactive use in the most ordinary way, to print or display an
2806 announcement including an appropriate copyright notice and a
2807 notice that there is no warranty (or else, saying that you provide
2808 a warranty) and that users may redistribute the program under
2809 these conditions, and telling the user how to view a copy of this
2810 License. (Exception: if the Program itself is interactive but
2811 does not normally print such an announcement, your work based on
2812 the Program is not required to print an announcement.)
2815 These requirements apply to the modified work as a whole. If
2816 identifiable sections of that work are not derived from the Program,
2817 and can be reasonably considered independent and separate works in
2818 themselves, then this License, and its terms, do not apply to those
2819 sections when you distribute them as separate works. But when you
2820 distribute the same sections as part of a whole which is a work based
2821 on the Program, the distribution of the whole must be on the terms of
2822 this License, whose permissions for other licensees extend to the
2823 entire whole, and thus to each and every part regardless of who wrote it.
2825 Thus, it is not the intent of this section to claim rights or contest
2826 your rights to work written entirely by you; rather, the intent is to
2827 exercise the right to control the distribution of derivative or
2828 collective works based on the Program.
2830 In addition, mere aggregation of another work not based on the Program
2831 with the Program (or with a work based on the Program) on a volume of
2832 a storage or distribution medium does not bring the other work under
2833 the scope of this License.
2836 You may copy and distribute the Program (or a work based on it,
2837 under Section 2) in object code or executable form under the terms of
2838 Sections 1 and 2 above provided that you also do one of the following:
2842 Accompany it with the complete corresponding machine-readable
2843 source code, which must be distributed under the terms of Sections
2844 1 and 2 above on a medium customarily used for software interchange; or,
2847 Accompany it with a written offer, valid for at least three
2848 years, to give any third party, for a charge no more than your
2849 cost of physically performing source distribution, a complete
2850 machine-readable copy of the corresponding source code, to be
2851 distributed under the terms of Sections 1 and 2 above on a medium
2852 customarily used for software interchange; or,
2855 Accompany it with the information you received as to the offer
2856 to distribute corresponding source code. (This alternative is
2857 allowed only for noncommercial distribution and only if you
2858 received the program in object code or executable form with such
2859 an offer, in accord with Subsection b above.)
2862 The source code for a work means the preferred form of the work for
2863 making modifications to it. For an executable work, complete source
2864 code means all the source code for all modules it contains, plus any
2865 associated interface definition files, plus the scripts used to
2866 control compilation and installation of the executable. However, as a
2867 special exception, the source code distributed need not include
2868 anything that is normally distributed (in either source or binary
2869 form) with the major components (compiler, kernel, and so on) of the
2870 operating system on which the executable runs, unless that component
2871 itself accompanies the executable.
2873 If distribution of executable or object code is made by offering
2874 access to copy from a designated place, then offering equivalent
2875 access to copy the source code from the same place counts as
2876 distribution of the source code, even though third parties are not
2877 compelled to copy the source along with the object code.
2880 You may not copy, modify, sublicense, or distribute the Program
2881 except as expressly provided under this License. Any attempt
2882 otherwise to copy, modify, sublicense or distribute the Program is
2883 void, and will automatically terminate your rights under this License.
2884 However, parties who have received copies, or rights, from you under
2885 this License will not have their licenses terminated so long as such
2886 parties remain in full compliance.
2889 You are not required to accept this License, since you have not
2890 signed it. However, nothing else grants you permission to modify or
2891 distribute the Program or its derivative works. These actions are
2892 prohibited by law if you do not accept this License. Therefore, by
2893 modifying or distributing the Program (or any work based on the
2894 Program), you indicate your acceptance of this License to do so, and
2895 all its terms and conditions for copying, distributing or modifying
2896 the Program or works based on it.
2899 Each time you redistribute the Program (or any work based on the
2900 Program), the recipient automatically receives a license from the
2901 original licensor to copy, distribute or modify the Program subject to
2902 these terms and conditions. You may not impose any further
2903 restrictions on the recipients' exercise of the rights granted herein.
2904 You are not responsible for enforcing compliance by third parties to
2908 If, as a consequence of a court judgment or allegation of patent
2909 infringement or for any other reason (not limited to patent issues),
2910 conditions are imposed on you (whether by court order, agreement or
2911 otherwise) that contradict the conditions of this License, they do not
2912 excuse you from the conditions of this License. If you cannot
2913 distribute so as to satisfy simultaneously your obligations under this
2914 License and any other pertinent obligations, then as a consequence you
2915 may not distribute the Program at all. For example, if a patent
2916 license would not permit royalty-free redistribution of the Program by
2917 all those who receive copies directly or indirectly through you, then
2918 the only way you could satisfy both it and this License would be to
2919 refrain entirely from distribution of the Program.
2921 If any portion of this section is held invalid or unenforceable under
2922 any particular circumstance, the balance of the section is intended to
2923 apply and the section as a whole is intended to apply in other
2926 It is not the purpose of this section to induce you to infringe any
2927 patents or other property right claims or to contest validity of any
2928 such claims; this section has the sole purpose of protecting the
2929 integrity of the free software distribution system, which is
2930 implemented by public license practices. Many people have made
2931 generous contributions to the wide range of software distributed
2932 through that system in reliance on consistent application of that
2933 system; it is up to the author/donor to decide if he or she is willing
2934 to distribute software through any other system and a licensee cannot
2937 This section is intended to make thoroughly clear what is believed to
2938 be a consequence of the rest of this License.
2941 If the distribution and/or use of the Program is restricted in
2942 certain countries either by patents or by copyrighted interfaces, the
2943 original copyright holder who places the Program under this License
2944 may add an explicit geographical distribution limitation excluding
2945 those countries, so that distribution is permitted only in or among
2946 countries not thus excluded. In such case, this License incorporates
2947 the limitation as if written in the body of this License.
2950 The Free Software Foundation may publish revised and/or new versions
2951 of the General Public License from time to time. Such new versions will
2952 be similar in spirit to the present version, but may differ in detail to
2953 address new problems or concerns.
2955 Each version is given a distinguishing version number. If the Program
2956 specifies a version number of this License which applies to it and ``any
2957 later version'', you have the option of following the terms and conditions
2958 either of that version or of any later version published by the Free
2959 Software Foundation. If the Program does not specify a version number of
2960 this License, you may choose any version ever published by the Free Software
2964 If you wish to incorporate parts of the Program into other free
2965 programs whose distribution conditions are different, write to the author
2966 to ask for permission. For software which is copyrighted by the Free
2967 Software Foundation, write to the Free Software Foundation; we sometimes
2968 make exceptions for this. Our decision will be guided by the two goals
2969 of preserving the free status of all derivatives of our free software and
2970 of promoting the sharing and reuse of software generally.
2973 @heading NO WARRANTY
2980 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
2981 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
2982 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
2983 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
2984 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
2985 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
2986 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
2987 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
2988 REPAIR OR CORRECTION.
2991 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
2992 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
2993 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
2994 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
2995 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
2996 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
2997 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
2998 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
2999 POSSIBILITY OF SUCH DAMAGES.
3003 @heading END OF TERMS AND CONDITIONS
3006 @center END OF TERMS AND CONDITIONS
3010 @appendixsec Appendix: How to Apply These Terms to Your New Programs
3012 If you develop a new program, and you want it to be of the greatest
3013 possible use to the public, the best way to achieve this is to make it
3014 free software which everyone can redistribute and change under these terms.
3016 To do so, attach the following notices to the program. It is safest
3017 to attach them to the start of each source file to most effectively
3018 convey the exclusion of warranty; and each file should have at least
3019 the ``copyright'' line and a pointer to where the full notice is found.
3022 @var{one line to give the program's name and a brief idea of what it does.}
3023 Copyright (C) @var{yyyy} @var{name of author}
3025 This program is free software; you can redistribute it and/or modify
3026 it under the terms of the GNU General Public License as published by
3027 the Free Software Foundation; either version 2 of the License, or
3028 (at your option) any later version.
3030 This program is distributed in the hope that it will be useful,
3031 but WITHOUT ANY WARRANTY; without even the implied warranty of
3032 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3033 GNU General Public License for more details.
3035 You should have received a copy of the GNU General Public License along
3036 with this program; if not, write to the Free Software Foundation, Inc.,
3037 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
3040 Also add information on how to contact you by electronic and paper mail.
3042 If the program is interactive, make it output a short notice like this
3043 when it starts in an interactive mode:
3046 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
3047 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
3048 This is free software, and you are welcome to redistribute it
3049 under certain conditions; type `show c' for details.
3052 The hypothetical commands @samp{show w} and @samp{show c} should show
3053 the appropriate parts of the General Public License. Of course, the
3054 commands you use may be called something other than @samp{show w} and
3055 @samp{show c}; they could even be mouse-clicks or menu items---whatever
3058 You should also get your employer (if you work as a programmer) or your
3059 school, if any, to sign a ``copyright disclaimer'' for the program, if
3060 necessary. Here is a sample; alter the names:
3063 Yoyodyne, Inc., hereby disclaims all copyright interest in the program
3064 `Gnomovision' (which makes passes at compilers) written by James Hacker.
3066 @var{signature of Ty Coon}, 1 April 1989
3067 Ty Coon, President of Vice
3070 This General Public License does not permit incorporating your program into
3071 proprietary programs. If your program is a subroutine library, you may
3072 consider it more useful to permit linking proprietary applications with the
3073 library. If this is what you want to do, use the GNU Library General
3074 Public License instead of this License.
3077 @node Concept Index, , GNU General Public License, Top
3078 @comment node-name, next, previous, up