JAL-2698 Cached PDB Entries -> Cached Structures in UI and help doc
[jalview.git] / help / html / features / viewingpdbs.html
index e62b2a7..45d979f 100755 (executable)
       </ul>
     </li>
     <li><strong>Selecting Structures</strong><br />You can select
-      the structures to you want to open and view by selecting them with
-      the mouse and keyboard.<br />By default, if structures were
+      the structures that you want to open and view by selecting them
+      with the mouse and keyboard.<br />By default, if structures were
       discovered, then some will already be selected according to the
       criteria shown in the drop-down menu. The default criteria is
       'highest resolution', simply choose another to pick structures in
       a different way.<br />
       <ul>
-        <li><strong>Viewing Cached Structures</strong><br />If you
-          have previously downloaded structures for your sequences, they
-          can be viewed by selecting the <strong>Cached PDB
-            Entries</strong> option from the drop down menu at the top of the
-          dialog box.</li>
+        <li><strong>Viewing Cached Structures</strong><br />If
+          previously downloaded structures are available for your
+          sequences, the structure chooser will automatically offer them
+          via the <strong>Cached Structures</strong> view. If you wish
+          to download new structures, select one of the PDBe selection
+          criteria from the drop-down menu.</li>
+      </ul></li>
+    <li><strong>To view selected structures, click the <strong>"View"</strong>
+        button.
+    </strong><br />
+      <ul>
+        <li>Additional structure data will be downloaded with the
+          EMBL-EBI's dbfetch service</li>
+        <li><a href="siftsmapping.html">SIFTS</a> records will also
+          be downloaded for mapping UniProt protein sequence data to PDB
+          coordinates.</li>
+        <li>A new structure viewer will open, or you will be
+          prompted to add structures to existing viewers (see <a
+          href="#afterviewbutton">below</a> for details).
+        </li>
       </ul></li>
-    <li>To view selected structures, click the <strong>"View"</strong>
-      button.
-    </li>
   </ol>
-
-  The
-  <a href="jmol.html">Jmol viewer</a> has been included since Jalview
-  2.3. Jalview 2.8.2 included support for
-  <a href="chimera.html">Chimera</a>, provided it is installed and can
-  be launched by Jalview. The default viewer can be configured in the
-  <a href="preferences.html#structure">Structure tab</a> in the
-  <strong>Tools&rarr;Preferences</strong> dialog box.
+  <p>
+    <strong>Structure Viewers in the Jalview Desktop</strong><br /> The
+    <a href="jmol.html">Jmol viewer</a> has been included since Jalview
+    2.3. Jalview 2.8.2 included support for <a href="chimera.html">Chimera</a>,
+    provided it is installed and can be launched by Jalview. The default
+    viewer can be configured in the <a href="preferences.html#structure">Structure
+      tab</a> in the <strong>Tools&rarr;Preferences</strong> dialog box.
   <p>
     Structure data imported into Jalview can also be processed to
     display secondary structure and temperature factor annotation. See
     the <a href="xsspannotation.html">Annotation from Structure</a> page
     for more information.
   </p>
-
+  <p>
+    <strong><a name="afterviewbutton">After pressing the
+        'View' button in the Structure Chooser</a></strong><br /> The behaviour of
+    the 'View' button depends on the number of structures selected, and
+    whether structure views already exist for the selected structures or
+    aligned sequences.
+  </p>
+  <p>If multiple structures are selected, then Jalview will always
+    create a new structure view. The selected structures will be
+    imported into this view, and superposed with the matched positions
+    from the aligned sequences. A message in the structure viewer's
+    status bar will be shown if not enough aligned columns were
+    available to perform a superposition.</p>
   <p>
     If a <strong>single</strong> PDB structure is selected, one of the
     following will happen:
 
     <li>If another structure is already shown for the current
       alignment, then you will be asked if you want to add and <a
-      href="jmol.html#align">align this structure</a> to the structure
-      in the existing view. (<em>new feature in Jalview 2.6</em>).
+      href="jmol.html#align"></a> to the structure in the existing view.
+      (<em>new feature in Jalview 2.6</em>).
     </li>
 
     <li>If the structure is already shown, then you will be
     retrieved with this service are derived directly from the PDB 3D
     structure data, which can be viewed in the same way above. Secondary
     structure and temperature factor annotation can also be added. <br />
-  </p>
-  <p>
-    <strong>Retrieving sequences from the PDB</strong><br>Jalview
-    will also read PDB files directly - either in PDB format, or <a
-      href="mmcif.html">mmCIF</a>. Simply load in the file as you would
-    an alignment file. The sequences of any protein or nucleotide chains
-    will be extracted from the file and viewed in the alignment window.
+
+    <br>Jalview will also read PDB files directly - either in PDB
+    format, or <a href="mmcif.html">mmCIF</a>. Simply load in the file
+    as you would an alignment file. The sequences of any protein or
+    nucleotide chains will be extracted from the file and viewed in the
+    alignment window.
   </p>
 
   <p>
       Features"</strong> menu item and the <a href="featuresettings.html">Feature
       Settings dialog box</a>.
   </p>
-  <br/>
+  <br />
   <hr>
   <p>
     <strong>Switching between mmCIF and PDB format for
     wwwPDB. If you prefer (for any reason) to download data as PDB files
     instead, then first close Jalview, and add the following line to
     your .jalview_properties file:<br />
-    <code> DEFAULT_STRUCTURE_FORMAT=PDB </code>
+    <code> PDB_DOWNLOAD_FORMAT=PDB </code>
     <br /> When this setting is configured, Jalview will only request
     PDB format files from EMBL-EBI's PDBe.<br /> <em>mmCIF format
       file support was added in Jalview 2.10.</em>