Load /tmp/tmp.vjbgZ10456/jabref-2.2~b2 into
[debian/jabref.git] / src / help / ExternalFiles.html
1 <HTML>
2
3 <BODY text="#275856">
4 <basefont size="4" color="#2F4958" face="arial">
5
6 <H1>PDF/PS/URL/DOI links in JabRef</H1>
7
8 JabRef lets you link up your entries with PDF or PS files stored on your system, as well as
9 links to the document on the web in the form of an URL or a DOI identifier.
10
11 <H2>Setting up external viewers</H2>
12
13 The program has to know which external viewers to use for PDF, PS and web pages. These are by default
14 set to values that probably make sense for your operating system, so there's a fair chance you don't
15 have to change these values.
16 <p>To change the external viewer settings, go to <b>Options -> Preferences -> External programs</b>.
17
18 <H2>Opening external files or links</H2>
19
20 There are several ways to open an external file or web page. In the entry editor, you can double click on the text field
21 containing the file name, DOI or URL. In the entry table you can select an entry and use the menu choice, keyboard shortcut
22 or the right-click menu to open the file or web page. Finally, you can click on a PDF, PS, URL or DOI icon.
23 <P> By default the entry table will contain two columns with icons for those entries that link to external files and URLs.
24   You can disable any of these in <b>Preferences -> Table</b>. The second column of the entry table shows icons for PDF or PS files (only PDF if both
25  are present), and the third column shows icons for URL or DOI (only URL if both are present). You open the file or web
26  page by clicking on an icon.
27
28 <P><b>Note:</b> If the PS field does not appear in the entry editor (in the 'General' panel),
29 you may have to <a href="GeneralFields.html">customize the entry types of the general fields</a>.
30 </P>
31
32 <H2>The main PDF and PS directories</H2>
33
34 JabRef makes it easy to link PDF and PS files to your entries. To take advantage of this,
35 you have to indicate in <b>Options -> Preferences -> External programs</b> your main PDF and PS directories. All PDF and PS files that are stored in
36 or below each of these directories will be referred to with a relative path by JabRef, making it easy for you if you need to move the
37 PDF and PS directories, or if several users use the same database from different network places.
38
39 <P>Additionally, if you give your PDF and PS files names that correspond to the relevant entry's bibtex key (plus '.pdf' or '.ps'),
40   JabRef will be able to search your main directories and its subfolders for the correct PDF and PS. Once the correctly-named
41   PDF or PS is in place you access this function by clicking the 'Auto' button next to the PDF and PS fields in the entry editor. If
42   the PDF or PS is found, the field will immediately be set.
43 <P>If you name a PDF or PS file as mentioned, you can also open the file without setting the PDF or PS field of the entry at all.
44   The downside is that the PDF or PS icon will not appear in the table unless you do (manually or with the 'Auto' button).
45
46 <H2>The database-specific PDF and PS directories</H2>
47 <P>
48 You can set PDF and PS directories specific to a database (<b>File -> Database properties</b>).
49 These directories will supersede the main directories.
50 </P>
51
52 <a name="RegularExpressionSearch">
53 <H2>Using Regular Expression Search for Auto-Linking</H2>
54 </a>
55 <p>
56 In the previous sections JabRef's auto-linking feature was described: If you choose names for your files
57 corresponding to the bibtex-key + plus the extension, JabRef will automatically be able to find it.
58 </p><p>
59 Since JabRef 2.2 it is now possible to have greater flexibility in the naming scheme by using
60 regular expression for the search. In most cases it should not be necessary though to adapt the given default.
61 </p><p>
62 If you open the external preferences
63 (Options -> Preferences -> External Programs) you will find an option called "Use Regular Expression Search".
64 Checking this option will allow you to enter your own regular expression for search in the PDF directories.
65 </p><p>
66 The following syntax is understood:
67 </p>
68 <ul>
69   <li><code>*</code> - Search in all immediate all subdirectories excluding the current
70       and any deeper subdirectories.</li>
71   <li><code>**</code> - Search in all subdirectories recursively AND the current directory.</li>
72   <li><code>.</code> and <code>..</code> - The current directory and the parent directory.</li>
73   <li><code>[title]</code> - All expressions in square brackets are replace by the corresponding field in the current
74   entry</li>
75   <li><code>[extension]</code> - Is replaced by the file-extension of the field you are using.</li>
76   <li>All other text is interpreted as a regular expression. But caution: You need to escape backslashes by putting
77       two backslashes after each other to not confuse them with the path-separator.</li>
78 </ul>
79 <p>
80 The default for searches is <code>**/.*[bibtexkey].*\\.[extension]</code>. As you can see this will
81 search in all subdirectories of the extension-based directory (for instance in the PDF directory) for any file that has the correct extension and
82 contains the Bibtex-key somewhere.
83 </p>
84 </body>
85 </html>