refdb-cvs

[Markus H. <mho...@us...>]

Update of /cvsroot/refdb/elisp
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv31588

Modified Files:
	refdb-mode-manual.xml 
Log Message:
updated for 1.1

Index: refdb-mode-manual.xml
===================================================================
RCS file: /cvsroot/refdb/elisp/refdb-mode-manual.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -U2 -r1.4 -r1.5
--- refdb-mode-manual.xml	18 Dec 2005 23:52:00 -0000	1.4
+++ refdb-mode-manual.xml	21 Dec 2005 20:40:19 -0000	1.5
@@ -78,5 +78,5 @@
       </note>
       <note>
-	<para>Path names need a little extra care on Windows. Save yourself a great deal of pain by adding all Win32 executables that you want to call (mainly viewers for RTF, PDF, and Postscript files) to your Windows PATH. In your <filename>/usr/local/etc/refdb-mode-config.el</filename> file, use the command names instead of the full paths of the viewing programs.</para>
+	<para>Path names need a little extra care on Windows. Save yourself a great deal of pain by adding all Win32 executables that you want to call (mainly viewers for RTF, PDF, and Postscript files) to your Windows PATH. In your <filename>/usr/local/etc/refdb-mode-config.el</filename> file, use the command names instead of the full paths of the viewing programs. Viewing HTML files is handled by browse-url which should be set up to use an external browser like Firefox. The Emacs w3 browser does not seem to grok the paths assembled by refdb-mode.</para>
 	</note>
        <programlisting>
@@ -114,5 +114,5 @@
       <para>This block of commands uses the Cygwin version of <command>bash</command> as the default shell. It also makes sure that a few additional directories are added to the path. Finally it tells NTEmacs that the data returned by the shell use the UTF-8 encoding as well. The paths shown here need to be adapted to your local installation.</para>
       <note>
-	<para>If you want to process SGML files, you'll have to set <envar>SGML_CATALOG_FILES</envar> in your <filename>.bashrc</filename> using Unix-style paths (bash, when called from NTEmacs, doesn't seem to evaluate <filename>/etc/profile</filename>).</para>
+	<para>If you want to process SGML files, you'll have to set <envar>SGML_CATALOG_FILES</envar> once in your <filename>.bashrc</filename> using Unix-style paths (bash, when called from NTEmacs, doesn't seem to evaluate <filename>/etc/profile</filename>) to make the catalogs available to OpenJade et al., and once in your system (the usual clicking odyssey in the control panel) using the Win32 paths. PSGML will use the latter when running under NTEmacs.</para>
       </note>
       <programlisting>
@@ -130,5 +130,5 @@
       </programlisting>
       <para>Finally, we also load nxml-mode to edit XML files. The setup of PSGML to edit SGML-files has been described <ulink url="http://www.mhoenicka.de/software/sgml/sgmlnt.html">elsewhere</ulink> (slightly outdated, though).</para>
-      <para>The final step to make nxml-mode work properly is to make the RefDB RelaxNG schemas known to the system. To this end, create or edit the file <filename>schemas.xml</filename> in <emphasis>what NTEmacs thinks is your home directory</emphasis>. This may be different from <filename class="directory">My Files</filename> (I prefer to set it to my <envar>HOME</envar> in Cygwin). The contents for the RefDB schemas looks like this:</para>
+      <para>The final step to make nxml-mode work properly is to make the RefDB RelaxNG schemas known to the system. To this end, create or edit the file <filename>schemas.xml</filename> in your home directory. The contents for the RefDB schemas looks like this:</para>
       <programlisting>
 &lt;locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0"&gt;
@@ -142,4 +142,5 @@
 &lt;/locatingRules&gt;
       </programlisting>
+      <para>You may have to run the command <keycombo><keycap>M</keycap><keycap>x</keycap></keycombo>customize-variable<keycap>RET</keycap>rng-schema-locating-files<keycap>RET</keycap> and add the path of your <filename>schemas.xml</filename> to the existing list of schema files. <emphasis>Do not</emphasis> use a drive letter but start the path with a slash, like in the file itself.</para>
     </sect1>
   </chapter>
@@ -269,5 +270,6 @@
 	<para>By default, the document using the full citation format will be loaded as refdb-mode can handle the link normalization on its own. However, if you have a reason to do so you can configure refdb-mode to load the document using the short citation format.</para>
       </note>
-      <para>To add citations to your document, use the appropriate <xref linkend="submenu-get-references"/> or <xref linkend="submenu-get-references-on-region"/> commands to retrieve the references you want to cite. Then either move point into the reference that you want to cite, or set mark and point to select several references. Use the appropriate command of the <xref linkend="submenu-cite-references"/> submenu to add the citation(s) to the kill ring. Now switch back to your source document and use <keycombo><keycap>C</keycap><keycap>y</keycap></keycombo> to yank the citation in place.</para>
+      <para>To add citations to your document, use the appropriate <xref linkend="submenu-get-references"/> or <xref linkend="submenu-get-references-on-region"/> commands to retrieve the references you want to cite. Then either move point into the reference that you want to cite, or set mark and point to select several references. Use the appropriate command of the <xref linkend="submenu-cite-references"/> submenu to add the citation(s) to the kill ring. Now switch back to your source document and use <keycombo><keycap>C</keycap><keycap>y</keycap></keycombo> to yank the citation in place. The default citation format works with XML documents. If you're editing SGML documents, use the <menuchoice><guimenu>RefDB</guimenu><guisubmenu>Customize Data Output</guisubmenu><guimenuitem>Select Citation Output Format</guimenuitem></menuchoice> menu command to switch to SGML.</para>
+      <para>It is also easy to do a reverse lookup, i.e. display the references in a citation. To this end, place point somewhere into a citation and run the <menuchoice><guimenu>RefDB</guimenu><guimenuitem>Get References from Citation</guimenuitem></menuchoice> menu command.</para>
     </sect1>
   </chapter>
@@ -1012,5 +1014,16 @@
 	    </funcprototype>
 	  </funcsynopsis>
-	  <para>Selects the output type of citations. The short and the full citation format are available.</para>
+	  <para>Selects the output type of citations. The short and the full citation type are available.</para>
+	</sect3>
+	<sect3 id="command-select-citation-output-format" xreflabel="Select Citation Output Format">
+	  <title>Select Citation Output Format</title>
+	  <indexterm><primary sortas="select-citation-format">refdb-select-citation-format</primary></indexterm>
+	  <funcsynopsis>
+	    <funcprototype>
+	      <funcdef><function>refdb-select-citation-format</function></funcdef>
+	      <paramdef><parameter>citationformat</parameter></paramdef>
+	    </funcprototype>
+	  </funcsynopsis>
+	  <para>Selects the output format of citations. The default is the XML syntax, but you can select the SGML syntax for SGML documents. The <sgmltag class="element">xref</sgmltag> element is empty, therefore the XML version requires an additional slash to denote this fact.</para>
 	</sect3>
       </sect2>
@@ -1173,5 +1186,5 @@
 	    </funcprototype>
 	  </funcsynopsis>
-	  <para>Adds the XML data using the citestylex.dtd in the current buffer to the system database. refdb-mode will refuse to add the data if nxml-mode indicates they are invalid.</para>
+	  <para>Adds the XML data using the citestylex.dtd in the current buffer to the system database. refdb-mode will refuse to add the data if nxml-mode indicates they are invalid. If the database already contains a style with the given name, it will be replaced with the new version.</para>
       </sect2>
       <sect2 id="command-list-styles" xreflabel="List Styles">