path: root/docs-emacs-zh_CN.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Id: docs-emacs-zh_CN.xml,v 1.2 2005/12/17 13:28:38 bbbush Exp $ --><chapter id="ch-emacs">
  <title>Emacs 与 PSGML 模式</title>
  <indexterm>
    <primary>PSGML</primary>
  </indexterm>
  <indexterm>
    <primary>Emacs</primary>
  </indexterm>
  <indexterm>
    <primary>Emacs</primary>
    <secondary>PSGML 模式</secondary>
  </indexterm>
  <para>您可以利用 Emacs 的 PSGML 模式以使编辑 XML 格式更容易。PSGML 模式提供了语法高亮，标记补全等功能。</para>
  <sect1 id="s1-emacs-file">
    <title>设置您的 <filename>.emacs</filename></title>
    <indexterm>
      <primary>Emacs</primary>
      <secondary>配置文件</secondary>
    </indexterm>
    <indexterm>
      <primary>
        <filename>.emacs</filename>
      </primary>
    </indexterm>
    <para>为使 Emacs 可以正确解析您的 DocBook 文档，您必须定制一个 <filename>.emacs</filename> 文件。将下列内容复制并粘贴到您已有的 <filename>.emacs</filename> 文件中，或者创建一个包含下列内容的新文件：<screen><computeroutput>
;; turn on auto-fill in `text-mode' and derived modes 
;;(mail, news, etc)
(add-hook 'text-mode-hook 'turn-on-auto-fill)

;;
;;MODES
;;

(setq auto-mode-alist (cons '("\\.sgml$" . sgml-mode) auto-mode-alist))
(setq auto-mode-alist (cons '("\\.sgm$" . sgml-mode) auto-mode-alist))

;;
;;XML!!
;;
;;#############################################################

;;
;;PSGML mode stuff
;;

(autoload 'sgml-mode "psgml" "My Most Major Mode" t)

(setq sgml-mode-hook '(lambda () "Defaults for XML mode." (turn-on-auto-fill) 
(setq fill-column 80)))

(defun My-XML-keymap ()
  (local-set-key [(alt i)] 
                 '(lambda ()
                    (interactive)
                    (sgml-indent-line)
                    (sgml-insert-element 'item)
                    (sgml-indent-line)))
  (local-set-key [(alt l)] 
                 '(lambda ()
                    (interactive)
                    (sgml-insert-element 'list)
                    (sgml-insert-element 'item)
                    (sgml-indent-line)))
  (local-set-key [(alt p)]
                 '(lambda ()
                    (interactive)
                    (sgml-indent-line)
                    (sgml-insert-element 'para)
                    (sgml-indent-line)))
  (local-set-key [(alt -)]
                 '(lambda ()
                    (interactive)
                    (insert "&mdash;"))))      

(add-hook 'sgml-mode-hook 'My-XML-keymap)

;;
;; Fix up indentation of data...
;;

(setq-default sgml-indent-data t)

;;
;; XML markup faces.
;;

(setq-default sgml-set-face t)


(make-face 'sgml-comment-face)
(make-face 'sgml-doctype-face)
(make-face 'sgml-end-tag-face)
(make-face 'sgml-entity-face)
(make-face 'sgml-ignored-face)
(make-face 'sgml-ms-end-face)
(make-face 'sgml-ms-start-face)
(make-face 'sgml-pi-face)
(make-face 'sgml-sgml-face)
(make-face 'sgml-short-ref-face)
(make-face 'sgml-start-tag-face)

(set-face-foreground 'sgml-comment-face "maroon")
(set-face-foreground 'sgml-doctype-face "dark green")
(set-face-foreground 'sgml-end-tag-face "blue2")
(set-face-foreground 'sgml-entity-face "red2")
(set-face-foreground 'sgml-ignored-face "maroon")
(set-face-background 'sgml-ignored-face "gray90")
(set-face-foreground 'sgml-ms-end-face "maroon")
(set-face-foreground 'sgml-ms-start-face "maroon")
(set-face-foreground 'sgml-pi-face "maroon")
(set-face-foreground 'sgml-sgml-face "maroon")
(set-face-foreground 'sgml-short-ref-face "goldenrod")
(set-face-foreground 'sgml-start-tag-face "blue2")

(setq-default sgml-markup-faces
              '((comment . sgml-comment-face)
                (doctype . sgml-doctype-face)
                (end-tag . sgml-end-tag-face)
                (entity . sgml-entity-face)
                (ignored . sgml-ignored-face)
                (ms-end . sgml-ms-end-face)
                (ms-start . sgml-ms-start-face)
                (pi . sgml-pi-face)
                (sgml . sgml-sgml-face)
                (short-ref . sgml-short-ref-face)
                (start-tag . sgml-start-tag-face)))


(defun docbook-mode ()
  (sgml-mode)
  )



;;
;;END XML STUFF
;;
;;##################################################################

;PO mode stuff

(setq auto-mode-alist
	(cons '("\\.pox?\\'" . po-mode) auto-mode-alist))
(autoload 'po-mode "po-mode")


 (global-set-key [(f1)] (lambda () (interactive) (manual-
       entry (current-word))))

</computeroutput></screen></para>
    <para>您是否有一个滚轮鼠标？如果是，那么可以将下列内容加入您的 <filename>.emacs</filename>，这样您的滚轮将可以用在 <application>Emacs</application> 中 (适于 <application>Emacs</application> 版本 21)：</para>
    <screen>
      <computeroutput>
;; Enable wheelmouse support by default for emacs 21
(cond (window-system
(mwheel-install)
))
</computeroutput>
    </screen>
    <para>如果您使用旧的 20 版本，应添加下列内容：</para>
    <screen>
      <computeroutput>
;; Enable wheelmouse support by default
(require 'mwheel)
</computeroutput>
    </screen>
  

<!-- bug #125757 in NEEDINFO state
      <para>
	If you have a mouse, you can also add the following. It adds popup menus
	when the cursor is either on a start tag or in a region where elements
	are allowed.
      </para>

<screen>
<computeroutput>
;; Mouse Bindings: right-click to generate context-aware 
;; elements/attributes popup menu.
(define-key sgml-mode-map [mouse-3] 'sgml-tags-menu)
</computeroutput>
</screen>

-->

    </sect1>
  <sect1 id="s1-emacs-colors">
    <title>定制 Emacs</title>
    <indexterm>
      <primary>Emacs</primary>
      <secondary>定制</secondary>
    </indexterm>
    <indexterm>
      <primary>
        <filename>.Xresources</filename>
      </primary>
    </indexterm>
    <indexterm>
      <primary>Emacs</primary>
      <secondary>colors</secondary>
    </indexterm>
    <indexterm>
      <primary>Emacs</primary>
      <secondary>font</secondary>
    </indexterm>
    <indexterm>
      <primary>Emacs</primary>
      <secondary>geometry</secondary>
    </indexterm>
    <para>在您的 <filename>~/.Xresources</filename> 中配置 Emacs 的颜色，字体和默认窗口大小。设置的格式是 <computeroutput>emacs.keyword:value</computeroutput></para>
    <para>下面是一个 <filename>~/.Xresources</filename> 文件范例。</para>
    <note>
      <title>注意</title>
      <para>如果您的 <filename>~/.Xresources</filename> 中包含其他设置，就将下列内容添加到文件结尾。</para>
    </note>
    <screen>
      <userinput>
emacs.background: light gray
emacs.foreground: black
emacs.pointerColor: blue
emacs.cursorColor: blue
emacs.bitmapIcon: on
emacs.font: fixed
emacs.geometry: 90x25          
</userinput>
    </screen>
    <para>修改文件后，您必须执行命令</para>
    <screen>
      <command>xrdb -merge ~/.Xresources</command>
    </screen>
    <para>并且重新运行 <application>Emacs</application> 以使改变生效。</para>
  </sect1>
  <sect1 id="s1-emacs-cedfile">
    <title>创建重编译的 DTD 子集</title>
    <para>如果给出了正确的文档类型声明 (DTD) 文件，Emacs 可以对 DocBook XML 文件进行正确的语法高亮和缩进。这些特性将使您的 XML 文件易于阅读，帮助您发现错误。</para>
    <para>要创建一个可加载的已解析的 DTD 文件：<orderedlist><listitem><para>找到一组 DocBook 文件的主控文件。您可以通过头部是否包含 <filename>&lt;!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.1//EN"</filename> 来找到它。最简单的办法，是运行命令 <command>grep DocBook *.xml</command>。找到主控文件后，在 Emacs 中打开它，命令是 <command>emacs <replaceable>&lt;parentfile&gt;</replaceable>.xml</command> (这里 <replaceable>&lt;parentfile&gt;</replaceable>.xml 是你找到的主控文件)。</para></listitem><listitem><para>在下拉菜单中选择 <command>DTD -&gt; Parse DTD</command>。</para></listitem><listitem><para>当您看到屏幕下方的 <computeroutput>Fontifying...done</computeroutput> 信息时，解析就完成了。将已解析的 DTD 保存为文件，方法是在下拉菜单中选择 <command>DTD -&gt; Save Parsed DTD</command>。</para></listitem><listitem><para>按下 <keycap>Enter</keycap> 来保存为默认文件名，或者修改文件名，但应保留 <filename>.ced</filename> 扩展名。可以将它命名为 <filename>docbook.ced</filename> 这样很通用的名字，这样您在打开所有 DocBook 文件的时候都可以引用它。这个文件也可以复制到要加载的目录中。</para></listitem></orderedlist></para>
    <tip>
      <title>技巧</title>
      <para>您也可以使用 Emacs 命令 <command>Meta-x sgml-parse-prolog</command> 来解析这个文件，然后用命令 <command>Meta-x sgml-save-dtd</command> 来保存已解析的 DTD 到 <filename>.ced</filename> 文件中。</para>
    </tip>
  </sect1>
  <sect1 id="s1-emacs-loadced">
    <title>加载已解析的 DTD</title>
    <para>现在您已保存了 DTD 设置，您可以加载这个 <filename>.ced</filename> 文件，看看 <filename>.sgml</filename> 文件语法高亮的效果。</para>
    <para>要加载已解析的 DTD 文件：<orderedlist><listitem><para>在 Emacs 中打开 XML 文件</para></listitem><listitem><para>在下拉菜单中选择 <command>DTD -&gt; Load DTD</command> 然后选择您在上一步保存的文件。例如，选择 <filename>docbook.ced</filename>。</para></listitem><listitem><para>当您看到屏幕下方的 <computeroutput>Fontifying...done</computeroutput> 信息时，就加载完毕了。加载已解析的 DTD 可能需要很久。您可以在加载完毕前就开始编辑。</para></listitem></orderedlist></para>
    <tip>
      <title>技巧</title>
      <para>您也可以使用 Emacs 命令 <command>Meta-x sgml-load-dtd</command> 来加载已翻译的 DTD。</para>
    </tip>
  </sect1>
  <sect1 id="s1-emacs-basic-commands">
    <title>基本的 Emacs 命令</title>
    <para>
      <keycap>Meta</keycap> 键通常指的是 <keycap>Alt</keycap> 键。</para>
    <table colsep="1" frame="all" id="tb-emacs-commands" rowsep="1">
      <title>Emacs 命令</title>
      <tgroup cols="2" colsep="1" rowsep="1">
        <colspec colname="shortcut" colnum="1" colwidth="170"/>
        <colspec colname="description" colnum="2" colwidth="300"/>
        <thead>
          <row>
            <entry colsep="1" rowsep="1">快捷方式</entry>
            <entry colsep="1" rowsep="1">描述</entry>
          </row>
        </thead>
        <tbody>
          <row>
            <entry colsep="1" rowsep="1">
              <keycombo>
                <keycap>Meta</keycap>
                <keycap>x</keycap>
              </keycombo> sgml-parse-prolog, <keycap>Enter</keycap></entry>
            <entry>解析 DTD</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Meta</keycap>
                <keycap>x</keycap>
              </keycombo>sgml-save-dtd, <keycap>Enter</keycap></entry>
            <entry>保存已解析的 DTD</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Meta</keycap>
                <keycap>x</keycap>
              </keycombo>sgml-load-dtd, <keycap>Enter</keycap></entry>
            <entry>加载 DTD</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Ctrl</keycap>
                <keycap>c</keycap>
              </keycombo>, <keycombo><keycap>Shift</keycap><keycap/></keycombo>, <keycap>Tab</keycap></entry>
            <entry>显示有效标记的列表</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Ctrl</keycap>
                <keycap>c</keycap>
              </keycombo>, <keycombo><keycap>Shift</keycap><keycap/></keycombo>, type beginning of tag, <keycap>Tab</keycap></entry>
            <entry>补全标记</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Ctrl</keycap> <keycap>g</keycap></keycombo>
            </entry>
            <entry>取消 minibuffer 中的命令</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Ctrl</keycap>
                <keycap>c</keycap>
              </keycombo>, <keycap>/</keycap></entry>
            <entry>关闭标记</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Ctrl</keycap> <keycap>a</keycap></keycombo>
            </entry>
            <entry>将光标移动到行首</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Ctrl</keycap>
                <keycap>e</keycap>
              </keycombo>
            </entry>
            <entry>将光标移动到行尾</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Ctrl</keycap>
                <keycap>Home</keycap>
              </keycombo>
            </entry>
            <entry>将光标移动到文件开始</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Ctrl</keycap>
                <keycap>End</keycap>
              </keycombo>
            </entry>
            <entry>将光标移动到文件结束</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Ctrl</keycap>
                <keycap>k</keycap>
              </keycombo>
            </entry>
            <entry>剪切一行</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Ctrl</keycap> <keycap>y</keycap></keycombo>
            </entry>
            <entry>粘贴一行</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Ctrl</keycap> <keycap>s</keycap></keycombo>
            </entry>
            <entry>在文件中向前搜索</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Ctrl</keycap>
                <keycap>r</keycap>
              </keycombo>
            </entry>
            <entry>在文件中向后搜索</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Meta</keycap>
                <keycap>$</keycap>
              </keycombo>
            </entry>
            <entry>检查当前单词的拼写</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Meta</keycap>
                <keycap>x</keycap>
              </keycombo> ispell-word, <keycap>Enter</keycap></entry>
            <entry>检查当前单词的拼写</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Meta</keycap>
                <keycap>x</keycap>
              </keycombo> ispell-buffer, <keycap>Enter</keycap></entry>
            <entry>检测当前 buffer 的拼写</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Ctrl</keycap>
                <keycap>x</keycap>
              </keycombo>, <keycombo><keycap>Ctrl</keycap><keycap>f</keycap></keycombo></entry>
            <entry>打开文件</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Ctrl</keycap>
                <keycap>x</keycap>
              </keycombo>, <keycombo><keycap>Ctrl</keycap><keycap>s</keycap></keycombo></entry>
            <entry>保存文件</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Ctrl</keycap>
                <keycap>x</keycap>
              </keycombo>, <keycombo><keycap>Ctrl</keycap><keycap>c</keycap></keycombo></entry>
            <entry>退出 <application>Emacs</application>，在需要时提示保存文件</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Meta</keycap> <keycap>q</keycap></keycombo>
            </entry>
            <entry>段落重排</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Ctrl</keycap>
                <keycap>c</keycap>
              </keycombo>, <keycombo><keycap>Ctrl</keycap><keycap>a</keycap></keycombo></entry>
            <entry>编辑标记的属性 (例如，您可以编辑 <computeroutput>ulink</computeroutput> 标记的 <computeroutput>url</computeroutput> 属性)</entry>
          </row>
          <row>
            <entry>
              <keycombo>
                <keycap>Ctrl</keycap>
                <keycap>c</keycap>
              </keycombo>, <keycombo><keycap>Ctrl</keycap><keycap>c</keycap></keycombo></entry>
            <entry>结束编辑属性</entry>
          </row>
        </tbody>
      </tgroup>
    </table>
  </sect1>
  <sect1 id="s1-emacs-examples">
    <title>范例</title>
    <para>Emacs 和 PSGML 的命令表 (参考卡片) 对于新手来说有些难。本节有一些例子，讲解如何使用它们。</para>
    <sect2 id="s2-emacs-tag-completion">
      <title>标记补全</title>
      <note>
        <title>注意</title>
        <para>本节假设您已经加载了 DTD 文件 (<filename>.ced</filename>)。</para>
      </note>
      <para>需要插入标记时，不要输入它。按下组合键 <keycap>Ctrl</keycap>-<keycap>c</keycap>, 然后按下 <keycap>&lt;</keycap>。在 <application>Emacs</application> 窗口的下方，您将看到：</para>
      <screen>
        <computeroutput>Tag: &lt;</computeroutput>
      </screen>
      <para>要查看所有标记的列表，按下 <keycap>Tab</keycap> 或 <keycap>?</keycap>。如果您知道标记的首字母，可以按下它们，然后按 <keycap>Tab</keycap>，就可以看到有同样首字母的所有标记的列表。</para>
      <para>尝试这样：按下 <keycap>Ctrl</keycap>-<keycap>c</keycap> 然后按 <keycap>&lt;</keycap>，然后按下字母 <keycap>k</keycap>，然后按 <keycap>Tab</keycap>。为了得到完整的列表，您可能需要多次按下 <keycap>Tab</keycap>。</para>
      <para>输出应当与下面类似：</para>
      <screen>
        <computeroutput>
Click mouse-2 on a completion to select it.
In this buffer, type RET to select the completion near point.

Possible completions are:
&lt;keycap&gt;                 &lt;keycode&gt;
&lt;keycombo&gt;               &lt;keysym&gt;
</computeroutput>
      </screen>
    </sect2>
    <sect2 id="s2-emacs-tag-closing">
      <title>标记关闭</title>
      <para>当您开始了一个标记后，您必须关闭它。按下组合键 <keycap>Ctrl</keycap>-<keycap>c</keycap>，然后按 <keycap>/</keycap>。这样将关闭最近一个开放的标记。</para>
    </sect2>
    <sect2 id="s2-emacs-other">
      <title>其他 Emacs 任务</title>
      <para>
        <guilabel>恢复单个窗口</guilabel>: 有时 <application>Emacs</application> 窗口被划分 (下方的窗口有标记补全等内容)。要恢复到只有您的 XML 文本全屏显示的状态，最简单的办法是按下 <keycap>Ctrl</keycap>-<keycap>x</keycap>，然后按 <keycap>1</keycap>。</para>
      <para>
        <guilabel>保存作品</guilabel>: 要保存编辑结果，按下 <keycap>Ctrl</keycap>-<keycap>x</keycap> 然后按 <keycap>Ctrl</keycap>-<keycap>s</keycap>。</para>
      <para>
        <guilabel>"清除/返回"命令</guilabel>:有时，在标记补全中玩得太多，需要直接返回编辑时，按下 <keycap>Ctrl</keycap>-<keycap>g</keycap>。这个命令将放弃当前动作，而不会关闭文件本身。</para>
      <para>
        <guilabel>打开文件</guilabel>: 要打开一个新文件，按下 <keycap>Ctrl</keycap>-<keycap>x</keycap> 然后按 <keycap>Ctrl</keycap>-<keycap>f</keycap>。在窗口下方，可以输入要打开文件名 (这里也可以使用 <keycap>Tab</keycap> 补全)。</para>
      <para>
        <guilabel>关闭 emacs</guilabel>: 要关闭 <application>emacs</application>，按下 <keycap>Ctrl</keycap>-<keycap>x</keycap> 然后按 <keycap>Ctrl</keycap>-<keycap>c</keycap>。如果您尚未保存，它将提示，否则它会简单地退出。</para>
    </sect2>
  </sect1>
  <sect1 id="s1-emacs-additional-resources">
    <title>其他资源</title>
    <para>其他 Emacs 和 PSGML 参考可以在这里找到：</para>
    <itemizedlist>
      <listitem>
        <para>
          <ulink url="http://wks.uts.ohio-state.edu/unix_course/intro-135.html">http://wks.uts.ohio-state.edu/unix_course/intro-135.html</ulink> &mdash; <citetitle>Emacs Quick Reference Guide</citetitle></para>
      </listitem>
      <listitem> <para><filename>emacs</filename> 软件包附带了 Emacs 参考卡片。您可以打印一份，作为参考。&mdash; <filename>/usr/share/emacs/<replaceable>&lt;version&gt;</replaceable>/etc/refcard.ps</filename></para></listitem>
      <listitem>
        <para>
          <filename>/usr/share/doc/psgml-<replaceable>&lt;version&gt;</replaceable>/psgml.ps</filename> 中的 <citetitle>Editing XML with Emacs and PSGML</citetitle>。</para>
      </listitem>
      <listitem>
        <para>
          <ulink url="http://www.snee.com/bob/sgmlfree/psgmqref.html">http://www.snee.com/bob/sgmlfree/psgmqref.html</ulink> &mdash; <citetitle>Emacs/PSGML Quick Reference</citetitle> 是一个 Emacs PSGML 模式的索引表。</para>
      </listitem>
      <listitem>
        <para>
          <ulink url="http://www.snee.com/bob/sgmlfree/emcspsgm.html">http://www.snee.com/bob/sgmlfree/emcspsgm.html</ulink> &mdash; <citetitle>PSGML Tricks</citetitle></para>
      </listitem>
    </itemizedlist>
  </sect1>
</chapter>