JAL-2316 Documentation update
authorkiramt <k.mourao@dundee.ac.uk>
Tue, 13 Dec 2016 08:58:26 +0000 (08:58 +0000)
committerkiramt <k.mourao@dundee.ac.uk>
Tue, 13 Dec 2016 08:58:26 +0000 (08:58 +0000)
help/html/webServices/urllinks.html
resources/lang/Messages.properties
resources/lang/Messages_es.properties

index 1a1f0d0..7ac76c1 100644 (file)
@@ -27,7 +27,9 @@
     <strong>Opening URLs from Jalview</strong><br> Both the applet
     and the desktop application are able to open URLs as 'popups' in
     your web browser. <br> Double-clicking on the ID of a sequence
-    will open the first URL that can be generated from its sequence ID.
+    will open the URL designated for 'popups' in the &quot;Connections&quot; tab of the <a
+    href="../features/preferences.html">Jalview desktop
+    preferences</a>.
     This is by default the EMBL-EBI site, but you can easily configure your own <a
       href="#urllinks">sequence URL links</a>.
   </p>
     href="../features/preferences.html">Jalview desktop
     preferences</a>, or specified as <a
     href="http://www.jalview.org/examples/appletParameters.html#parameters">applet
-    parameters</a>. <br> By default the item &quot;EMBL-EBI Search&quot; is added
-    to this link menu. This link will show a web page in your default
-    browser with the selected sequence id as part of the URL.<br>
-    In the preferences dialog box, click <strong>new</strong> to add a
+    parameters</a>.</p>
+    <p> 
+    By default, the list of available links in the preferences dialog box 
+    contains the item &quot;EMBL-EBI Search&quot;, 
+    which is set as the URL which opens on double-clicking on a sequence ID, and as a 
+    menu item in the Links menu. This link will show a web page in your default
+    browser with the selected sequence id as part of the URL.
+    <br>
+    Also by default, the list of available links contains persistent URLs for many common 
+    bioinformatics databases. These links are downloaded by Jalview from
+    the <em>identifiers.org</em> website, and the names and URLs are not user editable.
+    <br>
+    The list of links is sortable, by clicking on the headers of the table. The list
+    can be filtered using the free text search box below the table, or the 
+    &quot;Custom Only&quot; button, which displays only user-defined links.
+    </p> 
+    <p>
+    In the preferences dialog box, the links which appear in the Links menu 
+    can be configured by selecting or deselecting links in the &quot;In Menu&quot; 
+    column. The names of selected links will be displayed
+    on new menu items under the &quot;Link&quot; menu when you right
+    click on a sequence id.<br> 
+    You can configure which link is used when double-clicking on a sequence
+    by selecting or deselecting links in the &quot;On Click&quot; column. Exactly one
+    link must be configured for double-clicking. Since the link uses the sequence id
+    to construct the URL to open, the selected link must contain the 
+    &quot;$SEQUENCE_ID$&quot; token (see below for details of the &quot;$SEQUENCE_ID$&quot;
+    and other tokens).</p>
+    <p>
+    Additionally you can click <strong>new</strong> to add a
     new link, and <strong>edit</strong> to modify an existing link, or <strong>delete</strong>
-    to remove it.<br> You can name the link, this will be displayed
-    on a new menu item under the &quot;Link&quot; menu when you right
-    click on a sequence id. <br> The URL string must contain a
+    to remove it. Only URLs entered by the user (or the default EMBL-EBI link) may
+    be edited or deleted. When adding or editing a link, the URL string must contain a
     token that can be replaced with a sequence ID or DB accession ID. The simplest token is
     &quot;$SEQUENCE_ID$&quot;, which will be replaced by the chosen
     sequence id when you click on it. 
index 477b3d6..bee4809 100644 (file)
@@ -1285,5 +1285,5 @@ label.inmenu = In Menu
 label.id = ID
 label.urltooltip = Only one url, which must use a sequence id, can be selected for the 'On Click' option
 label.edit_sequence_url_link = Edit sequence URL link
-warn.name_cannot_be_duplicate = URL names must be unique
+warn.name_cannot_be_duplicate = URL names must be unique and cannot be MIRIAM ids
 label.invalid_name = Invalid Name !
\ No newline at end of file
index d2d04a9..99aeed5 100644 (file)
@@ -1286,5 +1286,5 @@ label.inmenu = In Menu
 label.id = ID
 label.urltooltip = Only one url, which must use a sequence id, can be selected for the 'On Click' option
 label.edit_sequence_url_link = Edit sequence URL link
-warn.name_cannot_be_duplicate = URL names must be unique
+warn.name_cannot_be_duplicate = URL names must be unique and cannot be MIRIAM ids
 label.invalid_name = Invalid Name !
\ No newline at end of file