JAL-674 JAL-1512 JAL-1333 documentation
authorJim Procter <jprocter@dundee.ac.uk>
Tue, 18 Nov 2014 09:44:36 +0000 (09:44 +0000)
committerJim Procter <jprocter@dundee.ac.uk>
Tue, 18 Nov 2014 09:44:36 +0000 (09:44 +0000)
help/html/features/preferences.html
help/html/features/viewingpdbs.html
help/html/features/xsspannotation.html [new file with mode: 0644]

index b2d8b93..5d4ab4d 100755 (executable)
@@ -113,13 +113,12 @@ will be loaded.</p>
 <p><a name="structure"><strong>&quot;Structure&quot;
 Preferences tab</strong></a><em> added in Jalview 2.8.2</em></p>
 <p><em>Process secondary structure from PDB</em> - if selected, then structure information
-read from PDB will be processed to derive secondary structure annotation.
-<p><em>Use RNAView for secondary structure</em> - if selected, the RNAView service will be 
-automatically called to derive secondary structure information.
-<p><em>Add secondary structure annotation to alignment</em> - if selected, PDB secondary structure
-annotation will be shown on the alignment when available.
-<p><em>Add Temperature Factor annotation to alignment</em> - if selected, PDB Temperature Factor
-annotation will be shown on the alignment when available. 
+read from PDB will be processed and annotation added to associated sequences.
+<p><em>Use RNAView for secondary structure</em> - if selected, the pyRNA RNAView service (<a href="https://github.com/fjossinet/PyRNA">https://github.com/fjossinet/PyRNA</a>) will be 
+called to derive secondary structure information for RNA chains.
+<p><em>Add secondary structure annotation to alignment</em> - if selected, <a href="http://swift.cmbi.ru.nl/gv/dssp/">Jmol's implementation DSSP</a> will be used to add annotation to polypeptide chains in the structure.
+<p><em>Add Temperature Factor annotation to alignment</em> - if selected, values extracted from the Temperature Factor
+column for the backbone atoms in the PDB file will be extracted as annotation lines shown on the alignment. 
 <p><em>Default structure viewer</em> - choose JMOL or CHIMERA for viewing 3D structures. 
 <p><em>Path to Chimera program</em> - Optional, as Jalview will search standard installation paths for Windows, Linux or MacOS. 
 If you have installed Chimera in a non-standard location, you can specify it here. Enter the full path to the Chimera executable program.  
index 8fc557e..75a5c9c 100755 (executable)
 </head>
 <body>
 <p><strong>Viewing PDB Structures</strong></p>
-
-<p>Jalview can view protein structures associated with a sequence
-via the <strong>"Structure&rarr;"</strong> submenu from a
-sequence's <a href="../menus/popupMenu.html">pop-up menu</a>.</p>
-A <a href="jmol.html">Jmol viewer</a> has been included since Jalview 2.3. Jalview 2.8.2 added support for <a href="https://www.cgl.ucsf.edu/chimera/">Chimera</a>,
-provided this has been separately installed. Choice of default viewer is configurable in the Preferences <a href="preferences.html#structure">Structure tab</a>. 
-  
-<p>The following menu entries are provided for viewing structure data<br>
+       <p>
+               Jalview can view protein structures associated with a sequence via the
+               <strong>"Structure&rarr;"</strong> submenu from a sequence's <a
+                       href="../menus/popupMenu.html">pop-up menu</a>.
+       </p>
+       The
+       <a href="jmol.html">Jmol viewer</a> has been included since Jalview
+       2.3. Jalview 2.8.2 included support for
+       <a href="https://www.cgl.ucsf.edu/chimera/">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>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
diff --git a/help/html/features/xsspannotation.html b/help/html/features/xsspannotation.html
new file mode 100644 (file)
index 0000000..0dc7475
--- /dev/null
@@ -0,0 +1,90 @@
+<html>
+<!--
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
+ * Copyright (C) 2014 The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ -->
+<head>
+<title>Annotation from 3D structure data</title>
+</head>
+<body>
+       <p>
+               <strong>Working with annotation from 3D structure data</strong>
+       </p>
+       <p>
+               Jalview can process PDB data associated with sequences to display
+               values extracted from the <em>Temperature Factor</em> column for
+               corresponding sites, and secondary structure from DSSP or RNAView (as
+               appropriate).
+       </p>
+       <p>
+               <strong>Extracting data from PDB files<br /></strong>Annotation is
+               created for structure files retrieved directly from the PDB loaded
+               from the file system (via the <strong>Structure&rarr;Associate
+                       Structure...&rarr;From file</strong> option, or when displayed via the View
+               Structures Menu.<br /> Structure annotation is not automatically
+               added to an alignment, but any available structure annotation rows for
+               the current selection or a particular sequence can be added via the <strong>Add
+                       Reference Annotation</strong> in the <strong>Selection</strong> and <strong>Sequence
+                       ID</strong> sub-menus of the Sequence ID Panel's popup menu.<br/> <em>Please
+                       note:</em>Protein structures are analysed
+               <em>in situ</em>, but Jalview employs a web service to process RNA
+               structures which can cause long delays if your internet connection is
+               slow.
+       </p>
+       <p>
+               The <a href="../menus/alwannotation.html"><em>Annotations</em>
+                       alignment menu</a> provides settings useful for controlling the display
+               of secondary structure annotation.
+       </p>
+       <p>
+               <strong>Shading sequences by associated structure annotation<br /></strong>The
+               annotation colouring dialog (opened by the <strong>Colour&rarr;By
+                       Annotation</strong> option) allows sequences with associated secondary
+               structure data to be shaded according to secondary structure type.
+               Once the dialog is opened, select the <em>Per Sequence</em> option and
+               then choose <em>Secondary structure</em> from the dropdown menu.<br />When
+               colouring alignments by secondary structure, two modes can be
+               employed. The default is to shade sequences with the same colour as
+               the secondary structure glyph. If, however, <em>original colours</em>
+               is selected and another colourscheme has already been applied, then
+               only portions of the sequence with defined secondary structure will be
+               shaded with the previously applied scheme.<br />
+       </p>
+       <p>
+               <strong>Configuration options for processing PDB files<br /></strong>
+               Occasionally, you may wish to disable secondary structure processing. 
+               Configuration options in the <strong>Structure</strong> tab in the <strong>Tools&rarr;Preferences</strong>
+               dialog allow the processing of structure data to be disabled, or
+               selectively enabled. For more information, take a look at the <a href="preferences.html#structure">documentation for the structure panel</a>.
+       </p>
+       <p>
+               <em>The display of secondary structure data was introduced in
+                       Jalview 2.8.2, and is made possible by Jalview's use of <a
+                       href="jmol.html">Jmol's DSSP implementation</a>, based on the
+                       original <a href="http://www.ncbi.nlm.nih.gov/pubmed/6667333">Kabsch
+                               and Sander algorithm</a> ported by <a
+                       href="http://swift.cmbi.ru.nl/gv/dssp/">Robbie P. Joosten and
+                               colleagues</a>, and a client for <a
+                       href="https://github.com/fjossinet/PyRNA">Fabrice Jossinet's
+                               pyRNA services</a> that was developed by Anne Menard, Jim Procter and
+                       Yann Ponty as part of the Jalview Summer of Code 2012.
+               </em>
+       </p>
+</body>
+</html>