2007年9月8日星期六

reStructuredText的Emacs支持:大纲视图

大纲视图

在一份长文档中导航通常是一件困难的事情。为此,特意提供了一个函数,它可以迅速 分析文档,然后将文档的目录结构以缩进的形式在一个临时buffer中展示出来。 在这个临时buffer中,你可以方便的导航,选中一个标题,按回车,就会跳到主文档中 相应的地方。

这个函数就是 rst-toc (快捷键是 C-c p t )。临时buffer看起来 象这样

Table of Contents:
Debugging Meta-Techniques
Introduction
Debugging Solution Patterns
Recognize That a Bug Exists
Subdivide and Isolate
Identify and Verify Assumptions
Use a Tool for Introspection
Change one thing at a time
Learn about the System
Understanding a bug
The Basic Steps in Debugging
Attitude
Bad Feelings
Good Feelings
References

选中一个节标题后,临时buffer会消失(译按:但窗口还在),光标停留在 文档中相应节标题的最左端。

插入目录

一份较长的文档开头通常会有一个目录。就象你在互联网上大多数FAQs中 看到的那样。对于 reStructuredText 文档,目录由分析器根据指令 .. contents:: 自动生成,人们通常并不会在源文档中再添加纯文本目录,因为编辑和维护它都是件很麻烦的事。

但是Emacs的 reStructuredText 插件提供了一个函数,可以在文档中插入这样的目录。 注意纯文本目录不应该成为文档的主体内容之一,你需要把它放在注释中,这样就可以被分析器忽略了。 以下是最常见的用法:

. contents::
..
1 Introduction
2 Debugging Solution Patterns
2.1 Recognize That a Bug Exists
2.2 Subdivide and Isolate
2.3 Identify and Verify Assumptions
2.4 Use a Tool for Introspection
2.5 Change one thing at a time
2.6 Learn about the System
3 Understanding a bug
4 The Basic Steps in Debugging
5 Attitude
5.1 Bad Feelings
5.2 Good Feelings
6 References

可以使用快捷键 C-c p i 来呼叫这个函数,目录会从当前光标处开始插入。 目录的内容是在插入点所在节中(译注:插入点必须在某一节中)级别更低的所有节标题。 这样你就可以(在合适的地方)方便地插入本节的局部目录。

如果你的节标题嵌套很深,可以使用数字前缀来限定显示的目录深度。

下面的变量通常用来定制目录的显示:rst-toc-indent, rst-toc-insert-style, rst-toc-insert-max-level

没有评论: