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