emacs wiki 指南

emacs wiki 指南

0 作者有话说 1 Preface(前言) 2 Introduction(简介) 3 Installation(安装) 4 Wiki Concepts(Wiki概念) 5 Getting Started(开始) 6 Keystroke Summary(快捷键) 7 Markup Rules(标记规则) 8 Interactive Functions(交互函数) 9 Convenience Features(方便的特性) 10 Fancy Tables(幻想表) 11 Multiple Projects(多个项目) 12 Encryption(加密) 13 Getting Help and Reporting Bugs(获取帮助与报告Bugs) 14 Contributors(贡献者) Appendix A GNU GENERAL PUBLIC LICENSE(GNU通用公共许可证)

0 作者有话说

作为一名程序员，把自己学过的，用过的知识，遇到的，碰到的问题总结起来，这是多么有成就感的一件事啊！
很早就开始想把自己的知识和问题记录下来了，但是一直也没有什么好的组织方法。最近通过Google了解到用

EmacsWiki

来组织自己的知识是个非常不错的选择，于是就想找一个快速入门的教程。但是呢，找不到哇！只好闷着头看Emacs-wiki的手册了。我感觉手册就是用来查的，如果通过看手册入门的话是比较困难的，奈何奈何没有tutorial啊！
话说这篇文章就是用Emacs-wiki写成的，我也是刚学Emacs-wiki不久，很多东西都很不熟悉，慢慢来吧。
有些我用不上的地方，我也就略过去，想了解的话可以看 http://mwolson.org/static/doc/emacs-wiki.html ，这里是原文。
PS:

本人的英文水平实在有够差，所以如果看翻译的中文实在看不懂的话，对应上面有英文，可以自己试试看；

有些特性我还没有试出来，所以看我的翻译试不出来也正常；

欢迎大家把翻译不准确的地方指出来，团结就是力量。

1 Preface(前言)

This document describes emacs-wiki, which was written by John Wiegley and is now maintained by Michael Olson.
这篇描述emacs-wiki的文档是由John Wiegley所写，它现在由Michael维护。
This document is a work in progress, and your contribution will be greatly appreciated. Please email comments and suggestions to the maintainer, Michael Olson mwolson@gnu.org.
这是一篇还在完善中的文档，非常欢迎你参与贡献。请将评论和建议的邮件发给维护者Michael Olason mwolson@gnu.org

2 Introduction(简介)

emacs-wiki enables you to create and use hyperlinks and simple formatting in plain text files, and to optionally publish your pages as HTML.
emacs-wiki能够使你创建和使用超链接，简单的格式化文本文件和可选的以HTML方式发布你的页面。

2006

The 2.71 release of emacs-wiki will probably be its last release, since Emacs Muse does the same things in a better way, with only some little-used functionality remaining to be ported. When the 3.03 release of Emacs Muse comes out, it will be considered a complete replacement for emacs-wiki.

emacs-wiki 2.71 释放版本也许会是它的最后一个版本， 由于Emacs Muse用更好的方式做同样的事，还剩一些很少被用的函数没有移植。 当Muse的3.03版本发表后，它会考虑完整的替换emacs-wiki.

2004

Damien Elmes handed

EmacsWikiMode

to Mark Triggs for a short period of time. Mark Triggs deferred to Sacha Chua as official maintainer of

PlannerMode

. Sacha Chua volunteered to maintain

RememberMode

. Michael Olson became the maintainer of

EmacsWikiMode

later that year.

2003

Sacha Chua volunteered to maintain

PlannerMode

. Damien Elmes volunteered to maintain

EmacsWikiMode

.

2001

John Wiegley wrote

EmacsWikiMode

and

PlannerMode

.

3 Installation(安装)

Releases: Released versions of emacs-wiki

Development: Latest unreleased changes

释放版：emacs-wiki的释放版

开发版：最新未释放的改变

3.1 Installing a release(安装释放版)

Choose to install a release if you want to minimize risk.
如果你不想冒大的风险，选择安装释放版本吧。
Errors are corrected in development first. Once fixes are confirmed, a new release will be made. User-visible changes will be announced on the emacs-wiki-discuss@nongnu.org mailing list. see Getting Help and Reporting Bugs.
错误会首先在开发版中修复。一量被证明稳定，将会发布一个新的释放版本。 用户可见的改变会通过 emacs-wiki-discuss@nongnu.org 邮件列表发送。参见获取帮助和报告Bugs。
Debian users can get emacs-wiki via apt-get. The version of emacs-wiki in the Debian stable archive is not recommended, since it is so old. emacs-wiki is available in the Sarge and Sid distributions: apt-get install emacs-wiki .
Debian user 可以通过apt-get获取emacs-wiki. 不建议使用Debian稳定版中的emacs-wiki版本，因为它太旧了。 emacs-wiki在Sarge和Sid发行版中也是可用的：apt-get install emacs wiki。
You can also install the source distribution.
你也可以从源码安装emacs-wiki。
Download and unpack the latest version from http://www.mwolson.org/static/dist/emacs-wiki/ .
从 http://www.mwolson.org/static/dist/emacs-wiki/ 下载和解压最新的版本。

Edit your ~/.emacs.
;; Add the directories to your load path
(add-to-list 'load-path "/path/to/emacs-wiki")
;; Load emacs-wiki
(require 'emacs-wiki)

编辑你的 ~/.emacs.
;; 添加到你的加载路径
(add-to-list 'load-path "/path/to/emacs-wiki")
;; 加载emacs-wiki
(require 'emacs-wiki)

3.2 Installing the development version(安装开发版本)(略)

4 Wiki Concepts(Wiki概念)

Wiki is a concept, more than a thing. It is a way of creating document pages using plain text markup and simplified hyperlinking.
Wiki不仅仅是一个东西，而是一个概念。它是一个方法：用纯文本标记和简单的超链接来创建文档。
By typing a name in

MixedCase

(also known as

CamelCase

), a hyperlink is automatically created to the document

MixedCase

. Pressing return on that name will create the file if it doesn't exist, or visit it if it does.
通过在

MixedCase

(也称

CamelCase

)中键入一个名字，一个超链接将会自动的创建。在名字上按回车键将会创建或浏览它。
The markup used by Emacs-Wiki is intended to be very friendly to people familiar with Emacs. Type C-h v emacs-wiki-publishing-markup after this mode is loaded for more information on how to get started.
Emacs-Wiki所用的标志设计的对熟悉Emacs的人非常友好。在该模式加载后，按下C-h v emacs-wiki-publishing-markup可以获取更多的关于如何开始的信息。
Wiki's are often associated with sites that allow collaborative editing of a website. emacs-wiki is not meant to produce this sort of site, although you can use Emacs to serve web pages. See emacs-wiki-httpd.el for more information. Note that this feature is not well-tested.
Wiki通常和允许自由协作编辑的站点有关联。虽然你可以使用Emacs来发布web页面，但是emacs-wiki不意味的生成这类的站点。参看emacs-wiki-httpd.el获取更多的信息。注意：这个特点没有被很好的测试。

5 Getting Started(开始)

To begin using Emacs-Wiki, put this in your .emacs file:
为了使用Emacs-Wiki，把下行代码加入你的.emacs中：

(load ``emacs-wiki'')

Now you can type M-x emacs-wiki-find-file, give it a

WikiName

(or just hit return) and start typing!
现在你可以通过键入M-x emacs-wiki-find-file, 提供一个Wiki名字（或只是按回车），然后开始写文档吧。
You should also type M-x customize-group, and give the name ‘emacs-wiki’. Change it to suit your preferences. Each of the options has its own documentation.
你还应该键入M-x customize-group, 然后提供名字`emacs-wiki'（改变为你喜欢的名字）。每一个选项都有它自己的文档。

6 Keystroke Summary(快捷键)

Here is a summary of keystrokes available in every Wiki buffer:
在每个Wiki buffer里，可用的快捷键汇总如下：

C-c C-a
Jump to an index of all the Wiki pages.
跳转到所有Wiki页面的索引。

C-c C-b
Show all pages that reference this page.
显示所有参考这个页面的页面

C-c C-s
Search for a word in your Wiki pages.
在你的Wiki页面里搜索一个词

C-c C-f
Jump to another Wiki page. Prompt for the name.
跳转到另一个Wiki页面里。提示一个文件名

C-c C-l
Highlight/refresh the current buffer.
高亮/刷新当前buffer

C-c C-p
Publish any Wiki pages that have changed as HTML.
发布任何发生改变的HTML

C-c C-r
Rename Wiki link at point.
重命名某点的Wiki链接

C-c C-t
Publish the current Wiki page.
发布当前的Wiki页面

C-c C-e
Edit link at point.
编辑某点的链接

C-c C-v
Change Wiki project.
改变Wiki项目

C-c C-D
Delete Wiki link at point. This binding will only work on X.
删除某点的Wiki链接。这个binding只能工作在X。

C-c =
Diff this page against the last backup version.
Diff这个页面与最近版本的差异

C-c TAB
Insert a tag interactively.
交互式的插入一个标记

TAB
Move to the next Wiki reference.
移动到下一个参考点

S-TAB
Move to the previous Wiki reference.
移动到上一个参考点

7 Markup Rules(标记规则)

Basic

WikiMarkups

Changing Title or Stylesheet

Lists

Images

Lisp Tricks

Non-existent Links

Special Markups

基本的Wiki标记

改变标题和样式表

列表

图片

Lisp把戏

不存在的链接

特殊的标记

7.1 Basic

WikiMarkups

(基本Wiki标记)

Here is a description of the default markup rules:
默认标记规则的描述：
Headings
标题

* First level
** Second level
*** Third level

Note that the first level is actually indicated using H2, so that
it doesn't appear at the same level as the page heading (which
conceptually titles the section of that Wiki page).

注意：first level使用的是H2,所以不能出现同样的level作为页面的标题。

Horizontal rules
水平线

----

Emphasis
强调

*emphasis*
**strong emphasis**
***nvery strong emphasis***
_underlined text_
=verbatim=
<verbatim>This tag should be used for larger blocks of text</verbatim>.

emphasis
strong emphasis
very strong emphasis
underlined text

verbatim

This tag should be used for larger blocks of text
Footnotes
脚注

A reference[1], which is just a number in square brackets,
constitutes a footnote reference.

一个参考[1]，它仅仅是中括号中的一个数字，构成一个脚注参照。

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.

[1] 脚注定义的方式是在行的开头把相同的数字放在中括号中。使用
foootmote-mode's C-c !命令在写作的过程中简单的插入脚注。使用
C-x C-x返回到插入点。

Paragraphs
段落

One or more blank lines separates paragraphs.
一个或更多的空白行分隔段落

Centered paragraphs and quotations
中心段落和引用

A line that begins with six or more columns of whitespace (made
up of tabs or spaces) indicates a centered paragraph. I assume
this because it's expected you will use M-s to center the line,
which usually adds a lot of whitespace before it.

以6个或者更多的空白区域（使用tabs或空格）指示一个中心的段落。我假设这个是因为，它
期望你使用M-s 来居中这行。在执行这个命令之前常常添加大量的空格。

If a line begins with some whitespace, but less than six
columns, it indicates a quoted paragraph.

如果一行以几个空格开头但少于6个，那么它代表一个引用段落。

Poetic verse
有诗意的诗文

Poetry requires that whitespace be preserved, without resorting
to the monospace typical of <pre>. For this, the following
special markup exists, which is reminiscent of e-mail quotations:

诗需要保存空白，without resorting to the monospace typical of
<pre>。因此出现了特殊的标记，它来自于e-mail的引用。

> 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>

Literal paragraphs
原义段落

Use the HTML tags <pre></pre> to insert a paragraph and preserve
whitespace. If you're inserting a block of code, you will almost
always want to use <verbatim></verbatim> *within* the <pre>
tags. The shorcut for doing this is to use the <example> tag:

使用HTML标记<pre></pre>插入段落并且保留空白。如果你正在插入一个代
码块，你将总是想在<pre>标记中使用<verbatim></verbatim>。更快捷的做
法是使用<example>标记。

<example>
Some literal text or code here.

Some literal text or code here.

Tables
表格

There are two forms of table markup supported. If Takaaki Ota's
table.el package is available, then simply create your tables
using his package, and they will be rendered into the appropriate
HTML. You need to (require 'emacs-wiki-table) for this
functionality.

有两种格式的表格标记被支持。如果Takaaki Ota's table.el包可用，那么
使用他的包简单的创建你的表格，它们会被渲染成适当HTML. 你需要加载这
个功能(require 'emacs-wiki-table)

If table.el is not available, then only very simple table markup
is supported. The attributes of the table are kept in
`emacs-wiki-table-attributes'. The syntax is:

如果table.el不可用，那么只有非常简单的表格标记是支持的。表格的属性
在 'emacs-wiki-table-attributes'。语法如下：

Double bars || Separate header fields
Single bars | Separate body fields
Here are more | body fields
Triple bars ||| Separate footer fields

Other paragraph markup applies to both styles, meaning that if
six or more columns of whitespace precedes the first line of the
table, it will be centered, and if any whitespace at all precedes
first line, it will occur in a blockquote.

其它段落标记应用两个样式，就是说，如果表格的第一行开头有6个或更多
空白，它将被居中，并且如果第一行开头有其它数量的空白，它将是引用。

Double bars	Separate header fields
Single bars	Separate body fields
Here are more	body fields
Triple bars	Separate footer fields

Double bars	Separate header fields
Single bars	Separate body fields
Here are more	body fields
Triple bars	Separate footer fields

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 anchor text is not
displayed.

#example 如果你以"#anchor"为一行开始——这里的anchor可以是任意不包含
空白的词——它在这篇文档里定义了一个锚点。这个锚点文本不会显示

You can reference an anchored point in another page (or even in
the current page) using WikiName#anchor. The #anchor will never
be displayed in HTML, whether at the point of definition or
reference, but it will cause browsers to jump to that point in
the document.

你可以在另一个页面（甚至当前页面）使用WikiName#anchor参考一个锚点。
#anchor将不会显示在HTLM中显示。不论是定义点还是参考点，它都会使浏
览器跳转到文档的那一点。

work#anchor

Redirecting to another page or URL
重定向到另一个页面或URL

Sometimes you may wish to redirect someone to another page. To do
this, put:

有时你也许想重定向某人到另外一个页面。这样做，键入：

<redirect url=\"http://somewhereelse.com\"/>

at the top of the page. If the <redirect> tag specifies content,
this will be used as the redirection message, rather than the
default.

在页面的顶部。如果<redirect>标记指定的内容，这将会被用于重定向信息，而不是默认的。

The numbers of seconds to delay is defined by
`emacs-wiki-redirect-delay', which defaults to 2 seconds. The
page shown will also contain a link to click on, for browsing
which do not support automatic refreshing.

延迟的秒数定义在`emacs-wiki-redirect-delay'，默认值是2秒。对于不支
持自动刷新的浏览器，这个页面也包含一个可点击的链接。

URLs

A regular URL is given as a link. If it's an image URL, it will
be inlined using an IMG tag.

一个规范的URL就是一个链接。如果它是一个图片的URL，它将会内嵌使用IMG标记

Special handling of =WikiNames=
Wiki名字的特殊行为

If you need to add a plural at the end of a WikiName, separate it
with four single quotes (WikiName””s) or make it an explicit
link (`WikiName`s).

如果你需要在Wiki名字后添加一个复数形式，用四单引号(WikiName''''s) 或者做成一个明显的链接(`WikiName`s)。

To prevent a link name (of any type) from being treated as such,
surround it with =equals= (to display it in monotype), or prefix
it with the tag <nop> to escape it from WikiName markup.

使用=包括一个链接名(=equal=)或者在其前使用<nop>标记，可以防止它（任意类型）被当作一个链接。

Special Wiki links
特殊的Wiki链接

Besides the normal WikiName type links, emacs-wiki also supports
extended links:

除了正常的wikiName类型的链接外，emacs-wiki还支持扩展链接。

[[link text][optional link description]]

An extended link is always a link, no matter how it looks. This
means you can use any file in your `emacs-wiki-directories' as a
Wiki file. If you provide an optional description, that's what
will be shown instead of the link text. This is very useful for
providing textual description of URLs.

无论扩展链接看起来如何，它总是一个链接。这意味着你可以在你的
`emacs-wiki-directories'中的任一文件作为一个Wiki文件。如你提供一个
可选的描述，它将会代替链接文本显示。这对于提供URL的文字描述非常有
用

See the documentation to emacs-wiki-image-regexp for how to
inline files and images.

参看`emacs-wiki-image-regexp'文档来获取如何内嵌文件和图片。

InterWiki names 内部Wiki名字

There are times when you will want to constantly reference pages
on another website. Rather than repeating the URL ad nauseum, you
can define an InterWiki name. This is a set of WikiNames to URL
correlations, that support textual substitution using #anchor
names (which are appended to the URL). For example, MeatballWiki
is defined in the variable `emacs-wiki-interwiki-names'. It means
you can reference the page \"MeatBall\" on MeatballWiki using
this syntax:

你有时想不断的参考其它站点的页面。除了重复令人厌烦的URL，你还可以
定义一个内部Wiki名字。 这是一个WikiNames到URL关系的集合，它支持文
字用#anchor名字替换(它会加在URL之后)。例如，MeatballWiki定义在变量
`emacs-wiki-interwiki-names'。它意味着你可以在MeatballWiki参考
"MeatBall"页面，通过以下语法：

MeatballWiki#MeatBall

In the resulting HTML, the link is simply shown as
在HTML中，这个链接显示如下：

MeatballWiki:MeatBall

7.2 Changing Title or Stylesheet(改变标题和样式表)

For convenience, if you want to change the visible title or the stylesheet used by a certain Wiki page during HTML publishing, just put:
方便起见，如果你想在HTML发布的过程中改变显示的标题或者样式表，那么把

#title Hello there
#style hello.css

at the top of the page.
放在页面的顶部吧。

7.3 List(列表)

Whitespace is required after bullets and numbers thot are part of a list.
在短线和数字之后的空白是必须的，它们是列表的一部分。

Here is an example:
这里是例子：

- This
- Is
- A
- List

1. This
2. too

But this is not,
但这不是

--even if it starts with dashes
0.1] or numbers, as in the original test case.

This

Is

A

List

This

too

--even if it starts with dashes
0.1] or numbers, as in the original test case.
Sub-lists?
There is no inherent support for sub-lists, since the author couldn't think of a simple way to do it. But if you really need them, here's a trick you can use:
因为作者没有想到简单的解决办法，所以不提供子列表的支持。但如果你真的需要它们，你可以用这个奇怪的方法：

- Hello
<ul>
<li>There
<li>My friend
</ul>

Hello

There

My friend

7.4 Images(图片)

You can include links of the form
‘[[some/link][some/image]]’. If you want to include alt text,
use ‘[[some/link][some/image alt text]]’.

你可以从'[[some/link][some/image]]'中包含一个链接。如果你想包含一个可选的广西，用'[some/link][some/image alt text]]'.

You may need to have auto-image-file-mode set to ‘t’ for this
to work.

为了使以上行为起作用，你需要把`auto-image-file-mode'设置为't'。

7.5 Lisp Tricks(Lisp 把戏)

<lisp></lisp> tags can be used, not only to evaluate
forms for insertion at that point, but to influence the
publishing process in many ways. Here's another way to change a
page's stylesheet:

<lisp></lisp> 标记不仅可以被用在为某点计算格式，还可以通过多种方式用来影响发布的过程。

<lisp>
(ignore
;; use special.css for this Wiki page
(set (make-variable-buffer-local 'emacs-wiki-style-sheet)
"<link rel=\"stylesheet\" type=\"text/css\" href=\"special.css\" />"))
</lisp>

The ignore is needed so nothing is inserted where the <lisp> tag
occurred. Also, there should be no blank lines before or after
the tag (to avoid empty paragraphs from being created). The best
place to put this would be at the very top or bottom of the page.

ignore是需要的，所以在<lisp>标记出现的地方什么都没有插入。在这个标记前或后不应该有空白行（为了避免产生空段落）。放置它最好的地方是页面的顶部或底部

7.6 Non-existent Links(不存在的链接)

By default, non-existent links are converted into mailto: links in published HTML. This allows website visitors to e-mail emacs-wiki-maintainer for missing information. If you want non-existent links to be rendered as plain text, set emacs-wiki-markup-nonexistent-link to nil.
不存在的链接在发布的HTML中，会默认转化成mailto: 。它允许页面的访问者去为了缺少的信息发送邮件给维护者。如果你想把不存在的链接渲染为文本，设置`emacs-wiki-markup-nonexistent-link'为`nil'。
In HTML served directly from Emacs using httpd and emacs-wiki-httpd.el, non-existent links are always editable links.
如果Emacs使用httpd和emacs-wiki-httpd.el，在HTML服务路径中，不存在的链接总是可编辑的。

7.7 Special Markups(特殊标记)

For specially marking up Wiki text, XML-style tags are the best way to add custom markup to Emacs Wiki, which expects a closing tag and/or an optional set of attributes. This is easily accomplished by customizing this list of markup tags defined in emacs-wiki-markup-tags.
对于特殊标记的Wiki文本， XML风格的标记是给Emacs Wiki添加自定义标记最好的方式。它期望一个结束的标记和（或）一个可选的属性集。自定义标记列表定义在`emacs-wiki-markup-tags'中，它很容易完成。
Here is a summary of the default tags. This also includes the dangerous tags listed in emacs-wiki-dangerous-tags, which may not be used by outsiders.
这里是默认标记的汇总。它还包含`emacs-wiki-dangerous-tags'中的有风险的标记。入门者不使用这些标记。
Please refer to document of emacs-wiki-markup-tags and emacs-wiki-dangerous-tags for detail infomation and customization instructions.
请参看`emacs-wiki-markup-tags' 和 `emacs-wiki-dangerous-tags'的文档获取更细节的信息和自定义的教导。
verbatim

Protects against highlighting and wiki interpretation, and
escapes any characters which have special meaning to the
publishing format. For HTML, this means characters like '<' are
escaped as HTML entities.

避免高亮和wiki解释，逃脱对发布格式来讲具有特殊意义的字符。对HTML，这意味着'<'被替换为HTML实体。

example

Like verbatim, but typesets in HTML using the <pre> tag, with
class=example, so whitespace formatting is preserved.

类似verbatim,但在HTML中的排版用<pre>标记，属性 class=example, 所以空白格式是保留的。

nowiki

Inhibits wiki markup, but does not do any escaping to the
underlying publishing medium. Useful for embedding HTML, PHP,
etc.

固有的wiki标记，但对下面的发布媒介不做任何逃脱。对于嵌入HTML, PHP, etc.有用。

verse

Typesets like a normal paragraph, but without word-wrapping. That
is, whitespace is preserved.

以正常的段落排版，但没有word-wrapping。也就是说，空白被保留。

redirect

Using the "url" attribute, you can specify that a page should
redirect to another page. The remaining contents of the page will
not be published. The optional "delay" attribute specifies how
long to wait before redirecting.

使用"url"属性，你可以指定一个页面重定向到另一个页面。页面保留的内
容将不被发布。选项"delay"属性指定等多久才重定向。

nop

When placed before a WikiLink, it will prevent that WikiLink from
being treated as such. Good for names like DocBook.

当放在WikiLink之前，它会阻止WikiLink被当成一个链接。对DocBook也好使。

contents

Produces a compact table of contents for any section heading at
the same level or lower than the next section header
encountered. Optional "depth" attribute specifies how deep the
table of contents should go.

对任何同级别或低级别的标题生成目录。选项"depth"属性指定目录有多深。

lisp

Evaluate the region as a Lisp form, and displays the result. When
highlighting, the `display' text property is used, preserving the
underlying text. Turn off font-lock mode if you wish to edit it.

以Lisp格式运行这个区域，显示结果。当高亮，`display'文本属性被使用，
保留根本的文本。如果你想编辑它，需要关闭font-lock mode。

command

Pass the region to a command interpretor and insert the result,
guarding it from any further expansion. Optional "file" attribute
specifies the shell or interpretor to use. If none is given, and
emacs-wiki-command-tag-file has not been configured, Eshell is
used.

以命令解释器运行这块区域，然后插入结果，避免它未来扩大。选项
"file"属性指定使用的shell或者解释器。如果什么都没有提供，并且
`emacs-wiki-command-tag-file'也没有设置，使用Eshell。

python, perl

Pass the region to the Python or Perl language interpretor, and
insert the result.

使用Python或Perl语言解释器运行这块区域，然后插入结果。

c-source

Markup the region as C or C++ source code, using the c2html
program, if available. Optional boolean attribute "numbered" will
cause source lines to be numbered.

标记这块区域为C或C++源码，使用c2html程序，如果可用。选项布尔值属性
"numbered"指示是否显示行号。

Note: If c2html is not available, the region will be converted to
HTML friendly text (i.e., <> turns into <>), and placed in
a <pre> block. In this case, line numbering is not available.

注意：如果c2html不可用，这块区域将被转换成HTML友好的文本(例如，<>
转换为lt;>)，并且放置一个<pre>块。在这种情况下，行号是不可用的。

bookmarks

Insert bookmarks at the location of the tag from the given
bookmarks file. Required attribute "file" specifies which file to
read from, and the optional attribute "type" may be one of: adr
(for Opera), lynx, msie, ns, xbel or xmlproc. The default type is
"xbel". The optional attribute "folder" may be used to specify
which folder (and its children) should be inserted.

在给定的书签文件的标记上插入书签。需要属性"file"指定从哪个文件读，
和选项属性"type"也许是以下值之一:adr(for Opera), lynx, msie, ns,
xbel 或 xmlproc。默认的type值是"xbel"。选项属性"folder"指定哪个文
件夹（和它的孩子）应该被插入。

8 Interactive Functions(交互函数)

emacs-wiki.el defines the following interactive functions:
emacs-wiki.el 定义了以下的交互函数

Function: emacs-wiki-edit-link-at-point

Edit the current link. Do not rename the Wiki page originally referred to.

编辑当前链接。不重命名原始参考的Wiki页

Function: emacs-wiki-find-file wiki command directory

Open the Emacs Wiki page wiki by name. If command is non-nil, it is the function used to visit the file. If directory is non-nil, it is the directory in which the Wiki page will be created if it does not already exist.

通过名称打开Emacs Wiki页。如果命令是非空的，它用来浏览文件。如果路径是非空的，它将被创建。

Function: emacs-wiki-next-reference

Move forward to next Wiki link or URL, cycling if necessary.

向前移动到下一个链接或URL，如果需要将会循环。

Function: emacs-wiki-previous-reference

Move backward to the next Wiki link or URL, cycling if necessary. This function is not entirely accurate, but it's close enough.

向后移动到下一个链接或URL，如果需要将会循环。这个函数不完全精确，但非常接近。

Function: emacs-wiki-refresh-buffers &rest args

Rebuild file alist and refresh current project. Call after creating a page.

重建改变的文件然后刷新当前项目。创建一个页面后调用。

Function: emacs-wiki-follow-name-at-point other-window

Visit the link at point, or insert a newline if none.

浏览某点的链接，或，如果没有插入新行

Function: emacs-wiki-follow-name-at-point-other-window

Visit the link at point in other window.

在其它窗口浏览链接

Function: emacs-wiki-follow-name-at-mouse event other-window

Visit the link at point, or yank text if none.

浏览某点的链接，或，如果没有则粘贴。

Function: emacs-wiki-follow-name-at-mouse-other-window event

Visit the link at point.

浏览某点的链接。

Function: emacs-wiki-rename-link-at-point

Rename the link under point, and the location it points to. This does not work with URLs, and will preserve a description in an extended link.

重命名某点的链接和这点指向的位置。对URLs不起作用，将保留扩展链接中的描述。

Function: emacs-wiki-delete-link-at-point

Delete the link under point, and the location it points to. This does not work with URLs.

删除某点的链接和这点指向的位置。对URLs不起作用。

Function: emacs-wiki-search text

Search for the given text string in the Wiki directories.

在Wiki路径中搜索给定的字符串

Function: emacs-wiki-backlink

Grep for the current page name in all the Wiki directories.

在所有Wiki路径中检索当前页面的名称

Function: emacs-wiki-index

Display an index of all known Wiki pages.

显示已知的Wiki页面

Function: emacs-wiki-highlight-buffer

Re-highlight the entire Wiki buffer.

重新高亮整个Wiki buffer。

Function: emacs-wiki-visit-published-file arg

Visit the current Wiki page's published result.

浏览当前Wiki页面的发布效果

Function: emacs-wiki-dired-publish

Publish all marked files in a dired buffer.

发布路径中所有标记文件

Function: emacs-wiki-publish-index

Publish an index of the Wiki pages. This function can be added to emacs-wiki-after-wiki-publish-hook.

发布一个Wiki页面的索引。这个函数可以被添加到`emacs-wiki-after-wiki-publish-hook'。

Function: emacs-wiki-publish arg

Publish all Wikis that need publishing. If the published Wiki already exists, it is only overwritten if the Wiki is newer than the published copy. When given the optional argument arg, all Wikis are rewritten, no matter how recent they are. The index file is rewritten no matter what.

发布所有需要发布Wikis。如果发布的Wiki已经存在，并且Wiki比已经发布的更新，它会覆盖旧的。当提供一个选项参数，所有的Wikis会被重创，无论它们有多新。索引文件总是会重写。

Function: emacs-wiki-publish-this-page

Force publication of the current page.

强制发布当前页面

Function: emacs-wiki-change-project project

Change Wiki projects.

Wiki项目的改变

When called interactively, load the welcome page of the selected project in a new buffer. If no project is selected, the default project as specified in emacs-wiki-default-project will be used.

当调用这个交互命令时，指定项目的欢迎页面将在一个新的buffer中加载。如果没有项目被指定，默认项目在`emacs-wiki-default-project'中被指定。

Note that the project will only be changed if the welcome page exists for the target project. This may be changed in the future to find a nonexistent file, though if this happens it is not clear which of Wiki directory should be used in the case of there being multiple directories.

注意：如果目标项目的欢迎页面存在，这个项目将只是改变。

When called from a Lisp program, update the current buffer's project to project.

当调用Lisp程序，更新当前buffer的项目到项目。

9 Convenience Features(方便的特性)

The following are several miscellaneous features that might make your emacs-wiki experience more enjoyable.
下面是几个种类繁杂的特性，它们可以使制作eamcs-wiki的过程更加快乐。
Using pcomplete
使用pcomplete
If you have pcomplete loaded, you can type M-TAB to complete Wiki names. Hitting M-TAB two or more times in succession will cycle through all of the possibilities. You can find pcomplete.el in the contrib directory that comes with the emacs-wiki tarball.
如果你已经加载pcomplete, 你可以按下M-TAB来完成Wiki名称。成功的按M-TAB两次或更多次将会循环所有的可能。你可以在来自emacs-wiki tarball中贡献路径里找到pcompete.el

*ChangeLog*

日志变更
If you use a

ChangeLog

(C-x 4 a) within one of your Wiki directories, it will be used for notifying visitors to your Wiki of recent changes.
如果你在你的wiki路径里使用

ChangeLog

（C-x 4 a），它将被用来通知浏览者你日Wiki最近的变化。
Macros
Macros can be defined for text that you use often. Consult emacs-wiki-macros.el for information on using this feature.
为你经常使用的文本定义一个宏。请教`emacs-wiki-macros.el'来使用这个特点。
Menu
This feature allows you to make custom and auto-generated navigation menus. Please consult the top of the emacs-wiki-menu.el for reasonably complete documentation.
这个特性允许你制作一个自动生成的航行菜单。请教`emacs-wiki-menu.el'的顶部来完成文档。

10 Fancy Tables(幻想表)

To get fancy table markup, add:
为了获得幻想表标记，添加

(require 'emacs-wiki-table)

to your .emacs. In your wiki source files, you can now make tables that look like this:
到你的.emacs。在你的wiki源文件里，你现在可以像这样制作表格。

+------------------------------------------------------------------+
|                    A table header                                |
+-------------------------------+----------------------------------+
|           Column 1            |           Column 2               |
+-------------------------------+----------------------------------+
|Some text here                 |More text here, even wrapping to  |
|                               |the next line                     |
+-------------------------------+----------------------------------+
|Some text here                 |More text here, even wrapping to  |
|                               |the next line                     |
+-------------------------------+----------------------------------+

See table.el for more information.

参看table.el获取更多的信息。
emacs-wiki-table.el does not add any interactive functions or keybindings.
emacs-wiki-table.el不添加任何交互函数或按键绑定。

11 Multiple Projects(多个项目)

Emacs-wiki has a way of supporting multiple Wiki projects. This allows you to make links from one project to another, which are often called interwiki links. This can be convenient if you wish to split your website according to the kind of content, for example.
Emacs-wiki有支持多个Wiki项目的方法。它允许你设置从一个项目到另一个项目的链接，它常常被叫作内部Wiki链接(interwiki links)。如果你希望跟据内容的种类分割你的站点，这会非常方便。
For now, it is considered good practice to have your multiple projects under a common directory, and not to nest your projects.
目前，把你的多个项目放在一个通用的路径下并且不要嵌套你的项目是一个好的成熟的方法。
You will need something like the following in your .emacs file in order to set up multiple project support.
为了设置多项目支持，你需要在你的.emacs中加入一些东西：

(setq emacs-wiki-projects
`(("WebWiki" .
((emacs-wiki-directories . ("~/proj/wiki/webpage"))
(emacs-wiki-project-server-prefix . "../wiki/")
(emacs-wiki-publishing-directory
. "~/personal-site/site/wiki")))
("ProjectsWiki" .
((emacs-wiki-directories . ("~/proj/wiki/projects"))
(emacs-wiki-project-server-prefix . "../projects/")
(emacs-wiki-publishing-directory
. "~/personal-site/site/projects")))))

The first phrase on the second line of code is the name of the project. In this example, there are two projects,

WebWiki

and

ProjectsWiki

. It would be best for these names to be in mixed case.
代码的第二行的第一个短语是项目的名称。在这个例子中，有两个项目，

WebWiki

和

ProjectsWiki

。这种混合大小写的名称非常好。
The emacs-wiki-directories line indicates which source directories correspond with the particular project. This must be a list.
`emacs-wiki-directories'指定特定项目源码路径的坐标。它必须是一个列表。
emacs-wiki-project-server-prefix is the text that will be put at the beginning of each interwiki link at publish time. For example, ‘

WebWiki#MyPage

’ would be rendered ‘../wiki/MyPage.html’ in its published (HTML) form. It is also acceptable to give an absolute location here, like ‘/projects’, with the root directory corresponding to your root web publishing directory.
在发布的时候，`eamcs-wiki-project-server-prefix'是一个文本，它将会放在每一个interwiki链接的开头处。例如，`

WebWiki#MyPage

' 将以被发布的格式被渲染为"../wiki/MyPage.html。它也接受一个绝对的定位，例如`/projects',使用root路径同步到你的root web发布路径。
emacs-wiki-publishing-directory is the directory where the HTML content will be placed upon publishing the project. You should make sure that the content of emacs-wiki-project-server-prefix is such that a link from a file in one project to a file in another project is feasible.
在发布项目的时候，`emacs-wiki-publishing-directory'是放置HTML内容的路径。你应该确信 `emacs-wiki-project-server-prefix'是一个链接，它从一个项目到另一个项目的文件。
Other variables can also be defined in this block if you wish to customize a particular project further.
如果你以后希望自定义一个特别的项目，其它的变量也可以在这块定义。

12 Encryption(加密)

13 Getting Help and Reporting Bugs(获取帮助与报告Bugs)

14 Contributors(贡献者)

Appendix A GNU GENERAL PUBLIC LICENSE(GNU通用公共许可证)