Merge branch 'develop' into bug/JAL-1608createGroups
[jalview.git] / help / html / features / preferences.html
index 235ce3f..da045ba 100755 (executable)
@@ -1,7 +1,7 @@
 <html>
 <!--
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
- * Copyright (C) 2015 The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
       and displaying structure information.
     </li>
     <li>The <a href="#connections"><strong>&quot;Connections&quot;</strong>
-        Preferences</a> tab allows you to change the links made from Jalview
-      to your default web browser.
+        Preferences</a> tab allows you to configure Jalview's internet
+      settings and specify your default web browser.
+    </li>
+    <li>The <a href="#links"><strong>&quot;Links&quot;</strong>
+        Preferences</a> tab shows the currently configured <em>URL
+        Links</em> shown in the <strong>Link</strong> submenu in the Sequence
+      ID popup menu.
     </li>
     <li>The <a href="#output"><strong>&quot;Output&quot;</strong>
         Preferences</a> tab contains settings affecting the export of
@@ -63,8 +68,8 @@
     </li>
     <li>The <a href="../webServices/webServicesPrefs.html"><strong>&quot;Web
           Service&quot;</strong> Preferences</a> tab allows you to configure the <a
-      href="http://www.compbio.dundee.ac.uk/jabaws"
-    >JABAWS</a> servers that Jalview uses, and change the layout of the
+      href="http://www.compbio.dundee.ac.uk/jabaws">JABAWS</a>
+      servers that Jalview uses, and change the layout of the
       alignment's Web Services menu.
     </li>
   </ul>
@@ -78,9 +83,8 @@
   </p>
   <p>
     <em>Open Overview Window</em> - When this is selected, the <a
-      href="overview.html"
-    >alignment overview</a> panel is opened by default for a new alignment
-    window.
+      href="overview.html">alignment overview</a> panel is opened
+    by default for a new alignment window.
   </p>
   <p>
     <em>Show Annotations</em> - If this is selected the new window will
     <em>Open file</em> - If this is selected then the default alignment
     file will be opened when Jalview is started. You can change the
     default file by clicking on file name and either typing in the file
-    path or selecting it from the file chooser window.<br />
-    <em>Note: The default example alignment is updated periodically
-      to demonstrate new features in Jalview.</em>
+    path or selecting it from the file chooser window.<br /> <em>Note:
+      The default example alignment is updated periodically to
+      demonstrate new features in Jalview.</em>
   </p>
   <p>
     <a name="colours"><strong>&quot;Colours&quot;
   <p>
     <em>Annotation Shading Default</em> - set the default minimum and
     maximum colours used when <a
-      href="../colourSchemes/annotationColouring.html"
-    >Colour by Annotation...</a> is selected from the alignment window's
-    colours menu.
+      href="../colourSchemes/annotationColouring.html">Colour
+      by Annotation...</a> is selected from the alignment window's colours
+    menu.
   </p>
   <p>
     <a name="structure"><strong>&quot;Structure&quot;
         Preferences tab</strong></a>
   </p>
   <p>
-    <em>URL Link From Sequence ID</em><br> These definitions are
-    used to generate URLs from a sequence's ID or database cross
-    references. Read more about <a
-      href="../webServices/urllinks.html#urllinks"
-    >configuring URL links here</a>.
-  </p>
-  <p>
     <em>Default Browser (Unix)</em><br> Its difficult in Java to
     detect the default web browser for Unix users. If Jalview can't find
     your default web browser, enter the name or full path to your web
       statement</a> for more information.
   </p>
   <p>
+    <a name="links"><strong>The &quot;Links&quot; Preferences
+        tab</strong></a>
+  </p>
+  <p>
+    This panel shows a table, and two sections - <em>Edit</em> and <em>Filter</em>.
+    The table shows the available URL link definitions (consisting of a
+    database, Name, and URL template string), a checkbox <em>In
+      Menu</em> which indicates if the link is enabled, and <em>Double
+      Click</em> which marks the link that will be opened if a sequence's ID
+    is double clicked. The table can be sorted by clicking on the column headers.
+  </p>
+  <p><em>Edit Links</em><br /> This section contains three buttons,
+    <em>New</em>, <em>Edit</em> and <em>Delete</em>, which allow you to
+    create, modify and remove user-defined URL links from the Sequence
+    ID's links submenu.
+  </p>
+  <p>
+    <em>Filter</em><br /> The <em>Filter text</em> box allows you to
+    quickly show rows in the table containing a particular text string.
+    The <em>Custom only</em> button limits the entries in the table to
+    just those you have configured yourself <em>via</em> the <em>Edit
+      Links</em> buttons. Press <em>Show all</em> to clear any filters.
+  <p>
+    <a href="../webServices/urllinks.html#urllinks">Read more about configuring
+      URL links.</a>
+  </p>
+  <p>
     <a name="output"><strong>Output Preferences tab</strong></a>
   </p>
   <p>
   </p>
   <p>
     When this option is enabled, Jalview embeds <a
-      href="bioJsonFormat.html"
-    >BioJSON</a> data within HTML files exported from Jalview at
-    generation time. This enables the exported HTML files to be
-    extracted and imported back into the Jalview desktop application at
-    a later time.
+      href="bioJsonFormat.html">BioJSON</a> data within HTML files
+    exported from Jalview at generation time. This enables the exported
+    HTML files to be extracted and imported back into the Jalview
+    desktop application at a later time.
   <p>
     <em>Use Modeller Output</em>
   </p>
     and PDB file association (if available). The Jalview id/start-end
     option is ignored if Modeller output is selected.
   <p>
-    <a name="editing"><strong>Editing Preferences tab</strong></a>
+    <a name="editing"><strong>e&quot;Editinge&quot; Preferences tab</strong></a>
   </p>
   <p>There are currently three options available which can be
     selected / deselected.</p>