[Refdb-cvs] CVS: homepage programming.html,NONE,1.1
Status: Beta
Brought to you by:
mhoenicka
From: Markus H. <mho...@us...> - 2005-10-07 22:11:50
|
Update of /cvsroot/refdb/homepage In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11459 Added Files: programming.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: programming.html,v 1.1 2005/10/07 22:11:42 mhoenicka Exp $ --> <head> <title>RefDB Features: programming</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"><</td> <td class="graphic"> </td> <td class="tag">/></td> </tr> <tr> <td> </td> <td class="text">bibliographies beyond word processors</td> <td> </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="navsel"> <p><a href="features.html">Features</a></p> <p class="level1"><a href="cli.html">CLI</a></p> <p class="level1"><a href="web.html">Web</a></p> <p class="level1"><a href="emacs.html">Emacs</a></p> <p class="level1"><a href="vim.html">Vim</a></p> <p class="level1"><a href="programming.html">Programming</a></p> </td> </tr> <tr> <td class="nav"><a href="examples.html">Examples</a></td> </tr> <tr> <td class="nav"><a href="doc.html">Documentation</a></td> </tr> <tr> <td class="nav"><a href="status.html">Current Status</a></td> </tr> <tr> <td class="nav"> <p><a href="download.html">Download</a></p> <p class="level1"><a href="sysreq.html">Requirements</a></p> <p class="level1"><a href="install.html">Installation</a></p> </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://cvs.sourceforge.net/viewcvs.py/refdb/">Project CVS</a></td> </tr> <tr> <td class="nav"><a href="http://sourceforge.net"> <img src="http://sourceforge.net/sflogo.php?group_id=26091&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 Features: programming</h1> <p>A key feature of RefDB is that it is a snap to use it from scripts or even from Makefiles. This greatly simplifies recurring tasks, like feeding the results of a weekly Pubmed search into your database. The simplest way to do this is to use the <a href="cli.html">command line tools</a> in batch mode. For more ambitious projects there is also a Perl module which allows to integrate RefDB functionality into your very own Perl programs.</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="#general">General features</a></td> </tr> <tr> <td class="localnav"><a href="#example">Example</a></td> </tr> </tbody> </table> </div> <h2 id="general">General Features</h2> <p class="authors">Author: Markus Hoenicka <mho...@us...></p> <p><strong><a href="pre/RefDBClient-Client-1.11.tar.gz">Download RefDBClient-Client-1.11.tar.gz</a></strong></p> <p><strong>Note:</strong>This version requires <a href="pre/refdb-latest.tar.gz">refdb-0.9.6-pre2 or later</a> or a current CVS version of RefDB.</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> <h2 id="examples">Examples</h2> <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.</p> </div> <!-- the footer, to be displayed across the page at the bottom --> <div id="foot"> <div id="footleft">$Date: 2005/10/07 22:11:42 $</div> <div id="footright">Copyright 2004 <a href="mailto:mho...@us...">Markus Hoenicka</a></div> </div> </body> </html> |