Imported Upstream version 2.10+ds
[debian/jabref.git] / src / help / ExternalFiles.html
index 880089e2aaed5c90816cbbdd5c5cfdd9eeb102f4..5d11c79ca18d524e8627cdb2b91e417faaeb396d 100644 (file)
-<html xmlns="http://www.w3.org/1999/xhtml">\r
-<head>\r
-<link rel="stylesheet" type="text/css" href="jabref_help.css"/>\r
-</head>\r
-\r
-<body>\r
-\r
-    <h1>PDF/PS/URL/DOI links in JabRef</h1>\r
-\r
-    <p><b>Note:</b> JabRef 2.3\r
-    and later versions offer an <a href="FileLinks.html">improved\r
-    system for external file links</a>.</p>\r
-\r
-    <p>JabRef lets you link up your entries with PDF or PS files\r
-    stored on your system, as well as links to the document on the\r
-    web in the form of an URL or a DOI identifier.</p>\r
-\r
-    <h2>Setting up external viewers</h2>\r
-\r
-    <p>The program has to know\r
-    which external viewers to use for PDF, PS and web pages. These\r
-    are by default set to values that probably make sense for your\r
-    operating system, so there's a fair chance you don't have to\r
-    change these values.</p>\r
-\r
-    <p>To change the external viewer settings, go to <b>Options\r
-    -&gt; Preferences -&gt; External programs</b>.</p>\r
-\r
-    <h2>Opening external files or links</h2>\r
-\r
-    <p>There are several ways\r
-    to open an external file or web page. In the entry editor, you\r
-    can double click on the text field containing the file name,\r
-    DOI or URL. In the entry table you can select an entry and use\r
-    the menu choice, keyboard shortcut or the right-click menu to\r
-    open the file or web page. Finally, you can click on a PDF, PS,\r
-    URL or DOI icon.</p>\r
-\r
-    <p>By default the entry table will contain two columns with\r
-    icons for those entries that link to external files and URLs.\r
-    You can disable any of these in <b>Preferences -&gt; Table</b>.\r
-    The second column of the entry table shows icons for PDF or PS\r
-    files (only PDF if both are present), and the third column\r
-    shows icons for URL or DOI (only URL if both are present). You\r
-    open the file or web page by clicking on an icon.</p>\r
-\r
-    <p><b>Note:</b> If the PS field does not appear in the entry\r
-    editor (in the 'General' panel), you may have to\r
-    <a href="GeneralFields.html">customize the entry types of the\r
-    general fields</a>.</p>\r
-\r
-    <h2>The main PDF and PS directories</h2>\r
-\r
-    <p>JabRef makes it easy to\r
-    link PDF and PS files to your entries. To take advantage of\r
-    this, you have to indicate in <b>Options -&gt; Preferences\r
-    -&gt; External programs</b> your main PDF and PS directories.\r
-    All PDF and PS files that are stored in or below each of these\r
-    directories will be referred to with a relative path by JabRef,\r
-    making it easy for you if you need to move the PDF and PS\r
-    directories, or if several users use the same database from\r
-    different network places.</p>\r
-\r
-    <p>Additionally, if you give your PDF and PS files names that\r
-    correspond to the relevant entry's bibtex key (plus '.pdf' or\r
-    '.ps'), JabRef will be able to search your main directories and\r
-    its subfolders for the correct PDF and PS. Once the\r
-    correctly-named PDF or PS is in place you access this function\r
-    by clicking the 'Auto' button next to the PDF and PS fields in\r
-    the entry editor. If the PDF or PS is found, the field will\r
-    immediately be set.</p>\r
-\r
-    <p>If you name a PDF or PS file as mentioned, you can also open\r
-    the file without setting the PDF or PS field of the entry at\r
-    all. The downside is that the PDF or PS icon will not appear in\r
-    the table unless you do (manually or with the 'Auto'\r
-    button).</p>\r
-\r
-    <h2>The database-specific PDF and PS directories</h2>\r
-\r
-    <p>You can set PDF and PS directories specific to a database\r
-    (<b>File -&gt; Database properties</b>). These directories will\r
-    supersede the main directories.</p>\r
-\r
-    <h2><a name="RegularExpressionSearch"\r
-       id="RegularExpressionSearch">Using Regular Expression Search\r
-       for Auto-Linking</a></h2>\r
-\r
-    <p>In the previous sections JabRef's auto-linking feature was\r
-    described: If you choose names for your files corresponding to\r
-    the bibtex-key + plus the extension, JabRef will automatically\r
-    be able to find it.</p>\r
-\r
-    <p>Since JabRef 2.2 it is now possible to have greater\r
-    flexibility in the naming scheme by using regular expression\r
-    for the search. In most cases it should not be necessary though\r
-    to adapt the given default.</p>\r
-\r
-    <p>If you open the external preferences (Options -&gt;\r
-    Preferences -&gt; External Programs) you will find an option\r
-    called "Use Regular Expression Search". Checking this option\r
-    will allow you to enter your own regular expression for search\r
-    in the PDF directories.</p>\r
-\r
-    <p>The following syntax is understood:</p>\r
-\r
-    <ul>\r
-        <li><code>*</code> - Search in all immediate all\r
-        subdirectories excluding the current and any deeper\r
-        subdirectories.</li>\r
-\r
-        <li><code>**</code> - Search in all subdirectories\r
-        recursively AND the current directory.</li>\r
-\r
-        <li><code>.</code> and <code>..</code> - The current\r
-        directory and the parent directory.</li>\r
-\r
-        <li><code>[title]</code> - All expressions in square\r
-        brackets are replace by the corresponding field in the\r
-        current entry</li>\r
-\r
-        <li><code>[extension]</code> - Is replaced by the\r
-        file-extension of the field you are using.</li>\r
-\r
-        <li>All other text is interpreted as a regular expression.\r
-        But caution: You need to escape backslashes by putting two\r
-        backslashes after each other to not confuse them with the\r
-        path-separator.</li>\r
-    </ul>\r
-\r
-    <p>The default for searches is\r
-    <code>**/.*[bibtexkey].*\\.[extension]</code>. As you can see\r
-    this will search in all subdirectories of the extension-based\r
-    directory (for instance in the PDF directory) for any file that\r
-    has the correct extension and contains the Bibtex-key\r
-    somewhere.</p>\r
-</body>\r
-</html>\r
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<link rel="stylesheet" type="text/css" href="jabref_help.css"/>
+</head>
+
+<body>
+
+    <h1>PDF/PS/URL/DOI links in JabRef</h1>
+
+    <p><b>Note:</b> JabRef 2.3
+    and later versions offer an <a href="FileLinks.html">improved
+    system for external file links</a>.</p>
+
+    <p>JabRef lets you link up your entries with PDF or PS files
+    stored on your system, as well as links to the document on the
+    web in the form of an URL or a DOI identifier.</p>
+
+    <h2>Setting up external viewers</h2>
+
+    <p>The program has to know
+    which external viewers to use for PDF, PS and web pages. These
+    are by default set to values that probably make sense for your
+    operating system, so there's a fair chance you don't have to
+    change these values.</p>
+
+    <p>To change the external viewer settings, go to <b>Options
+    -&gt; Preferences -&gt; External programs</b>.</p>
+
+    <h2>Opening external files or links</h2>
+
+    <p>There are several ways
+    to open an external file or web page. In the entry editor, you
+    can double click on the text field containing the file name,
+    DOI or URL. In the entry table you can select an entry and use
+    the menu choice, keyboard shortcut or the right-click menu to
+    open the file or web page. Finally, you can click on a PDF, PS,
+    URL or DOI icon.</p>
+
+    <p>By default the entry table will contain two columns with
+    icons for those entries that link to external files and URLs.
+    You can disable any of these in <b>Preferences -&gt; Table</b>.
+    The second column of the entry table shows icons for PDF or PS
+    files (only PDF if both are present), and the third column
+    shows icons for URL or DOI (only URL if both are present). You
+    open the file or web page by clicking on an icon.</p>
+
+    <p><b>Note:</b> If the PS field does not appear in the entry
+    editor (in the 'General' panel), you may have to
+    <a href="GeneralFields.html">customize the entry types of the
+    general fields</a>.</p>
+
+    <h2>The main PDF and PS directories</h2>
+
+    <p>JabRef makes it easy to
+    link PDF and PS files to your entries. To take advantage of
+    this, you have to indicate in <b>Options -&gt; Preferences
+    -&gt; External programs</b> your main PDF and PS directories.
+    All PDF and PS files that are stored in 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 PDF and PS
+    directories, or if several users use the same database from
+    different network places.</p>
+
+    <p>Additionally, if you give your PDF and PS files names that
+    correspond to the relevant entry's bibtex key (plus '.pdf' or
+    '.ps'), JabRef will be able to search your main directories and
+    its subfolders for the correct PDF and PS. Once the
+    correctly-named 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 the PDF or PS is found, the field will
+    immediately be set.</p>
+
+    <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. The downside is that the PDF or PS icon will not appear in
+    the table unless you do (manually or with the 'Auto'
+    button).</p>
+
+    <h2>The database-specific PDF and PS directories</h2>
+
+    <p>You can set PDF and PS directories specific to a database
+    (<b>File -&gt; Database properties</b>). These directories will
+    supersede the main directories.</p>
+
+    <h2><a name="RegularExpressionSearch"
+       id="RegularExpressionSearch">Using Regular Expression Search
+       for Auto-Linking</a></h2>
+
+    <p>In the previous sections JabRef's auto-linking feature was
+    described: If you choose names for your files corresponding to
+    the bibtex-key + plus the extension, JabRef will automatically
+    be able to find it.</p>
+
+    <p>Since JabRef 2.2 it is now possible to have greater
+    flexibility in the naming scheme by using regular expression
+    for the search. In most cases it should not be necessary though
+    to adapt the given default.</p>
+
+    <p>If you open the external preferences (Options -&gt;
+    Preferences -&gt; External Programs) you will find an option
+    called "Use Regular Expression Search". Checking this option
+    will allow you to enter your own regular expression for search
+    in the PDF directories.</p>
+
+    <p>The following syntax is understood:</p>
+
+    <ul>
+        <li><code>*</code> - Search in all immediate all
+        subdirectories excluding the current and any deeper
+        subdirectories.</li>
+
+        <li><code>**</code> - Search in all subdirectories
+        recursively AND the current directory.</li>
+
+        <li><code>.</code> and <code>..</code> - The current
+        directory and the parent directory.</li>
+
+        <li><code>[title]</code> - All expressions in square
+        brackets are replace by the corresponding field in the
+        current entry</li>
+
+        <li><code>[extension]</code> - Is replaced by the
+        file-extension of the field you are using.</li>
+
+        <li>All other text is interpreted as a regular expression.
+        But caution: You need to escape backslashes by putting two
+        backslashes after each other to not confuse them with the
+        path-separator.</li>
+    </ul>
+
+    <p>The default for searches is
+    <code>**/.*[bibtexkey].*\\.[extension]</code>. As you can see
+    this will search in all subdirectories of the extension-based
+    directory (for instance in the PDF directory) for any file that
+    has the correct extension and contains the Bibtex-key
+    somewhere.</p>
+</body>
+</html>