JAL-2316 tidied up documentation for Links tab
authorJim Procter <jprocter@issues.jalview.org>
Wed, 8 Feb 2017 16:33:35 +0000 (16:33 +0000)
committerJim Procter <jprocter@issues.jalview.org>
Wed, 8 Feb 2017 16:33:35 +0000 (16:33 +0000)
help/help.jhm
help/helpTOC.xml
help/html/features/preferences.html
help/html/webServices/urllinks.html

index f69ed00..984c2d1 100755 (executable)
    
    <mapID target="uniprotfetcher" url="html/features/uniprotsequencefetcher.html" />
    
+   <mapID target="urllinks" url="html/webServices/urllinks.html" />
+   <mapID target="linksprefs" url="html/features/Preferences.html#links" />
+
    <mapID target="backIcon" url="icons/back.png" />
    <mapID target="forwardIcon" url="icons/forward.png" />
    <mapID target="homeIcon" url="icons/Home.png" />
index 54abd53..482ccdf 100755 (executable)
                        <tocitem text="Chimera Viewer" target="chimera" />                      
                </tocitem>
                <tocitem text="Viewing RNA structures" target="varna" expand="false"/>
+               <tocitem text="Opening URLs from Jalview" target="urllinks" expand="true">
+                   <tocitem text="Configuring URL Links" target="urllinkspref" />
+               </tocitem>
                <tocitem text="VAMSAS Data Exchange" target="vamsas">
                        <!-- what can Jalview share with other apps -->
                        <!-- what other apps exist -->
index 6a8c86c..fb21836 100755 (executable)
       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
         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>
index 0da8a4d..da5d7dd 100644 (file)
 </head>
 <body>
   <p>
-  <p>
     <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 whichever URL is selected for 'popups' in the &quot;Links&quot; tab of the <a
-    href="../features/preferences.html">Jalview desktop
+    your web browser.</p>
+    <p> Double-clicking on the ID of a sequence
+    will open whichever URL is selected for 'popups' in the <strong>&quot;Links&quot;</strong> tab of the <a
+    href="../features/preferences.html#links">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>
   <p>
     <strong><a name="urllinks">Configuring URL Links</a></strong> <br>URL
-    links are defined in the &quot;Connections&quot; tab of the <a
-    href="../features/preferences.html">Jalview desktop
+    links are defined in the &quot;Links&quot; tab of the <a
+    href="../features/preferences.html#links">Jalview desktop
     preferences</a>, or specified as <a
     href="http://www.jalview.org/examples/appletParameters.html#parameters">applet
     parameters</a>.</p>
-    <p> 
-    By default, the list of available links in the preferences dialog box 
-    contains the item &quot;EMBL-EBI Search&quot;. 
-    This link is initially configured so that it is the URL which opens on double-clicking on a sequence ID. It is also a 
-    menu item in the &quot;Link&quot; menu. When clicked, 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 in the preferences dialog box contains persistent URLs for many common 
+  <p>
+    <em>Default Link Settings</em><br /> The &quot;EMBL-EBI Search&quot;
+    link is the default link shown in the &quot;Link&quot; submenu, and
+    opened when double-clicking on a sequence ID. When clicked, this
+    link will show a web page in your default browser with the selected
+    sequence ID as part of the URL.
+  </p>
+  <p>
+    <em>Adding additional links</em><br /> You can configure your own
+    links via the Jalview <a href="../features/preferences.html#links"><strong>Preferences</strong></a>
+    dialog. Jalview also provides 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 can be sorted 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 &quot;Link&quot; menu 
-    can be configured by selecting or deselecting links in the &quot;In Menu&quot; 
-    column. The names of selected links will be displayed
-    as 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. 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. 
+    the <em>identifiers.org</em> website, and the names and URLs are not
+    user editable.
   </p>
   <p>
-    eg.<br> UniRef100 =
-    http://www.ebi.uniprot.org/uniprot-srv/uniRefView.do?proteinAc=$SEQUENCE_ID$&amp;library=uniref100<br>
-    Swissprot = http://www.expasy.org/uniprot/$SEQUENCE_ID$ <br> <br>
+    <em>Creating your own URL link</em> URL links are specified as a
+    template containing special tokens that Jalview will replace with
+    the Sequence ID or Database Accession of the sequence when you
+    double click on its ID or open it's <strong>Link</strong> submenu.
+    Link URL templates must contain at least one token. 
+  </p>
+    <em>eg.</em><pre> UniRef100 =
+    http://www.ebi.uniprot.org/uniprot-srv/uniRefView.do?proteinAc=$SEQUENCE_ID$&amp;library=uniref100<br/>
+    Swissprot = http://www.expasy.org/uniprot/$SEQUENCE_ID$ <br> </pre>
+  <p>
     Links will also be made for any database cross references associated
     with the sequence where the database name exactly matches a URL link
     name. In this case, the $DB_ACCESSION$ string will be replaced with
   <p>
     <strong>Regular Expression Substitution</strong><br> A url may
     contain a string of the form $SEQUENCE_ID=/<em>regular
-    expression</em>/=$ or $DB_ACCESSION=/<em>regular expression</em>/=$. 
-    In this case, the regular expression will be
-    applied to the full sequence ID or DB accession ID string and the resulting match will
+      expression</em>/=$ or $DB_ACCESSION=/<em>regular expression</em>/=$. In
+    this case, the regular expression will be applied to the full
+    sequence ID or DB accession ID string and the resulting match will
     be inserted into the URL. Groups of parentheses can be used to
     specify which regions of the regular expression will be used to
     generate the URL:
+  
   <ul>
     <li>Each top level parenthesis will yield a URL containing the
       text matched within that parenthesis.</li>
     <li>Regions matching sub-parentheses within a top-level
       parenthesis will be concatenated to form the text inserted into
       the URL for the top-level parenthesis.</li>
-    <em>Please Note:
-      <ul>
-        <li>The regular expressions supported by Jalview are those
-          provided by the <a href="http://www.javaregex.com">Stevesoft
-            javaregex package</a>.
-        </li>
-        <li>Some characters must be escaped when specifying them as
-          a match within a regular expression.</li>
-      </ul> <br> Many Thanks to Bernd Brandt of the Free University of
-      Amsterdam for testing this new regular-expression expansion
-      feature!
-    </em>
-    <em>
   </ul>
-  </p>
-  </p>
+  <em>Please Note:</em>
+    <ul>
+      <li>The regular expressions supported by Jalview are those
+        provided by the <a href="http://www.javaregex.com">Stevesoft
+          javaregex package</a>.
+      </li>
+      <li>Some characters must be escaped when specifying them as a
+        match within a regular expression.</li>
+    </ul> <br> Many Thanks to Bernd Brandt of the Free University of
+    Amsterdam for testing the regular-expression expansion feature!
 </body>
 </html>