JAL-1477 documentation and tooltips
authorJim Procter <jprocter@dundee.ac.uk>
Sat, 17 May 2014 11:55:19 +0000 (12:55 +0100)
committerJim Procter <jprocter@dundee.ac.uk>
Sat, 17 May 2014 11:55:19 +0000 (12:55 +0100)
help/html/features/jmol.html
help/html/features/pdbviewer.html
help/html/features/viewingpdbs.html
help/html/menus/popupMenu.html
resources/lang/Messages.properties

index b3c3570..19f1761 100644 (file)
 <p><strong>The Jmol PDB Viewer</strong></p>
 <p>Since Jalview 2.3, <a href="http://jmol.sourceforge.net/">Jmol</a>
 has been integrated into Jalview for interactively viewing structures
-opened by selecting the <strong>&quot;Structure&#8594;View PDB
-entry:&quot;</strong> option in the <a href="../menus/popupMenu.html">sequence
+opened by entries in the <strong>&quot;Structure&quot;</strong> submenu in the <a href="../menus/popupMenu.html">sequence
 id pop-up menu</a> (if you can't see this, then you need to <a
        href="viewingpdbs.html">associate a PDB structure</a> with the
 sequence). Jmol is available from the Jalview desktop and should also
 run in the JalviewLite applet, providing the browser supports Java 1.5.
 If Jmol is not available, then the original <a href="pdbviewer.html">internal
 pdb viewer</a> will be used as a fallback.</p>
+<p>The following menu entries are provided for viewing structure data<br>
+  <ul>
+    <li>The <strong>&quot;Structure&#8594;View
+        Structure&#8594;</strong> submenu allows a single PDB structure to be chosen
+      for display from the available structures for a sequence.
+    </li>
+    <li>The <strong>&quot;Structure&#8594;View all <em>N</em>
+        structures
+    </strong> option will open a new window containing all structures associated
+      with the current selection.
+    </li>
+    <li>The <strong>&quot;Structure&#8594;View all <em>N</em>
+        representative structures
+    </strong> option will open a new window containing exactly one structure per
+      currently selected sequence.<br />
+    <em>The View representative structures option was introduced in
+        Jalview 2.8.1</em></li>
+  </ul>
+  <br> 
+</p>
 <p><a name="align"><strong>Superposing structures based
 on their aligned sequences</strong></a><br>
 If several structures are available on the alignment, you may add
index 10924a5..c1c6ae7 100755 (executable)
@@ -29,9 +29,11 @@ PDB viewer, which is only used in situations where Jmol is unavailable
 or cannot operate.</p>
 <p><strong>The PDB Viewer Window</strong>
 <p>This interactive structure viewing window is opened by selecting
-the <strong>&quot;Sequence&#8594;View PDB entry:&quot;</strong> entry in
-the <a href="../menus/popupMenu.html">sequence id pop-up menu</a>. This
-can only be done for sequences which have an <a href="viewingpdbs.html">associated
+entries from the <strong>&quot;Structure&#8594;&quot;</strong> submenu
+               of the <a href="../menus/popupMenu.html">sequence
+                       id pop-up menu</a>. The internal PDB viewer is not able to show
+               superpositions, so no other options are provided. Structures can only
+               be viewed for sequences which have an <a href="viewingpdbs.html">associated
 PDB structure</a>, and the PDB Viewer will only be associated with the
 particular alignment view from which it was opened.</p>
 <p><strong>Controls</strong></p>
index 6c10e98..144489b 100755 (executable)
 <p><strong>Viewing PDB Structures</strong></p>
 
 <p>Jalview can view protein structures associated with a sequence
-via the <strong>"Structure&rarr;View PDB entry:"</strong> entries from a
-sequence's <a href="../menus/popupMenu.html">pop-up menu</a>. Once a pdb
+via the <strong>"Structure&rarr;"</strong> submenu from a
+sequence's <a href="../menus/popupMenu.html">pop-up menu</a>.</p>
+<p>The following menu entries are provided for viewing structure data<br>
+  <ul>
+    <li>The <strong>&quot;Structure&#8594;View
+        Structure&#8594;</strong> submenu allows a single PDB structure to be chosen
+      for display from the available structures for a sequence.
+    </li>
+    <li>The <strong>&quot;Structure&#8594;View all <em>N</em>
+        structures
+    </strong> option will open a new window containing all structures associated
+      with the current selection, superposed according to the currently selected region of the alignment.<br/><em>This
+      capability was added in Jalview 2.7</em>
+    </li>
+    <li>The <strong>&quot;Structure&#8594;View all <em>N</em>
+        representative structures
+    </strong> option will open a new window containing exactly one structure per
+      currently selected sequence.<br />
+    <em>The View representative structures option was introduced in
+        Jalview 2.8.1</em></li>
+  </ul>
+  <br> 
+</p>
+
+<p>If a single pdb
 structure is selected, one of the following will happen:</p>
 
 <ul>
@@ -44,17 +67,6 @@ structure is selected, one of the following will happen:</p>
        <li style="list-style: none">See the <a href="jmol.html">Jmol
        PDB viewer</a> help page for more information about the display.</li>
 </ul>
-       <p>
-               <em>Opening structures associated with the current selection</em><br />
-               If one or more of the sequences in the alignment are selected, then
-               the Structure submenu of the <a href="../menus/popupMenu.html">Sequence
-                       ID popup menu</a> will contain will include either a 'View all <em>X</em>
-               structures' entry in the submenu or a 'View structure for <em>Sequence</em>'
-               entry. Both these options will open a new Jmol view containing one, or
-               all the structures available for all selected sequences, superimposed
-               using the currently selected region of the alignment. (<em>This
-                       capability was added in Jalview 2.7</em>)
-       </p>
        <p><strong>Associating PDB files with Sequences</strong></p>
        <p>To associate PDB files with a sequence, right click on a sequence
 ID and select "Structure<strong>&rarr;</strong> Associate Structure with
index 6ceccee..71b2603 100755 (executable)
@@ -148,11 +148,11 @@ not be accessible when in 'Cursor Mode' (toggled with the F2 key).</em></p>
           <li><strong>From File<br>
             </strong><em>Load a PDB file from local disk which will be associated 
             with this sequence. This file will be used if the user subsequently 
-            clicks on &quot;View PDB Structure&quot; menu item.</em></li>
+            clicks on &quot;View Structure&quot; menu item.</em></li>
           <li><strong>Enter PDB id<br>
             </strong><em>Enter the PDB id from an input window. This PDB id will 
             be used by the service WSDBFetch, provided by the EBI, to fetch the 
-            PDB file if the user subsequently clicks on &quot;View PDB Structure&quot; 
+            PDB file if the user subsequently clicks on its &quot;View Structure&quot; 
             menu item. </em></li>
           <li><strong>Discover PDB ids<br>
             </strong><em>This will use the service WSDBFetch, provided by the 
@@ -169,6 +169,24 @@ not be accessible when in 'Cursor Mode' (toggled with the F2 key).</em></p>
                        href="../features/viewingpdbs.html">associated PDB structures</a>.<br/>
                        If the sequence or alignment has RNA structure, then <strong>2D RNA</strong> entries will also be present enabling you to open a linked view of the RNA structure in <a href="../features/varna.html">VARNA</a>.</em><br>
       </li>
+      <p><em>Other menu entries may also be shown if the current selection includes sequences with associated structure data:</em><br>
+  <ul>
+    <li><strong>&quot;Structure&#8594;View all <em>N</em>
+        structures<br/>
+    </strong><em>Opens a new window containing all structures associated
+      with the current selection, superposed according to the currently selected region of the alignment.<br/>(This
+      capability was added in Jalview 2.7)</em>
+    </li>
+    <li><strong>&quot;Structure&#8594;View all <em>N</em>
+        representative structures<br/>
+    </strong><em>Open a new window containing exactly one structure per
+      currently selected sequence.<br />
+    (The View representative structures option was introduced in
+        Jalview 2.8.1)</em></li>
+  </ul>
+  <br> <li>
+      
+      </li>
     </ul>
   </li>
   <li><strong>Hide Sequences</strong><br>
index 906db68..6736791 100644 (file)
@@ -463,8 +463,8 @@ label.jalview_cut = Cut (Jalview Only)
 label.to_upper_case = To Upper Case\r
 label.to_lower_case = To Lower Case\r
 label.toggle_case = Toggle Case\r
-label.edit_name_description = Edit Name/Description\r
-label.create_sequence_feature = Create Sequence Feature\r
+label.edit_name_description = Edit Name/Description ...\r
+label.create_sequence_feature = Create Sequence Feature ...\r
 label.edit_sequence = Edit Sequence\r
 label.edit_sequences = Edit Sequences\r
 label.sequence_details = Sequence Details\r
@@ -629,7 +629,7 @@ label.edit_name_and_description_current_group = Edit name and description of cur
 label.view_structure_for = View structure for {0}\r
 label.view_all_structures = View all {0} structures.\r
 label.view_all_representative_structures = View all {0} representative structures.\r
-label.open_new_jmol_view_with_all_representative_structures_associated_current_selection_superimpose_using_alignment = "Opens a new Jmol view with all representative structures\nassociated with the current selection\nsuperimposed with the current alignment."\r
+label.open_new_jmol_view_with_all_representative_structures_associated_current_selection_superimpose_using_alignment = Opens a new Jmol view with all representative structures\nassociated with the current selection\nsuperimposed with the current alignment.\r
 label.associate_structure_with_sequence = Associate Structure with Sequence\r
 label.from_file = from file\r
 label.enter_pdb_id = Enter PDB Id\r