src/extensions/readme.html

   1 <html>
   2 <head>
   3   <title>JabRef-Extensions for JabRef @version@ help</title>
   4 </head>
   5
   6 <body>
   7   <h1>Extending JabRef's export and import capabilities</h1>
   8
   9   <h2>Custom exports</h2>
  10
  11   <p>JabRef's export and import capabilities can be extended quite
  12   easily. Please unzip the JabRef-extensions file, preferably to the
  13   same folder where you installed JabRef (where the <code>jabref.jar</code> file can be found).
  14   </p>
  15
  16   <p>To create your own export format, you can define <i>custom layouts</i>,
  17   simple templates where at certain places the contents of a JabRef database are written
  18   into. For an example see the files in the <a href="layout">layout directory</a>.
  19   For more details about creating your own export format, please read
  20   <a href="API/CustomExports.html"><code>API/CustomExports.html</code></a>.</p>
  21
  22   <p>The extensions contain also a few simple examples on how to create new <i>field formatters</i> -
  23   small commands that determine how database entries are written to your
  24   custom layout, please check <a href="net/sf/jabref/export/layout/format"><code>net/sf/export/layout/format</code></a>.
  25   </p>
  26
  27   <h2>Custom imports</h2>
  28
  29   <p>You can also quite easily  create an importer that allows you
  30   to read references from sources important to you. This requires only
  31   modest programming skills. Please check the
  32   <a href="SimpleCsvImporter.java">example</a>, compile it
  33   using the <code>compileAll.bat</code> script, register it
  34   as a custom importer with your JabRef-installation and
  35   import the <a href="SimpleCsvImporter.csv">SimpleCsvImporter.csv</a>
  36   file to see how it is done. More details can be found
  37   in <a href="API/CustomImports.html"><code>API/CustomImports.html</code></a>.</p>
  38
  39   <p>All importers that are part of the standard JabRef-distribution are also
  40   included in this extensions-package under <a href="net/sf/jabref/imports"><code>net/sf/jabref/imports</code></a>.
  41   In addition to serving as further examples, you can also fix them and register them as custom importers
  42   if you encounter any problems.
  43   </p>
  44
  45   <h2>API documentation</h2>
  46
  47   <p>The API-documentation for extensions that require some programming
  48   is available under <a href="API/index.html"><code>API/index.html</code></a>.
  49   </p>
  50
  51 </body>
  52 </html>