This is /builddir/build/BUILD/muse-3.20/examples/QuickStart.info, produced by makeinfo version 4.13 from /builddir/build/BUILD/muse-3.20/examples/QuickStart.texi.
File: QuickStart.info, Node: Top, Next: About this document, Prev: (dir), Up: (dir)
Overview
********
Emacs Muse is an authoring and publishing environment for Emacs. It
simplifies the process of writing 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.
* Menu:
* About this document::
* Getting Started::
* Creating a Muse project::
* Markup rules::
* Publishing styles::
* License::
File: QuickStart.info, Node: About this document, Next: Getting Started, Prev: Top, Up: Top
1 About this document
*********************
This document provides an example of Muse markup and also functions as
a quickstart for Muse.
To see what it looks like when published, type `make examples'. You
will then get an Info document, an HTML document, and a PDF document
(provided you have an implementation of LaTeX installed with the
necessary fonts).
File: QuickStart.info, Node: Getting Started, Next: Creating a Muse project, Prev: About this document, Up: Top
2 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)
(require 'muse-project) ; publish files in projects
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'.
File: QuickStart.info, Node: Creating a Muse project, Next: Markup rules, Prev: Getting Started, Up: Top
3 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:
(setq muse-project-alist
'(("website" ("~/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]]'.
File: QuickStart.info, Node: Markup rules, Next: Publishing styles, Prev: Creating a Muse project, Up: Top
4 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.
* Menu:
* Paragraphs::
* Centered paragraphs and quotations::
* Headings::
* Horizontal rules::
* Emphasizing text::
* Adding footnotes::
* Verse::
* Literal paragraphs::
* Lists::
* Tables::
* Anchors and tagged links::
* URLs and E-mail addresses::
* Images::
* Links::
* Source code::
* Embedded Lisp::
File: QuickStart.info, Node: Paragraphs, Next: Centered paragraphs and quotations, Prev: Markup rules, Up: Markup rules
4.1 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:
File: QuickStart.info, Node: Centered paragraphs and quotations, Next: Headings, Prev: Paragraphs, Up: Markup rules
4.2 Centered paragraphs and quotations
======================================
A line that begins with six or more columns of whitespace (either tabs
or spaces) indicates a centered paragraph.
This is centered
But if a line begins with whitespace, though less than six columns,
it indicates a quoted paragraph.
File: QuickStart.info, Node: Headings, Next: Horizontal rules, Prev: Centered paragraphs and quotations, Up: Markup rules
4.3 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
File: QuickStart.info, Node: Horizontal rules, Next: Emphasizing text, Prev: Headings, Up: Markup rules
4.4 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:
----
File: QuickStart.info, Node: Emphasizing text, Next: Adding footnotes, Prev: Horizontal rules, Up: Markup rules
4.5 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'
File: QuickStart.info, Node: Adding footnotes, Next: Verse, Prev: Emphasizing text, Up: Markup rules
4.6 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.
---------- Footnotes ----------
(1) This is a footnote.
File: QuickStart.info, Node: Verse, Next: Literal paragraphs, Prev: Adding footnotes, Up: Markup rules
4.7 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>' tag, if you prefer:
<verse>
A line of Emacs verse;
forgive its being so terse.
</verse>
File: QuickStart.info, Node: Literal paragraphs, Next: Lists, Prev: Verse, Up: Markup rules
4.8 Literal paragraphs
======================
The `<example>' tag is used for examples, where whitespace should be
preserved, the text rendered in monospace, and any characters special
to the output style escaped.
There is also the `<literal>' tag, which causes a marked block to be
entirely left alone. This can be used for inserting a hand-coded HTML
blocks into HTML output, for example.
If you want some text to only be inserted when publishing to a
particular format, use the `style' attribute for the `<literal>' tag.
Some examples follow.
You are reading the
<literal style="html">HTML</literal>
<literal style="pdf">PDF</literal>
<literal style="info">Info</literal>
version of this document.
Produces:
You are reading the Info version of this document.
<literal style="latex">
LaTeX was used in the publishing of this document.
</literal>
Produces:
File: QuickStart.info, Node: Lists, Next: Tables, Prev: Literal paragraphs, Up: Markup rules
4.9 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:
1. Enum item one
2. 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
Lists may be nested inside of one another. The level of nesting is
determined by the amount of leading whitespace.
- Level 1, bullet item one
1. Level 2, enum item one
2. Level 2, enum item two
- Level 1, bullet item two
This is rendered as:
* Level 1, bullet item one
1. Level 2, enum item one
2. Level 2, enum item two
* Level 1, bullet item two
File: QuickStart.info, Node: Tables, Next: Anchors and tagged links, Prev: Lists, Up: Markup rules
4.10 Tables
===========
Simple tables are supported. The syntax is:
Double bars || Separate header fields
Single bars | Separate body fields
Here are more | body fields
Triple bars ||| Separate footer fields
The above is rendered as:
Double bars Separate header fields
--------------------------------------------------------------------------
Single bars Separate body fields
Here are more body fields
Triple bars Separate footer fields
It is also possible to make tables that look like:
| Single bars | Separate body fields |
| Here are more | body fields |
This publishes as:
Single bars Separate body fields
Here are more body fields
If you are familiar with Org-mode style tables, simple variants (no
column groups or autogenerated formulas) will publish fine. Also,
table.el style tables will be published, provided that the output
format is something that table.el supports.
File: QuickStart.info, Node: Anchors and tagged links, Next: URLs and E-mail addresses, Prev: Tables, Up: Markup rules
4.11 Anchors and tagged links
=============================
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).
Click *note here: example. to go back to the previous paragraph.
File: QuickStart.info, Node: URLs and E-mail addresses, Next: Images, Prev: Anchors and tagged links, Up: Markup rules
4.12 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. For example, the latest
Muse source can be downloaded at http://download.gna.org/muse-el
(http://download.gna.org/muse-el) and mail may be sent to
<mwolson@gnu.org>.
File: QuickStart.info, Node: Images, Next: Links, Prev: URLs and E-mail addresses, Up: Markup rules
4.13 Images
===========
If a URL has an extension of a known image format, it will be inlined
if possible. To create a link to an image, rather than inlining it,
put the text "URL:" immediately in front of the link.
This is an inlined image example:
Made with [[muse-made-with.png]] Emacs Muse.
This publishes as:
Made with
