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