[Refdb-cvs] CVS: homepage addons.html,NONE,1.1

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

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

Added Files:
	addons.html 
Log Message:
initial version

--- NEW FILE ---
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">


  <!-- $Id -->


  <head>

    <title>RefDB add-ons</title>

    <meta name="author" content="Markus Hoenicka" />

    <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />

    <meta name="description" content="Homepage of the RefDB project, a reference manager and bibliography tool for structured texts" />

    <link rel="stylesheet" type="text/css" href="refdbn.css" title="RefDB" media="screen, projection" />

    <link rel="alternate stylesheet" type="text/css" href="refdbprint.css" title="Printer friendly" media="print, embossed, screen, projection" />

  </head>


  <body>


    <!-- the page header, to be displayed across the top of the page -->

    <div id="head">

      <div id="headleft">

	<a href="http://refdb.sourceforge.net/"><img src="logo.jpg" alt="logo"  border="0" /></a>

      </div>

      <div id="headright">

	<table>

	  <tbody>

	    <tr>

	      <td class="tag">&lt;</td>

	      <td class="graphic">&nbsp;</td>

	      <td class="tag">/&gt;</td>

	    </tr>

	    <tr>

	      <td>&nbsp;</td>

	      <td class="text">bibliographies beyond word processors</td>

	      <td>&nbsp;</td>

	    </tr>

	  </tbody>

	</table>

      </div>

    </div>


    <div id="left">

    <!-- the navigation box -->

    <div class="leftcontent">

      <table class="nav">

	<thead>

	  <tr>

	    <td class="nav">Navigation</td>

	  </tr>

	</thead>

	<tbody>

	  <tr>

	    <td class="nav"><a href="index.html">Home</a></td>

	  </tr>

	  <tr>

	    <td class="nav"><a href="features.html">Features</a></td>

	  </tr>

	  <tr>

	    <td class="nav"><a href="features.html">System requirements</a></td>

	  </tr>

	  <tr>

	    <td class="nav"><a href="status.html">Current Status</a></td>

	  </tr>

	  <tr>

	    <td class="nav"><a href="doc.html">Documentation</a></td>

	  </tr>

	  <tr>

	    <td class="nav"><a href="examples.html">Examples</a></td>

	  </tr>

	  <tr>

	    <td class="nav"><a href="download.html">Download</a></td>

	  </tr>

	  <tr>

	    <td class="navsel">Add-ons</td>

	  </tr>

	</tbody>

      </table>

    </div>


    <div class="leftcontent">

      <table class="nav">

	<thead>

	  <tr>

	    <td class="nav">Links</td>

	  </tr>

	</thead>

	<tbody>

	  <tr>

	    <td class="nav"><a href="http://www.sourceforge.net/projects/refdb">Project page</a></td>

	  </tr>

	  <tr>

	    <td class="nav"><a href="http://sourceforge.net">

	      <img src="http://sourceforge.net/sflogo.php?group_id=26091&amp;type=1" width="88" height="31" border="0" alt="SourceForge Logo" /></a></td>

	  </tr>

	  <tr>

	    <td class="nav"><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" border="0" /></a></td>

	  </tr>

	  <tr>

	    <td class="nav"><a href="http://jigsaw.w3.org/css-validator/"><img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" border="0" /></a></td>

	  </tr>

	</tbody>

      </table>

    </div>

    </div>


    <!-- the main text area, fills most of the page -->

    <div id="main">

      <h1>RefDB add-ons</h1>

      <p>Useful software which is not packaged with RefDB but which greatly enhances your experience is available from this page. There are RIS editing modes for Emacs and for Vim (remember that you can use any run-of-the-mill XML mode or XML editor for editing risx files), a RefDB frontend for Emacs, a script to write bibliography styles from scratch, and a Client module for Perl programmers.</p>


      <div class="localnav">

	<table class="localnav">

	  <thead>

	    <tr>

	      <td class="localnav">On this page</td>

	    </tr>

	  </thead>

	  <tbody>

	    <tr>

	      <td class="localnav"><a href="#ris-mode">Emacs ris-mode</a></td>

	    </tr>

	    <tr>

	      <td class="localnav"><a href="#refdb-mode">Emacs refdb-mode</a></td>

	    </tr>

	    <tr>

	      <td class="localnav"><a href="#vim">Vim syntax, filetype and plugin files</a></td>

	    </tr>

	    <tr>

	      <td class="localnav"><a href="#makestyle">Makestyle (bibliography style generator)</a></td>

	    </tr>

	    <tr>

	      <td class="localnav"><a href="#perlmod">Perl client module</a></td>

	    </tr>

	  </tbody>

	</table>

      </div>


      <h2 id="ris-mode">Emacs ris-mode</h2>

      <p>Author: Markus Hoenicka &lt;mho...@us...&gt;</p>

      <p>If your editor of choice should be <a href="http://directory.fsf.org/emacs.html">Emacs</a> or <a href="http://www.xemacs.org/">XEmacs</a>, the RIS major mode (ris.el) will make editing RIS datasets a little bit more comfortable.</p>

      <ul>

	<li>Font-locking will help you to spot syntax errors. Especially the end tag (ER - ) is prone to lack the trailing space if you're not careful. The ris-mode displays valid tags in blue, except the special type (TY - ) and end (ER - ) tags which are shown in red. The tag contents are colored according to several criteria. If the contents of a field is limited in length, the color will extend only up to that limit. Author/editor, publication date, and reprint fields are checked for a valid content.</li>

	<li>ris-mode provides three commands to insert datasets ("references") and individual tags as described shortly. All of these commands have in common that they always start a new line after the current line if the cursor is not at the start of a line. Thus you can run these commands from any position of the current line and still get something that makes sense as a RIS dataset.</li>

	<li>Run the command <code>insert-set</code> (C-c-C-s) to insert a new skeleton dataset (a "reference"). The function will prompt you to enter the publication type. You can use either the auto-completion feature of the minibuffer to enter a valid type or the history feature to select a previously entered type. The function will create a newline, a type tag with the type you selected, default sets of tags for a selected range of types, as well as an end tag.</li>

	<li>You can insert a new tag at the beginning of a line with the command <code>insert-tag</code> which is bound to C-c-C-t. Use either the auto-completion feature of the minibuffer to enter a valid tag or the history feature to select a previously entered tag.</li>

	<li>You can insert a new line below the current line with the same tag as the current line with the command <code>duplicate-tag</code>. This is bound to M-RET. This command is convenient if you add multiple keywords or authors, each of which have to go on separate tag lines.</li>

	<li>You can move between RIS datasets with the commands <code>backward-set</code> (C-x[) and <code>forward-set</code> (C-x]). You can narrow the buffer to the current RIS set with the command <code>narrow-to-set</code> (C-xns). To widen to the full buffer contents again you'd use C-xnw as usual.</li>

      </ul>


      <p>The mode currently does not check the length of author entries, nor does it handle continued lines in any way. It does not attempt to check whether a reference is complete (e.g. it won't notify you if there is no author)</p>


      <p>To install this mode on your system, follow the instructions in the manual or in the elisp code. <a href="addons/ris.el">Download ris.el (1.9)</a></p>


      <p class="legend"><a href="rismode.png"><img alt="Emacs ris-mode" src="rismode-small.jpg"/></a></p>

      <p class="legend"><strong>Fig. 1:</strong> Emacs ris-mode. Click on the image to see a <a href="rismode.png">larger version</a>. The reference shows the effects of a few common syntax errors: (1) the last author has a space after the period, (2) the secondary publication date lacks the mandatory slashes, (3) the JF tag is misspelled, and (4) the ER tag lacks the trailing space. Note also that fields with unlimited length (like AD) and fields with limited length (like KW) are colored differently.</p>


      <h2 id="refdb-mode">Emacs refdb-mode</h2>

      <p>Author: Michael Smith &lt;xm...@us...&gt;</p>

      <p>This minor mode for <a href="http://directory.fsf.org/emacs.html">Emacs</a> and <a href="http://www.xemacs.org/">XEmacs</a> is a frontend for the most common RefDB commands. It works nicely alongside the major modes ris-mode, nxml-mode, and PSGML. It provides menu entries to add, update, delete, and search for references. Retrieved references in either RIS or risx format can be edited in place and subsequently be updated in the database. HTML and XHTML output can be sent to a browser of your choice (including the built-in w3 mode) automatically.</p>


      <p>To install this mode on your system, follow the instructions in the elisp code. <a href="addons/refdb-mode.el">Download refdb-mode.el (1.9)</a></p>


      <p class="legend"><a href="refdbmode.png"><img alt="Emacs refdb-mode" src="refdbmode-small.jpg"/></a></p>

      <p class="legend"><strong>Fig. 2:</strong> Emacs refdb-mode. Click on the image to see a <a href="refdbmode.png">larger version</a>. The menu allows easy access to the most common reference manipulation commands.</p>


      <h2 id="vim">Vim syntax, filetype and plugin files</h2>

      <p>Author: David Nebauer &lt;dav...@sw...&gt;</p>

      <p>If <a href="http://www.vim.org">Vim</a> is the editor of your choice, this set of files comes in handy to edit RIS files.</p>

      <ul>

	<li>The syntax file enables Vim to highlight legal tags and mark illegal tags as errors.</li>

	<li>It also highlights correct field values, thus helping users to avoid invalid field values.</li>

	<li>It checks the syntax of author names, dates and journal abbreviation fields.</li>

	<li>It checks the values in reprint and pubtype fields.</li>

	<li>It checks the length of length-limited fields and does some other rudimentary error checking.</li>

      </ul>


      <p>What the syntax file does <b>not</b> currently do is:</p>

      <ul>

	<li>check the length of the 'otherinfo' component of a date field</li>

	<li>handle line continuations ('/$') -- it assumes all fields are a single line</li>

      </ul>


      <p>The plugin file supplies four convenience commands mapped to keyboard shortcuts:</p>

      <ul>

	<li>\a  = insert RIS tag (select from menu)</li>

	<li>\p  = insert publication type (select from menu)</li>

	<li>\d  = duplicate current/previous tag</li>

	<li>\t  = add reference template (group of blank tags; choose from three templates: journal|book|other)</li>

      </ul>


      <p>To install these files on your system, follow the instructions in the archive. <a href="addons/vimhelper-1.0.tar.gz">Download vimhelper.tar.gz (1.0)</a></p>


      <p class="legend"><a href="vim.png"><img alt="Vim editing RIS" src="vim-small.jpg"/></a></p>

      <p class="legend"><strong>Fig. 3:</strong> Vim editing RIS. Click on the image to see a <a href="vim.png">larger version</a>. The image shows how Vim spots a few of the common syntax errors: (1) the second author uses a space after the comma, (2) the publication date lacks the mandatory slashes, and (3) the end tag lacks the trailing space.</p>


      <h2 id="makestyle">Makestyle (bibliography style generator)</h2>

      <p>Author: David Nebauer &lt;dav...@sw...&gt;</p>

      <p>refdb-ms is a Perl script which helps to write bibliography and citation style specifications for RefDB from scratch. If a regular XML editor does not feel right for you, try this script. It shows valid elements at the current point, just like an XML editor would do, but provides additional help about the purpose of each element.</p>


      <p>To install the script on your system, follow the instructions in the archive. <a href="addons/makestyle-1.0.tar.gz">Download makestyle.tar.gz (1.0)</a></p>


      <p class="legend"><a href="makestyle.png"><img alt="Vim editing RIS" src="makestyle-small.jpg"/></a></p>

      <p class="legend"><strong>Fig. 3:</strong> Creating a bibliography style with refdb-ms. Click on the image to see a <a href="makestyle.png">larger version</a>. The script walks you through the process of writing a style by providing valid entries at the current point along with an explanation of what each element is good for.</p>


      <h2 id="perlmod">Perl client module</h2>

      <p>Author: Markus Hoenicka &lt;mho...@us...&gt;</p>

      <p>The Perl client module <code>RefDBClient::Client</code> allows Perl programmers to access the refdbd server from Perl scripts. The client/server dialog is implemented entirely in Perl. That is, you don't need the C clients installed on your system in order to run a Perl script using this module. The module allows an object-oriented approach to all RefDB client commands.</p>

      <p>Creating a Perl script that interacts with refdbd is straightforward and simple. First, you create a new instance of <code>RefDBClient::Client</code> and set the initial communication parameters:</p>

      <pre class="source">

use RefDBClient::Client;


my $client = new RefDBClient::Client;


$client->set_conninfo("127.0.0.1", "9734", "markus", "pass", "refdbtest",

"/home/markus/literature", "/usr/local/share/refdb/css/refdb.css");

      </pre>


      <p>Now you can call any client command and read the retrieved data, if any, into Perl variables:</p>

      <pre class="source">

my $summary = $client->refdb_listdb("");

my $data = $client->get_data();


print "$data\n";

      </pre>


      <p>This sixliner prints the available RefDB databases to stdout.</p>

      
      <p>Please follow the instructions in the INSTALL file of the archive to install this module properly on your system. <a href="pre/RefDBClient-Client-1.11.tar.gz">Download RefDBClient-Client-1.11.tar.gz</a></p>


    </div>


    <!-- the footer, to be displayed across the page at the bottom -->

    <div id="foot">

      <div id="footleft">$Date: 2005/05/08 21:25:29 $</div>

      <div id="footright">Copyright 2005 <a href="mailto:mho...@us...">Markus Hoenicka</a></div>

    </div>


  </body>

</html>