[Refdb-cvs] CVS: elisp refdb-mode-manual.xml,1.6,1.7
Status: Beta
Brought to you by:
mhoenicka
From: Markus H. <mho...@us...> - 2005-12-28 21:46:49
|
Update of /cvsroot/refdb/elisp In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv3963 Modified Files: refdb-mode-manual.xml Log Message: updated for 1.2 Index: refdb-mode-manual.xml =================================================================== RCS file: /cvsroot/refdb/elisp/refdb-mode-manual.xml,v retrieving revision 1.6 retrieving revision 1.7 diff -u -U2 -r1.6 -r1.7 --- refdb-mode-manual.xml 25 Dec 2005 00:30:18 -0000 1.6 +++ refdb-mode-manual.xml 28 Dec 2005 21:46:40 -0000 1.7 @@ -10,4 +10,5 @@ <affiliation><address><email>ma...@mh...</email></address></affiliation> </author> + <!-- the role attribute in the abstract element is required for the conversion to an info manual. This also explains the almost offending brevity of the abstract. --> <abstract role="texinfo-node"> <para>An Emacs minor mode for the RefDB reference manager and bibliography tool.</para> @@ -18,4 +19,5 @@ <para>refdb-mode turns GNU Emacs into a frontend for <ulink url="http://refdb.sourceforge.net">RefDB</ulink>, a reference manager and bibliography tool for markup languages. refdb-mode is a minor mode which works well alongside the major modes PSGML (SGML editing), nxml-mode (XML editing), and ris-mode (RIS editing). It offers a full set of menu commands for reference and notes management, allowing you to conveniently use Emacs to create or update references and notes. Moreover, it allows you to create DocBook and TEI documents for use with RefDB. You can transform the documents and view the results with a mouseclick. It integrates seamlessly into your authoring process, allowing you to search for references and yank them directly in place, without ever leaving Emacs. Finally, there is also a full set of administrative commands to control all aspects of RefDB configuration and administration.</para> <para>This manual gives a brief overview of how to use refdb-mode, followed by a more thorough description of all available commands.</para> + <para>Please visit the <ulink url="http://refdb.sourceforge.net">RefDB web page</ulink> for further information about RefDB and for the addresses of mailing lists where problems with refdb-mode can be discussed.</para> </preface> <chapter id="chapter-installation"> @@ -45,5 +47,5 @@ <prompt>root# </prompt><userinput>make install</userinput> </screen> - <para>The Lisp files proper will be installed into an appropriate <filename class="directory">site-lisp</filename> directory. The configuration file <filename>refdb-mode-config.el</filename> will be installed in your system configuration directory, which is either <filename class="directory">/etc</filename> or <filename class="directory">/usr/local/etc</filename> on most systems. The documentation will be installed in your documentation directory, usually <filename class="directory">/usr/share/doc/refdb-elisp</filename> or <filename class="directory">/usr/local/share/doc/refdb-elisp</filename>.</para> + <para>The Lisp files proper will be installed into an appropriate <filename class="directory">site-lisp</filename> directory. The configuration file <filename>refdb-mode-config.el</filename> will be installed in your system configuration directory, which is either <filename class="directory">/etc</filename> or <filename class="directory">/usr/local/etc</filename> on most systems. The HTML and PDF versions of the documentation will be installed in your documentation directory, usually <filename class="directory">/usr/share/doc/refdb-elisp</filename> or <filename class="directory">/usr/local/share/doc/refdb-elisp</filename>. An info version of the manual is also installed. You can view it from the command line using <command><userinput>info refdb-mode</userinput></command> or from within Emacs with the <menuchoice><guimenu>RefDB</guimenu><guimenuitem>Show Manual</guimenuitem></menuchoice> menu command.</para> <para>If you run more than one Emacs version, or if you want to test-drive refdb-mode without installing it system-wide, you can pass an alternative site-lisp directory to <command>configure</command> with the <option>--with-lispdir</option> option. Make sure that this directory is in your load path, e.g. by adding the following line to your <filename>.emacs</filename>:</para> <programlisting> @@ -1014,5 +1016,5 @@ </funcprototype> </funcsynopsis> - <para>Selects the output type of citations. The short and the full citation type are available.</para> + <para>Selects the output type of citations. The short and the full citation type are available. The default is full, and you should not change this unless you know what you're doing.</para> </sect3> <sect3 id="command-select-citation-output-format" xreflabel="Select Citation Output Format"> |