[Refdb-cvs] CVS: homepage cli.html,NONE,1.1 web.html,NONE,1.1 emacs.html,NONE,1.1 vim.html,NONE,1.1
Status: Beta
Brought to you by:
mhoenicka
Menu
▾
▴
[Refdb-cvs] CVS: homepage cli.html,NONE,1.1 web.html,NONE,1.1 emacs.html,NONE,1.1 vim.html,NONE,1.1
|
From: Markus H. <mho...@us...> - 2005-10-06 22:17:04
|
Update of /cvsroot/refdb/homepage In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv2941 Added Files: cli.html web.html emacs.html vim.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: cli.html,v 1.1 2005/10/06 22:16:54 mhoenicka Exp $ --> <head> <title>RefDB Features: command line interface</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> </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> <tr> <td class="nav"><a href="addons.html">Add-ons</a></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: command line interface</h1> <p>The command line clients are probably the most versatile tools to access RefDB. They are useful for interactive use on the command line, for scripting purposes, and as applications behind graphical user interfaces.</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="#applications">Applications</a></td> </tr> <tr> <td class="localnav"><a href="#screenshots">Screenshots</a></td> </tr> </tbody> </table> </div> <h2 id="general">General Features</h2> <ul> <li>The RefDB sources and binary packages offer three command-line clients for reference management, administration, and bibliography generation.</li> <li>All clients can generate log messages to monitor their operation.</li> <li>The reference management and administration clients can run in an interactive mode (much like a console FTP client) and in a batch mode for scripting purposes. The bibliography client does not have an interactive mode as it is most commonly used from within scripts that control the transformation of documents containing bibliographies.</li> <li>Wherever applicable, the clients allow to read from and write to stdin and stdout, respectively, and thus empower you to use Unix plumbing to your hearts content.</li> <li>In addition to the clients, RefDB contains a variety of reference data conversion scripts. These scripts allow the import of reference data that <code>refdbd</code> does not support natively.</li> </ul> <h2 id="applications">Applications</h2> <p>The following command line applications are shipped with RefDB:</p> <h3 id="clients">Command line clients</h3> <ul> <li><code class="refdbapp">refdbc</code>: the reference and notes management client. Use this tool to add and update notes and references, and to search for and export reference and note data in a variety of formats.</li> <li><code class="refdbapp">refdba</code>: the administration client. Use this tool to create and delete databases, to manage users, to add, retrieve and delete bibliography styles, and to perform a variety of maintenance tasks.</li> <li><code class="refdbapp">refdbib</code>: the bibliography client. Useful as it is, you will rarely run this tool directly, as RefDB contains both easier-to-use wrapper scripts as well as a Makefile-based document management tool.</li> </ul> <h3 id="converters">Reference data converters</h3> <ul> <li><code class="refdbapp">bib2ris</code>: converts BibTeX bibliography data to the RIS format</li> <li><code class="refdbapp">db2ris</code>: converts DocBook bibliography data to RIS data. This is a wrapper script for OpenJade which runs a program implemented in DSSSL to perform the actual conversion.</li> <li><code class="refdbapp">en2ris</code>: fixes a variety of known problems in the "RIS" data exported by EndNote</li> <li><code class="refdbapp">marc2ris</code>: extracts the relevant bibliographic data from MARC datasets and delivers them in RIS format.</li> <li><code class="refdbapp">med2ris</code>: converts tagged and XML bibliographic data from Medline/PubMed records and exports them in RIS format.</li> </ul> <h3 id="tools">Miscellaneous tools</h3> <ul> <li><code class="refdbapp">eenc</code>: a command-line password encryption tool. Uses the same method as the RefDB command line tools and the Perl client module. Useful for programmers only.</li> <li><code class="refdbapp">refdb-backup</code>: a tool to backup RefDB databases</li> <li><code class="refdbapp">refdb-restore</code>: a tool to restore RefDB databases from backups</li> <li><code class="refdbapp">refdbjade</code>: a wrapper script which transforms DocBook SGML documents to a variety of output formats.</li> <li><code class="refdbapp">refdbnd</code>: creates a skeleton document and a custom Makefile. It can also create a Makefile suitable for an existing DocBook or TEI document. Creating printable or HTML output with these files is as easy as typing <code>make pdf</code> or <code>make html</code>.</li> <li><code class="refdbapp">refdbxml</code>: a wrapper script which transforms DocBook and TEI XML documents to a variety of output formats.</li> <li><code class="refdbapp">runbib</code>: a wrapper script which generates the bibliography and transforms a document.</li> </ul> <h2 id="screenshots">Screenshots</h2> <h3 id="startuphelpscreen">Startup and help screen</h3> <p class="legend"><img alt="RefDB startup and help screen" src="screenshots/refdbc-help.png"/></p> <p class="legend"><strong>Fig. 1:</strong> RefDB startup and help screen. The command selects the initial database (you can switch the database anytime during an interactive session). After entering your password you'll see the command prompt. Hitting the "?" key invokes the command overview which shows all available interactive commands.</p> <h3 id="queryresults">Query results</h3> <p class="legend"><img alt="RefDB query results" src="screenshots/refdbc-query.png"/></p> <p class="legend"><strong>Fig. 2:</strong> RefDB query output. The <code>getref</code> command is probably the command you'll use most often. In this case it selects all references with an author that has the string "Miller" in his name and which were published later than 1998. References that were authored by "Myers, B.B.,Jr." are excluded from the result list (journal articles usually have more than one author). The "-s" option requests the reprint status (displaying this and other information, like the abstract or notes, can be made the default). By default, the references are returned in a terse format optimized for terminals, as shown here. You can request other formats like risx, DocBook, HTML, or RIS. Other switches allow you to write the results to a file. You can also hit the "up" key one or more times to reuse and edit previous query strings, just like in your shell.</p> <h3 id="batchmode">Batch mode</h3> <p class="legend"><img alt="RefDB batch mode" src="screenshots/refdbc-batch.png"/></p> <p class="legend"><strong>Fig. 3:</strong> Using RefDB clients in batch mode. You can invoke all internal client commands right from your shell. This is useful especially when you use the commands in your scripts. In the example shown here, a dataset is written to a file in RIS format.</p> </div> <!-- the footer, to be displayed across the page at the bottom --> <div id="foot"> <div id="footleft">$Date: 2005/10/06 22:16:54 $</div> <div id="footright">Copyright 2004 <a href="mailto:mho...@us...">Markus Hoenicka</a></div> </div> </body> </html> --- 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: web.html,v 1.1 2005/10/06 22:16:54 mhoenicka Exp $ --> <head> <title>RefDB Features: web interface</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> </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> <tr> <td class="nav"><a href="addons.html">Add-ons</a></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: web interface</h1> <p>RefDB can be accessed through a PHP-based web interface. This interface is well suited to run simple queries in a pleasant graphical environment.</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="#screenshots">Screenshots</a></td> </tr> </tbody> </table> </div> <h2 id="general">General Features</h2> <ul> <li>The RefDB web interface is implemented in PHP.</li> <li>Works with all modern web browsers (including text-oriented ones)</li> <li>The query page allows simple queries with up to four search strings which can be combined with booleans. It also allows entering complex queries which use the same syntax as the <a href="cli.html">command line clients</a>.</li> <li>There is also a simple administrative interface for the most common tasks like creating databases and adding users.</li> </ul> <h2 id="screenshots">Screenshots</h2> <h3 id="firefoxquery">The query form</h3> <p class="legend"><img alt="RefDB web query form" src="screenshots/web-firefox-query.png"/></p> <p class="legend"><strong>Fig. 1:</strong> A filled-in query form of the RefDB web interface.</p> <h3 id="queryresults">Query results</h3> <p class="legend"><img alt="RefDB query results" src="screenshots/web-firefox-result.png"/></p> <p class="legend"><strong>Fig. 2:</strong> The results of your queries are displayed in lists. Buttons and checkboxes allow to edit or delete references and to change the status in your personal reference list.</p> <h3 id="lynx">Text-oriented browsers</h3> <p class="legend"><img alt="RefDB web interface in lynx" src="screenshots/web-lynx.png"/></p> <p class="legend"><strong>Fig. 3:</strong> The query form of the RefDB web interface displayed in Lynx, one of the most popular text-oriented web browsers. The RefDB web interface is open to these browsers as well.</p> </div> <!-- the footer, to be displayed across the page at the bottom --> <div id="foot"> <div id="footleft">$Date: 2005/10/06 22:16:54 $</div> <div id="footright">Copyright 2004 <a href="mailto:mho...@us...">Markus Hoenicka</a></div> </div> </body> </html> --- 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: emacs.html,v 1.1 2005/10/06 22:16:54 mhoenicka Exp $ --> <head> <title>RefDB Features: Emacs support</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> </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> <tr> <td class="nav"><a href="addons.html">Add-ons</a></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: Emacs support</h1> <p>RefDB integrates nicely into Emacs. Combined with editing modes for SGML, XML, and RIS documents, you'll get an integrated authoring environment with direct access to your bibliographic data. "Cite-while-you-write", document transformation, and previewing is just a few mouseclicks away for DocBook SGML and XML as well as for TEI XML documents. Emacs support is not included in the RefDB sources, but available separately.</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="#rismode">ris mode</a></td> </tr> <tr> <td class="localnav"><a href="#refdbmode">refdb mode</a></td> </tr> </tbody> </table> </div> <h2 id="rismode">ris mode</h2> <p class="authors">Author: Markus Hoenicka <mho...@us...></p> <p><strong><a href="addons/ris.el">Download ris.el (1.9)</a></strong></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. 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. ris-mode also provides the following commands:</p> <ul> <li><strong><code>insert-set</code> (C-c-C-s):</strong> inserts 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><strong><code>insert-tag</code> ( C-c-C-t):</strong> insert a new tag. 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><strong><code>duplicate-tag</code> (M-RET):</strong> insert a new line below the current line with the same tag as the current line. This command is convenient if you add multiple keywords or authors, each of which have to go on separate tag lines.</li> <li><strong><code>backward-set</code> (C-x[) and <code>forward-set</code> (C-x]):</strong> move between RIS datasets.</li> <li><strong><code>narrow-to-set</code> (C-xns) and <code>widen</code> (C-xnw):</strong> narrow the buffer to the current RIS set and widen to the full buffer contents.</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.</p> <p class="legend"><img alt="Emacs ris-mode" src="screenshots/rismode.png"/></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="refdbmode">Emacs refdb-mode</h2> <p class="authors">Current Author: Markus Hoenicka <mho...@us...></p> <p><strong><a href="addons/refdb-mode.el">Download refdb-mode.el (1.15)</a></strong></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, and then some, for RefDB.</p> <ul> <li>It works nicely alongside the major modes ris-mode, <a href="http://www.thaiopensource.com/nxml-mode/">nxml-mode</a>, and <a href="http://sourceforge.net/projects/psgml/">PSGML</a>. refdb-mode can be automatically activated in these modes, and commands that return data in either of these formats set the appropriate mode automatically.</li> <li>It provides menu entries to add, update, delete, and search for references and notes. Retrieved references and notes in either RIS or risx format can be edited in place and subsequently be updated in the database.</li> <li>Queries using author names, periodical names, or keywords are simplified by tab-completion.</li> <li>You can run queries on a selected region. E.g. you can highlight a word or a phrase in the title of a reference and see whether references exist that use this word or phrase as a keyword.</li> <li>Reference data in formats that RefDB cannot natively import or generate can be converted by Chris Putnam's <a href="http://www.scripps.edu/~cdputnam/software/bibutils/bibutils.html">bibutils</a> via menu commands.</li> <li>A menu shows the databases that the current user has permissions to access.</li> <li>DocBook SGML and XML as well as TEI XML files can be created via the refdbnd script</li> <li>A set of commands allows to add citation elements in DocBook or TEI formats to the kill ring, containing one or more references returned by a previous query. These elements can then be yanked into your DocBook or TEI documents.</li> <li>These documents can be transformed to various output formats via menu commands, and the output can be viewed immediately in external viewers via the menu</li> <li>A full range of administrative commands helps the RefDB administrator to get his work done. This includes the control of the application server and shortcuts to edit the RefDB configuration files.Administration is simplified by tab-completion for filenames and for character encodings.</li> <li>Bibliographic styles can be added, retrieved, and directly edited.</li> </ul> <p>To install this mode on your system, follow the instructions in the elisp code.</p> <h3 id="refdbmode-getref">Retrieving references with Emacs</h3> <p class="legend"><img alt="Emacs refdb-mode" src="screenshots/refdb-mode-getref1.png"/></p> <p class="legend"><strong>Fig. 2:</strong> Emacs refdb-mode, showing the available menu commands to retrieve references. The two buffers show the result of retrieving references in risx format. The output buffer contains the data proper, which can be edited and validated using the automatically invoked nXML mode. The messages buffer contains the command summaries of the most recent commands. Click on the image to see a <a href="refdb-mode-getref1.png">larger version</a>.</p> <h3 id="refdbmode-getref">Retrieving references</h3> <p class="legend"><img alt="Emacs refdb-mode" src="screenshots/refdb-mode-getref-region.png"/></p> <p class="legend"><strong>Fig. 2:</strong> Emacs refdb-mode, showing the available menu commands to retrieve references. The two buffers show the result of retrieving references in risx format. The output buffer contains the data proper, which can be edited and validated using the automatically invoked nXML mode. The messages buffer contains the command summaries of the most recent commands.</p> <h3 id="refdbmode-getref-region">Retrieving references from a region</h3> <p class="legend"><img alt="Emacs refdb-mode getref on region" src="screenshots/refdb-mode-getref-region.png"/></p> <p class="legend"><strong>Fig. 3:</strong> You can mark any word or phrase while editing your document and see whether there is a matching reference in your RefDB database.</p> <h3 id="refdbmode-cite">Inserting citations</h3> <p class="legend"><img alt="Emacs insert citations" src="screenshots/refdb-mode-cite.png"/></p> <p class="legend"><strong>Fig. 4:</strong> Put the cursor somewhere into the reference you want to cite, or select a region containing the relevant citations. Then use one of the menu commands to insert a RefDB citation for DocBook or TEI into the kill ring. Back in your document, yank the citation. </p> <h3 id="refdbmode-convert">Converting bibliographic data</h3> <p class="legend"><img alt="Emacs refdb-mode data conversion" src="screenshots/refdb-mode-convert.png"/></p> <p class="legend"><strong>Fig. 5:</strong> refdb-mode offers commands to run the bibutils tools on the contents of the current buffer. This makes import of reference data not directly supported by RefDB a breeze. Shown here is the import of MODS data.</p> <h3 id="refdbmode-selectdb">Selecting databases</h3> <p class="legend"><img alt="Emacs refdb-mode database selection" src="screenshots/refdb-mode-selectdb1.png"/></p> <p class="legend"><strong>Fig. 6:</strong> Select one of the databases which you have access to from a convenient menu.</p> <h3 id="refdbmode-admin">Administering your RefDB installation</h3> <p class="legend"><img alt="Emacs refdb-mode administration" src="screenshots/refdb-mode-admin1.png"/></p> <p class="legend"><strong>Fig. 7:</strong> refdb-mode contains a complete interface to all administrative tasks.</p> </div> <!-- the footer, to be displayed across the page at the bottom --> <div id="foot"> <div id="footleft">$Date: 2005/10/06 22:16:54 $</div> <div id="footright">Copyright 2004 <a href="mailto:mho...@us...">Markus Hoenicka</a></div> </div> </body> </html> --- 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: vim.html,v 1.1 2005/10/06 22:16:54 mhoenicka Exp $ --> <head> <title>RefDB Features: Vim support</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> </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> <tr> <td class="nav"><a href="addons.html">Add-ons</a></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: Vim support</h1> <p>RefDB plays well with Vim. You'll get support for both editing of RIS bibliographic data and for your DocBook XML documents. Vim support is not included in the RefDB sources, but available separately.</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="#vimdbxml">Vim and Docbook XML editing</a></td> </tr> <tr> <td class="localnav"><a href="#vimris">Vim and RIS editing</a></td> </tr> </tbody> </table> </div> <h2 id="vimdbxml">Vim and DocBook XML editing</h2> <p class="authors">Author: David Nebauer <dav...@sw...></p> <p><strong>Package: vim-docbk-xml-refdb (1.0) [<a href="source/vim-docbk-xml-refdb-1.0.tar.gz">source</a>, <a href="install.html#debian">deb</a>].</strong></p> <p><strong>Requires: imagemagick [<a href="http://www.imagemagick.org">web</a>, <a href="install.html#debian">deb</a>]; fop [<a href="http://xmlgraphics.apache.org/fop/">web</a>, <a href="install.html#debian">deb</a>]; xmllint [<a href="http://xmlsoft.org/xmllint.html">web</a>, <a href="install.html#debian">deb</a>]; xsltproc [<a href="http://xmlsoft.org/XSLT/xsltproc2.html">web</a>, <a href="install.html#debian">deb</a>]; libgetopt-declare-perl <a href="http://search.cpan.org/~dconway/Getopt-Declare-1.11/lib/Getopt/Declare.pm">web</a>, <a href="install.html#debian">deb</a>]; refdb-cache (1.0) [<a href="source/refdb-cache-1.0.tar.gz">source</a>, <a href="install.html#debian">deb</a>]; libperl-refdb-cache (1.0) [<a href="source/libperl-refdb-cache-1.0.tar.gz">source</a>, <a href="install.html#debian">deb</a>].</strong></p> <p>If <a href="http://www.vim.org">Vim</a> is the editor of your choice, this package installs the syntax, filetype and plugin files that enable you to edit DocBook XML files.</p> <p>The plugin has a rather extensive list of dependencies as it interacts with a great many components in order to perform all its functions. For example, in order to create and view PDF and (X)HTML output it must use an XML validator (xmllint), an XSLT processor (xsltproc), a FO processor (fop), an HTML viewer and a PDF viewer. There are other dependencies which are not listed as they are commonly available on most *nix systems. For further information on dependencies unpack the source archive, read the README file and type <em>./configure --help</em>. Debian users need only select the primary package and the rest will happen automagically</p> <p>While this suite consists of a number of components, all its functionality is exposed as keystroke mappings. All mappings (except special characters) are available via the DocBook menu (menus can be accessed from console vim â see vim help topic 'console-menus').</p> <p>The source distribution can be built with support for multiple XSLT processors (xsltproc, Saxon, Xalan), FO processors (FOP, Xep), xml validators (xmllint, RXP) and, of course, RefDB.</p> <p>The Debian package has a minimal configuration with support for only one XSLT processor (xsltproc), one FO processor (Fop), one xml validator (xmllint) and RefDB.</p> <p>Here is an overview of the functionality supplied by the plugin:</p> <ul> <li>A skeleton document structure can be generated. The user will be prompted to supply some details such as author name and document title.</li> <li>There are mappings for major document divisions: chapter, section and sect1|2|3.</li> <li>Minor structures can also be generated: para, comment, (strong) emphasis, footnote, blockquote, filename, verbatim, note, index term, glossary term, warning, sidebar and example. The user is generally prompted to enter the text to be enclosed by the structure. Some of these mappings work in visual mode, where the selected text will be "wrapped" by the structure.</li> <li>A mapping is supplied to insert a filepath. The user selects the file from a file selector dialog box. The user can choose whether to insert an absolute or relative filepath.</li> <li>A number of mappings are supplied for certain characters that are represented by character entities: ampersand (&), quote marks ('|"), angle brackets (<|>), em and en dashes (—|–), ellipses (…) and non-breaking spaces ( ). When the user types a single or double quote mark ('|") the corresponding character entity (“|‘|’|”) is chosen intelligently. Alternative mappings are supplied for inserting single and double straight quote mark character entities, and for inserting raw single and double quote marks. A mapping is supplied for "raw" ampersands.</li> <li>Cross-references and hyperlinks can be inserted into the document. For cross-references the user is presented with a list of element IDs to choose from.</li> <li>Support for lists (itemised, ordered and variable type) is supplied.</li> <li>Tables and images can be inserted. The user is prompted to supply required information such as numbers of rows and columns for tables and image file, captions and titles for images.</li> <li>A mapping is supplied that enables users to jump to a selected element (chosen from a menu of available element IDs).</li> <li>Document validation is only a mapping away.</li> <li>Output as html, xhtml, pdf and text is generated by certain mappings. The resulting output is opened in an external viewer.</li> <li>Various RefDB functions are supported when editing RefDB-created documents. The user can create, edit and delete references from within Vim. References from the current document can be displayed (either all or a subset). The user can change the current document's associated database and/or stylesheet. Finally, citations from the current reference database can be selected and inserted.</li> <li>Various help is available via mappings. Help on mappings is available (<Leader>hh). In addition, help on individual docbook elements can be displayed. The user requests help on either the previous or next element and the relevant page from Walsh and Muellner's <em>DocBook: The Definitive Guide</em> is opened in an external html viewer. A summary of document structure can also be displayed.</li> </ul> <p class="legend"><a href="vimdbxml-menus-01.png"><img alt="Vim DocBook XML Menus" src="vimdbxml-menus-01-small.png"/></a></p> <p class="legend"><strong>Fig. 4:</strong> GVim editing a DocBook XML file. All the DocBook XML supplied menus are being displayed (they have been "torn off"). The left-most menu is the parent menu. The citations (RefDB) menu is seen on the far right. Note that users of console vim also have access to these menus (see vim help topic 'console-menus'. Click on the image to see a <a href="vimdbxml-menus-01-small.png">larger version</a>.</p> <h2 id="vimris">Vim and RIS editing</h2> <p class="authors">Author: David Nebauer <dav...@sw...></p> <p><strong>Package: vim-ris (1.1) [<a href="source/vim-ris-1.1.tar.gz">source</a>, <a href="install.html#debian">deb</a>].</strong></p> <p>If <a href="http://www.vim.org">Vim</a> is the editor of your choice, this package installs the syntax, filetype and plugin files that enable you 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 <em>not</em> currently do is handle line continuations ('/$') -- it assumes all fields are a single line</p> <p>The plugin file supplies five 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>\r = insert reprint status</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 class="legend"><a href="vimris-01.png"><img alt="Vim editing RIS" src="vimris-01-small.jpg"/></a></p> <p class="legend"><strong>Fig. 5:</strong> Vim editing RIS. Click on the image to see a <a href="vimris-01.png">larger version</a>. The image shows how Vim spots a few 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> </div> <!-- the footer, to be displayed across the page at the bottom --> <div id="foot"> <div id="footleft">$Date: 2005/10/06 22:16:54 $</div> <div id="footright">Copyright 2004 <a href="mailto:mho...@us...">Markus Hoenicka</a></div> </div> </body> </html> |
