help/html/features/preferences.html

   1 <html>
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   4  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   5  *
   6  * This file is part of Jalview.
   7  *
   8  * Jalview is free software: you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation, either version 3
  11  * of the License, or (at your option) any later version.
  12  *
  13  * Jalview is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty
  15  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  16  * PURPOSE.  See the GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  20  * The Jalview Authors are detailed in the 'AUTHORS' file.
  21  -->
  22 <head>
  23 <title>Preferences</title>
  24 </head>
  25
  26 <body>
  27   <p>
  28     <strong>Preferences</strong>
  29   </p>
  30   <p>
  31     The preferences panel is opened from the Jalview Desktop&rsquo;s <strong><em>Tools</em></strong>
  32     menu.
  33   </p>
  34   <p>There are eight tabs in the Preferences dialog box:
  35   <ul>
  36     <li>The <a href="#visual"><strong>&quot;Visual&quot;</strong>
  37         Preferences</a> tab allows you to configure the default display for
  38       a new alignment window.
  39     </li>
  40     <li>The <a href="#colours"><strong>&quot;Colours&quot;</strong>
  41         Preferences</a> tab allows you to configure default colourschemes
  42       for a new alignment window.
  43     </li>
  44     <li>The <a href="#structure"><strong>&quot;Structure&quot;</strong>
  45         Preferences</a> tab allows you to configure options for obtaining
  46       and displaying structure information.
  47     </li>
  48     <li>The <a href="#connections"><strong>&quot;Connections&quot;</strong>
  49         Preferences</a> tab allows you to configure Jalview's internet
  50       settings and specify your default web browser.
  51     </li>
  52     <li>The <a href="#links"><strong>&quot;Links&quot;</strong>
  53         Preferences</a> tab shows the currently configured <em>URL
  54         Links</em> shown in the <strong>Link</strong> submenu in the Sequence
  55       ID popup menu.
  56     </li>
  57     <li>The <a href="#output"><strong>&quot;Output&quot;</strong>
  58         Preferences</a> tab contains settings affecting the export of
  59       sequence alignments and EPS files.
  60     </li>
  61     <li>The <a href="#editing"><strong>&quot;Editing&quot;</strong>
  62         Preferences</a> tab contains settings affecting the export of
  63       sequence alignments and EPS files.
  64     </li>
  65     <li>The <a href="dassettings.html"><strong>&quot;DAS
  66           Settings&quot;</strong> Preferences</a> tab allows you to select which DAS
  67       sources to use when fetching DAS Features.
  68     </li>
  69     <li>The <a href="../webServices/webServicesPrefs.html"><strong>&quot;Web
  70           Service&quot;</strong> Preferences</a> tab allows you to configure the <a
  71       href="http://www.compbio.dundee.ac.uk/jabaws">JABAWS</a>
  72       servers that Jalview uses, and change the layout of the
  73       alignment's Web Services menu.
  74     </li>
  75   </ul>
  76   </p>
  77   <p>
  78     <strong><a name="visual">Visual</a> Preferences tab</strong>
  79   </p>
  80   <p>
  81     <em>Maximise Window</em> - If this is selected, a new alignment
  82     window will stretch to fit the available space.
  83   </p>
  84   <p>
  85     <em>Open Overview Window</em> - When this is selected, the <a
  86       href="overview.html">alignment overview</a> panel is opened
  87     by default for a new alignment window.
  88   </p>
  89   <p>
  90     <em>Show Annotations</em> - If this is selected the new window will
  91     display an annotation panel below the sequences. This annotation
  92     panel may have several rows describing the whole alignment. The 3
  93     standard annotations <em>Conservation</em>, <em>Quality</em> and <em>Consensus</em>
  94     for the alignment may be shown or hidden by default using the
  95     checkboxes below.
  96   </p>
  97   <p>
  98     <em>Show group: Conservation and Consensus</em> controls the display
  99     of per-group automatic annotation.
 100   </p>
 101   <p>
 102     <em>Consensus: Histogram and Logo</em> checkboxes control the
 103     display of the consensus histogram and sequence logo for consensus
 104     annotation rows.
 105   </p>
 106   <p>
 107     <em>Full Sequence ID</em> - If selected the ID panel will display
 108     the name of a sequence plus the start and end residues in the format
 109     name/start-end. If not selected, the displayed ID will be the name
 110     of the sequence.
 111   </p>
 112   <p>
 113     <em>Right Align IDs</em> - select to align all sequence IDs to the
 114     left-hand edge of the sequence alignment, rather than the left-hand
 115     edge of the alignment display window.
 116   </p>
 117   <p>
 118     <em>Font</em> - The default font name, size and style can be set for
 119     a new alignment window.
 120   </p>
 121   <p>
 122     <em>Sequence ID Tooltip</em>: Control the display of Database
 123     References and Non-positional annotation in the tooltip displayed
 124     when the mouse is over a sequence's ID.
 125   </p>
 126   <p>
 127     <em>Show Unconserved</em> - When this is selected, all consensus
 128     sequence symbols will be rendered as a '.', highlighting mutations
 129     in highly conserved alignments.
 130   </p>
 131   <p>
 132     <em>Sequence Name Italics</em> - select to apply the italicised
 133     version of the font to sequence labels.
 134   </p>
 135   <p>
 136     <em>Smooth Font</em> - Toggles anti-aliasing on / off for faster
 137     rendering of the alignment.
 138   </p>
 139   <p>
 140     <em>Gap Symbol</em> - The default gap symbol may be set to either
 141     &quot;-&quot; or &quot;.&quot;
 142   </p>
 143   <p>
 144     <em>Wrap Alignment</em> - Select whether to open new alignment
 145     windows in wrapped mode or not.
 146   </p>
 147   <p>
 148     <em>Sort alignment by</em> - When the alignment is loaded in, it can
 149     be ordered as read (No sort), or sorted by Id or pairwise identity.
 150   </p>
 151   <p>
 152     <em>Sort annotations by</em> - Annotations can be unsorted, sorted
 153     by the order of the related sequences in the alignment, or by label.
 154     Autocalculated annotations (e.g. Consensus) can be shown either last
 155     (below sequence annotations) or first (above sequence annotations).
 156     <em>Since Jalview 2.8.2.</em>
 157   </p>
 158   <p>
 159     <em>Open file</em> - If this is selected then the default alignment
 160     file will be opened when Jalview is started. You can change the
 161     default file by clicking on file name and either typing in the file
 162     path or selecting it from the file chooser window.<br /> <em>Note:
 163       The default example alignment is updated periodically to
 164       demonstrate new features in Jalview.</em>
 165   </p>
 166   <p>
 167     <a name="colours"><strong>&quot;Colours&quot;
 168         Preferences tab</strong>
 169   </p>
 170   <p>
 171     <em>Alignment Colour</em> - The default colour scheme for a new
 172     alignment window. If the chosen option is &quot;User Defined&quot;
 173     then the last User Defined Colour loaded or saved via the User
 174     Defined Colours panel will be loaded.
 175   </p>
 176   <p>
 177     <em>Annotation Shading Default</em> - set the default minimum and
 178     maximum colours used when <a
 179       href="../colourSchemes/annotationColouring.html">Colour
 180       by Annotation...</a> is selected from the alignment window's colours
 181     menu.
 182   </p>
 183   <p>
 184     <a name="structure"><strong>&quot;Structure&quot;
 185         Preferences tab</strong></a><em> added in Jalview 2.8.2</em>
 186   </p>
 187   <p>
 188     <em>Process secondary structure from PDB</em> - if selected, then
 189     structure information read from PDB will be processed and annotation
 190     added to associated sequences.
 191   <p>
 192     <em>Use RNAView for secondary structure</em> - if selected, the
 193     pyRNA RNAView service (<a href="https://github.com/fjossinet/PyRNA">https://github.com/fjossinet/PyRNA</a>)
 194     will be called to derive secondary structure information for RNA
 195     chains.
 196   <p>
 197     <em>Add secondary structure annotation to alignment</em> - if
 198     selected, <a href="http://swift.cmbi.ru.nl/gv/dssp/">Jmol's
 199       implementation DSSP</a> will be used to add annotation to polypeptide
 200     chains in the structure.
 201   <p>
 202     <em>Add Temperature Factor annotation to alignment</em> - if
 203     selected, values extracted from the Temperature Factor column for
 204     the backbone atoms in the PDB file will be extracted as annotation
 205     lines shown on the alignment.
 206   <p>
 207     <em>Default structure viewer</em> - choose JMOL or CHIMERA for
 208     viewing 3D structures.
 209   <p>
 210     <em>Path to Chimera program</em> - Optional, as Jalview will search
 211     standard installation paths for Windows, Linux or MacOS. If you have
 212     installed Chimera in a non-standard location, you can specify it
 213     here, by entering the full path to the Chimera executable program.
 214     Double-click this field to open a file chooser dialog.
 215   <p>
 216     <a name="connections"><strong>&quot;Connections&quot;
 217         Preferences tab</strong></a>
 218   </p>
 219   <p>
 220     <em>Default Browser (Unix)</em><br> Its difficult in Java to
 221     detect the default web browser for Unix users. If Jalview can't find
 222     your default web browser, enter the name or full path to your web
 223     browser application.
 224   </p>
 225   <p>
 226     <em>Proxy Server</em><br> If you normally use a proxy server
 227     for using the internet, you must tick the box &quot;Use a Proxy
 228     Server&quot; and enter the address and port details as necessary.
 229     Web Services will not work if you are using a proxy server and do
 230     not enter the settings here.
 231   </p>
 232   <p>
 233     <em>Usage statistics, Questionnaire and Version checks</em><br>
 234     Uncheck these options to prevent Jalview from submitting usage
 235     statistics to google analytics, checking for Jalview questionnaires
 236     or retrieving details of the latest release version (at
 237     www.jalview.org). See the <a href="../privacy.html">user privacy
 238       statement</a> for more information.
 239   </p>
 240   <p>
 241     <a name="links"><strong>The &quot;Links&quot; Preferences
 242         tab</strong></a>
 243   </p>
 244   <p>
 245     This panel shows a table, and two sections - <em>Edit</em> and <em>Filter</em>.
 246     The table shows the available URL link definitions (consisting of a
 247     database, Name, and URL template string), a checkbox <em>In
 248       Menu</em> which indicates if the link is enabled, and <em>Double
 249       Click</em> which marks the link that will be opened if a sequence's ID
 250     is double clicked. The table can be sorted by clicking on the column headers.
 251   </p>
 252   <p><em>Edit Links</em><br /> This section contains three buttons,
 253     <em>New</em>, <em>Edit</em> and <em>Delete</em>, which allow you to
 254     create, modify and remove user-defined URL links from the Sequence
 255     ID's links submenu.
 256   </p>
 257   <p>
 258     <em>Filter</em><br /> The <em>Filter text</em> box allows you to
 259     quickly show rows in the table containing a particular text string.
 260     The <em>Custom only</em> button limits the entries in the table to
 261     just those you have configured yourself <em>via</em> the <em>Edit
 262       Links</em> buttons. Press <em>Show all</em> to clear any filters.
 263   <p>
 264     <a href="../webServices/urllinks.html#urllinks">Read more about configuring
 265       URL links.</a>
 266   </p>
 267   <p>
 268     <a name="output"><strong>Output Preferences tab</strong></a>
 269   </p>
 270   <p>
 271     <em>EPS Rendering Style</em><br> This is a selection box which
 272     allows the user to set a default rendering style for EPS export:
 273   <ul>
 274     <li>&quot;Prompt each time&quot;<br> Choose this to be
 275       asked select between Lineart and Text each time you make an EPS
 276       file.
 277     </li>
 278     <li>&quot;Lineart&quot;<br> EPS files will accurately
 279       reproduce the alignment view in Jalview and all characters will be
 280       converted into line art. Files generated in this way are large and
 281       are not easily editable, but have no font table dependencies.
 282     </li>
 283     <li>&quot;Text&quot;<br> EPS files will be a mixture of
 284       text and lineart. This produces compact files that can be edited
 285       easily in programs like Microsoft Word and Adobe Illustrator, but
 286       can be problematic if the fonts available to Jalview are not
 287       accessible by the program reading the EPS file.
 288   </ul>
 289   <p>
 290     <em>Automatically set ID width</em><br> When enabled, the
 291     column containing sequence and annotation labels at the left hand
 292     side of an exported figure will be made large enough to display each
 293     sequence ID and annotation label in its own line. Enable this if you
 294     have particularly long sequence IDs and need to generate EPS or PNG
 295     figures or web pages.
 296   </p>
 297   <p>
 298     <em>Figure ID column width</em><br> Manually specify the width
 299     of the left hand column where sequence IDs and annotation labels
 300     will be rendered in exported alignment figures. This setting will be
 301     ignored if <em>&quot;Automatically set ID width&quot;</em> is set.
 302   </p>
 303   <p>
 304     <em>Sequence//Start-End Numbering</em><br> The output tab also
 305     has a group of checkboxes for each file format. If these are ticked,
 306     then Jalview will write files with the start and end sequence
 307     positions appended to each sequence id:
 308   <pre>
 309   >ID/1-10
 310   AACDEAAFEA
 311 </pre>
 312   <p>If the boxes are left unchecked for a particular format, the
 313     sequence limits will not be appended to the sequence id.</p>
 314   <p>
 315     <em>Embed BioJSON to HTML export</em>
 316   </p>
 317   <p>
 318     When this option is enabled, Jalview embeds <a
 319       href="bioJsonFormat.html">BioJSON</a> data within HTML files
 320     exported from Jalview at generation time. This enables the exported
 321     HTML files to be extracted and imported back into the Jalview
 322     desktop application at a later time.
 323   <p>
 324     <em>Use Modeller Output</em>
 325   </p>
 326   <p>
 327     This option only applies to PIR format output. Jalview automatically
 328     reads PIR files with sequence descriptions compatible with the
 329     program <a href="http://salilab.org/modeller/">Modeller</a>. If this
 330     option is selected <a href="../io/modellerpir.html">Jalview will
 331       write Modeller style PIR files</a> with correct start/end numbering
 332     and PDB file association (if available). The Jalview id/start-end
 333     option is ignored if Modeller output is selected.
 334   <p>
 335     <a name="editing"><strong>e&quot;Editinge&quot; Preferences tab</strong></a>
 336   </p>
 337   <p>There are currently three options available which can be
 338     selected / deselected.</p>
 339   <p>
 340     <em>AutoCalculate Consensus</em> - For large alignments it can be
 341     useful to deselect &quot;Autocalculate Consensus&quot; when editing.
 342     This prevents lengthy calculations which are performed after each
 343     sequence edit. New alignment windows will have their
 344     &quot;Autocalculate Consensus&quot; option set according to this
 345     setting.
 346   </p>
 347   <p>
 348     <em>Pad Gaps when Editing</em> - New alignment windows will
 349     &quot;Pad Gaps&quot; according to this setting.
 350   </p>
 351   <p>
 352     <em>Sort with New Tree</em> - When selected, any trees calculated or
 353     loaded onto the alignment will automatically sort the alignment.
 354   </p>
 355   <p>&nbsp;</p>
 356   <p>&nbsp;</p>
 357 </body>
 358 </html>