Index of /~wh5a/personal
Name Last modified Size Description
![[DIR]](/icons/back.gif)
Parent Directory -
![[ ]](/icons/layout.gif)
C_Programming_Styles..> 05-Oct-2007 10:09 1.0M
![[DIR]](/icons/folder.gif)
DC_album/ 10-Mar-2005 12:15 -
![[ ]](/icons/unknown.gif)
Dotemacs 26-Apr-2006 23:17 9.1K
Emacs/ 26-Apr-2006 23:18 -
Florida/ 02-Jan-2005 16:56 -
House/ 05-Mar-2008 06:23 -
MonadHack.hs 08-Jul-2008 23:41 930
Quals/ 06-Dec-2005 14:38 -
RefControl-0.8.10.xpi 19-May-2008 12:20 32K
![[ ]](/icons/binary.gif)
Rijndael_ingles_2004..> 17-Aug-2000 19:00 506K
![[TXT]](/icons/text.gif)
Simplify.html 17-Feb-2006 02:56 11K
Transformers.lhs 27-Feb-2008 23:42 46K
Transformers.pdf 27-Feb-2008 23:42 165K
UVA_album/ 10-Mar-2005 12:26 -
WBR2-G54_2.32_1.00 06-May-2005 09:00 3.4M
XPokerBot/ 22-Jul-2008 12:06 -
_emacs 24-Apr-2006 01:34 2.0K
ajax/ 18-Mar-2006 15:41 -
bansheemlifc.ml.html 19-Jul-2006 23:25 46K
bot/ 01-Sep-2008 22:52 -
camlincaml.ml 31-Jan-2008 17:21 29K
cast.hs 26-Aug-2007 03:12 538
cgo2007.pdf 23-Dec-2006 07:44 306K
codejam08/ 02-Aug-2008 16:20 -
![[IMG]](/icons/image2.gif)
cursive.gif 07-Oct-2005 15:02 308K
dynprog-haskell.lhs 18-Mar-2006 12:22 5.0K
english_online.doc 23-Jan-2006 16:50 27K
english_refs.doc 23-Jan-2006 16:37 46K
![[ ]](/icons/tex.gif)
exercise.tex 16-Sep-2004 01:41 1.4K
f_word.swf 16-Sep-2002 06:38 392K
food_in_translation.doc 23-Aug-2007 04:51 3.4M
gcc.pdf 01-Dec-2007 04:51 23K
gdb.pdf 11-Oct-2004 22:35 130K
ggx/ 02-May-2008 02:01 -
gov_in_translation.pdf 09-Mar-2008 20:54 78K
halloween/ 04-Nov-2004 14:39 -
hu-vee06.bib 21-Jun-2006 18:11 621
hu-vee06.ppt 14-Jun-2006 14:16 1.0M
icfp06/ 08-Aug-2007 16:06 -
irc.hs 31-Aug-2008 01:03 4.0K
lazy.hs 19-Aug-2007 06:01 14K
libcore-ocaml-doc/ 16-Aug-2008 02:42 -
linux-0.0.1/ 21-Jan-2008 18:08 -
memofib.lhs 17-Jul-2008 19:26 8.2K
monad.hs 27-Jul-2008 19:31 639
nyc/ 28-Nov-2004 20:17 -
odbc.hs 06-Aug-2008 00:07 2.7K
pr_recycling.pdf 30-Apr-2008 10:56 33K
psi.doc 14-Nov-2005 18:36 529K
quicksort.lhs 30-Jul-2008 01:25 2.6K
readme.htm 16-Dec-2004 01:12 10K
recursiveType.lhs 25-Feb-2008 19:28 4.3K
rewrite.hs 12-May-2008 22:56 878
st.hs 16-Aug-2008 00:13 2.5K
strata-isr.pdf 25-Mar-2006 21:32 293K
tex_pitfalls 25-Jan-2006 20:05 2.1K
title_in_translation..> 07-Jul-2008 01:23 312K
vararg-fn.lhs 29-Mar-2008 14:33 14K
wei_bbs/ 10-Apr-2008 21:06 -
yi.hs 14-Apr-2008 18:56 2.6K
The Emacs Muse
The Emacs Muse
Emacs Muse is an authoring and publishing environment for Emacs. It
simplifies the process of writings documents and publishing them to
various output formats.
Muse consists of two main parts: an enhanced text-mode for authoring
documents and navigating within Muse projects, and a set of publishing
styles for generating different kinds of output.
-
Getting Started
-
Creating a Muse project
-
Markup rules
-
-
Paragraphs
-
Centered paragraphs and quotations
-
Headings
-
Horizontal rules
-
Emphasizing text
-
Adding footnotes
-
Verse
-
Literal paragraphs
-
Lists
-
Anchors and tagged links
-
URLs and E-mail addresses
-
Links
-
Embedded lisp
-
Authoring mode
-
Publishing styles
-
-
Deriving from an existing style
-
Overriding an existing style
-
Creating a new style
Getting Started
To use Muse, add the directory containing its files to your
load-path variable, in your .emacs file. Then, load in the
authoring mode, and the styles you wish to publish to. For example:
(add-to-list 'load-path "<path to Muse>")
(require 'muse-mode) ; load authoring mode
(require 'muse-html) ; load publishing styles I use
(require 'muse-latex)
(require 'muse-texinfo)
(require 'muse-docbook)
Once loaded, the command M-x muse-publish-this-file will publish an
input document to any available style. If you enable muse-mode
within a buffer, by typing M-x muse-mode, this command will be bound
to C-c C-t.
Creating a Muse project
Often you will want to publish all the files within a directory to a
particular set of output styles automatically. To support, Muse
allows for the creations of "projects". Here is a sample project, to
be defined in your .emacs file:
(require 'muse-project)
(setq muse-project-alist
'(("website" ; my various writings
("~/Pages" :default "index")
(:base "html" :path "~/public_html")
(:base "pdf" :path "~/public_html/pdf"))))
The above defines a project named "website", whose files are located
in the directory ~/Pages. The default page to visit is index.
When this project is published, each page will be output as HTML to
the directory ~/public_html, and as PDF to the directory
~/public_html/pdf. Within any project page, you may create a link
to other pages using the syntax [[pagename]].
Markup rules
A Muse document uses special, contextual markup rules to determine how
to format the output result. For example, if a paragraph is indented,
Muse assumes it should be quoted.
There are not too many markup rules, and all of them strive to be as
simple as possible so that you can focus on document creation, rather
than formatting.
Paragraphs
Separate paragraphs in Muse must be separate by a blank line.
For example, the input text used for this section is:
Separate paragraphs in Muse must be separate by a blank line.
For example, the input text used for this section is:
Centered paragraphs and quotations
A line that begins with six or more columns of whitespace (either tabs
or spaces) indicates a centered paragraph.
But if a line begins with whitespace, though less than six columns,
it indicates a quoted paragraph.
Headings
A heading becomes a chapter or section in printed output — depending
on the style. To indicate a heading, start a new paragraph with one
to three asterices, followed by a space and the heading title. Then
begin another paragraph to enter the text for that section.
* First level
** Second level
*** Third level
Horizontal rules
Four or more dashes indicate a horizontal rule. Be sure to put blank
lines around it, or it will be considered part of the proceeding or
following paragraph!
The separator above was produced by typing:
----
Emphasizing text
To emphasize text, surround it with certain specially recognized
characters:
*emphasis*
**strong emphasis**
***very strong emphasis***
_underlined_
=verbatim and monospace=
The above list renders as:
emphasis
strong emphasis
very strong emphasis
underlined
verbatim and monospace
Adding footnotes
A footnote reference is simply a number in square
brackets[1].1 To define the footnote, place
this definition at the bottom of your file. footnote-mode can be
used to greatly facilitate the creation of these kinds of footnotes.
Footnotes:
[1] Footnotes are defined by the same number in brackets
occurring at the beginning of a line. Use footnote-mode's
C-c ! a command, to very easily insert footnotes while
typing. Use C-x C-x to return to the point of insertion.
Verse
Poetry requires that whitespace be preserved, but without resorting to
monospace. To indicate this, use the following markup, reminiscent of
e-mail quotations:
> A line of Emacs verse;
> forgive its being so terse.
The above is rendered as:
A line of Emacs verse;
forgive its being so terse.
You can also use the
<verse>
A line of Emacs verse;
forgive its being so terse.
</verse>
Literal paragraphs
The
There is also the
Lists
Lists are given using special characters at the beginning of a line.
Whitespace must occur before bullets or numbered items, to distinguish
from the possibility of those characters occurring in a real sentence.
The supported kinds of lists are:
- bullet item one
- bullet item two
1. Enumerated item one
2. Enumerated item two
Term1 :: A definition one
Term2 :: A definition two
These are rendered as a bullet list:
- bullet item one
- bullet item two
An enumerated list:
- Enum item one
- Enum item two
And a definition list:
- Term1
- This is a first definition
And it has two lines;
no, make that three.
- Term2
- This is a second definition
Anchors and tagged links
#example If you begin a line with "#anchor" — where "anchor" can be
any word that doesn't contain whitespace — it defines an anchor at
that point into the document. This point can be referenced using
"page#anchor" as the target in a Muse link (see below).
URLs and E-mail addresses
A URL or e-mail address encountered in the input text is published as
a hyperlink if the output style supports it. If it is an image URL,
it will be inlined if possible. For example, the latest Muse source
can be downloaded at
http://www.newartisans.com/johnw/Emacs/muse.tar.gz and mail may be
sent to johnw@gnu.org
Links
A hyperlink can reference a URL, or another page within a Muse
project. In addition, descriptive text can be specified, which should
be displayed rather than the link text in output styles that supports
link descriptions. The syntax is:
[[link target][link description]]
[[link target without description]]
Thus, Muse can be downloaded here, or at
http://www.newartisans.com/johnw/Emacs/muse.tar.gz.
Embedded lisp
Arbitrary kinds of markup can be achieved using the
<lisp>(concat "This form gets " "inserted")</lisp>
The above renders as: This form gets inserted.
Authoring mode
Publishing styles
One of the principle features of Muse is the ability to publish a
simple input text to a variety of different output styles. Muse also
makes it easy to create new styles, or derive from an existing style.
Deriving from an existing style
To create a new style from an existing one, use muse-derive-style:
(muse-derive-style DERIVED-NAME BASE-NAME STYLE-PARAMETERS)
The derived name is a string defining the new style, such as
"my-html". The base name must identify an existing style, such as
"html" — if you have loaded muse-html. The style parameters are
the same as those used to create a style, except that they override
whatever definitions exist in the base style. However, some
definitions only partially override. Those which support partial
overriding are:
- :functions
- If a markup function is not found in the derived style's function
list, the base style's function list will be queried.
- :strings
- :before ::
- :before-end
- :after ::
Overriding an existing style
Creating a new style