update changelog
[debian/jabref.git] / src / main / resources / help / FileLinks.html
1 <html xmlns="http://www.w3.org/1999/xhtml">
2 <head>
3 <link rel="stylesheet" type="text/css" href="jabref_help.css"/>
4 </head>
5
6 <body>
7
8     <h1>File links in JabRef</h1>
9
10     <p>JabRef lets you link up your
11     entries with files of any type stored on your system, as well
12     as links to the document on the web in the form of an URL or a
13     DOI identifier. Each entry can have an arbitrary number of file
14     links, and each linked file can be opened quickly from JabRef.</p>
15
16     <p>In BibTeX terms, the file links of an entry are encoded in a
17     single field. However, from within JabRef they appear as an
18     editable list of links accessed from the entry editor along
19     with other BibTeX fields.</p>
20
21     <h2>Setting up external file types</h2>
22
23     <p>For each file link, a
24     file type must be chosen, to determine what icon should be used
25     and what application should be called to open the file. The
26     list of file types can be viewed and edited by choosing
27     <b>Options -&gt; Manage external file types</b>, or by clicking
28     the <b>Manage external file types</b> button in the <b>External
29     programs</b> tab of the Preferences dialog.</p>
30
31     <p>A file type is specified by its name, a graphical icon, a
32     file extension and an application to view the files. On
33     Windows, the name of the application can be omitted in order to
34     use Window's default viewer instead.</p>
35
36     <h2>Adding external links to an entry</h2>
37
38     <p>If the "file" field
39     is included in <a href="GeneralFields.html">General fields</a>,
40     you can edit the list of external links for an entry in the
41     <a href="EntryEditorHelp.html">Entry editor</a>. The editor
42     includes buttons for inserting, editing and removing links, as
43     well as buttons for reordering the list of links.</p>
44
45     <p>If you have a file within or below your file directory (set
46     up in <b>Preferences -&gt; External programs -&gt; External
47     file links -&gt; Main file directory</b>) with an extension
48     matching one of the defined external file types, and a name
49     containing a BibTeX entry's BibTeX key, the file can be
50     autolinked by clicking on the <b>Auto</b> button in the entry
51     editor. The rules for which file names can be autolinked to a
52     BibTeX key can be set up in <b>Preferences -&gt; External
53     programs -&gt; External file links -&gt; Use regular expression
54     search</b>.</p>
55
56     <p>If you want to download a file and link to it from a BibTeX
57     entry, you can do this by clicking the <b>Download</b> button
58     in the entry editor. A dialog box will appear, prompting you to
59     enter the URL. The file will be downloaded to your main file
60     directory, named based on the entry's BibTeX key, and finally
61     linked from the entry.</p>
62
63     <p>There are a couple of alternatives to the global file directory.
64     You have the option (under <b>Preferences -&gt; External programs</b>) to
65     allow links relative to the location of the bib file. Files linked
66     in this way can be moved along with the bib file without breaking the
67     links. There is an additional setting determining whether the bib file
68     location should be the <i>primary</i> file directory. This decides which
69     directory JabRef will use when downloading or moving linked files into
70     your file directory.</p>
71
72     <p>You can also set a file directory (absolute, or relative to the
73     bib file location) specifically for one database under <b>File -&gt;
74     Database properties</b>. Finally, in the <b>Database properties</b> dialog
75     you can set a user-specific file directory, which will be valid only when
76     you are the one working on the bib file.</p>
77
78     <h2>Opening external files</h2>
79
80     <p>There are several ways to open
81     an external file or web page. In the entry table you can select
82     an entry and use the menu choice, keyboard shortcut or the
83     right-click menu to open an entry's first external link.
84     Alternatively, if the entry table is set up to show the
85     <b>file</b> column (set up in <b>Preferences -&gt; Entry table
86     -&gt; Special table columns -&gt; Show file column</b>), you
87     can click on the file icon to open an entry's first link. To
88     access any of an entry's links, click on the icon with the
89     right mouse button (or <b>Ctrl-click</b> on Mac OS X) to bring
90     up a menu showing all links.</p>
91 </body>
92 </html>