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 the export of
  66       sequence alignments and EPS files.
  67     </li>
  68     <li>The <a href="../webServices/webServicesPrefs.html"><strong>&quot;Web
  69           Service&quot;</strong> Preferences</a> tab allows you to configure the <a
  70       href="http://www.compbio.dundee.ac.uk/jabaws">JABAWS</a>
  71       servers that Jalview uses, and change the layout of the
  72       alignment's Web Services menu.
  73     </li>
  74   </ul>
  75   </p>
  76   <p>
  77     <strong><a name="visual">Visual</a> Preferences tab</strong>
  78   </p>
  79   <p>
  80     <em>Maximise Window</em> - If this is selected, a new alignment
  81     window will stretch to fit the available space.
  82   </p>
  83   <p>
  84     <em>Open Overview Window</em> - When this is selected, the <a
  85       href="overview.html">alignment overview</a> panel is opened
  86     by default for a new alignment window.
  87   </p>
  88   <p>
  89     <em>Show Annotations</em> - If this is selected the new window will
  90     display an annotation panel below the sequences. This annotation
  91     panel may have several rows describing the whole alignment. The 4
  92     standard annotations <em>Conservation</em>, <em>Quality</em>,
  93     <em>Occupancy</em> and <em>Consensus</em> for the alignment may
  94     be shown or hidden by default using the checkboxes adjacent and
  95     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="overview"><strong>&quot;Overview&quot;
 185         Preferences tab</strong>
 186   </p>
 187   <p>
 188     <em>Use legacy gap colouring (gaps are white)</em> - when enabled,
 189     Jalview's overview shows gaps as white, and sequences with no
 190     colourscheme applied as grey.
 191   </p>
 192   <p>
 193     <em>Show Hidden regions when opening overview</em> - default setting
 194     for inclusion of hidden regions.
 195   </p>
 196   <p>
 197     <em>Gap Colour</em> - When legacy gap colouring is not enabled, this
 198     configures the default colour for gaps in the overview.
 199   </p>
 200   <p>
 201     <em>Hidden Colour</em> - colour used to highlight regions in the
 202     overview that are hidden in the alignment.
 203   </p>
 204   <p>
 205     <em>Gap Colour</em> - The default colour scheme for a new alignment
 206     window. If the chosen option is &quot;User Defined&quot; then the
 207     last User Defined Colour loaded or saved via the User Defined
 208     Colours panel will be loaded.
 209   </p>
 210   <p>
 211     <a name="structure"><strong>&quot;Structure&quot;
 212         Preferences tab</strong></a><em> added in Jalview 2.8.2</em>
 213   </p>
 214   <p>
 215     <em>Process secondary structure from PDB</em> - if selected, then
 216     structure information read from PDB will be processed and annotation
 217     added to associated sequences.
 218   <p>
 219     <em>Use RNAView for secondary structure</em> - if selected, the
 220     pyRNA RNAView service (<a href="https://github.com/fjossinet/PyRNA">https://github.com/fjossinet/PyRNA</a>)
 221     will be called to derive secondary structure information for RNA
 222     chains.
 223   <p>
 224     <em>Add secondary structure annotation to alignment</em> - if
 225     selected, <a href="http://swift.cmbi.ru.nl/gv/dssp/">Jmol's
 226       implementation DSSP</a> will be used to add annotation to polypeptide
 227     chains in the structure.
 228   <p>
 229     <em>Add Temperature Factor annotation to alignment</em> - if
 230     selected, values extracted from the Temperature Factor column for
 231     the backbone atoms in the PDB file will be extracted as annotation
 232     lines shown on the alignment.
 233   <p>
 234     <em>Default structure viewer</em> - choose JMOL or CHIMERA for
 235     viewing 3D structures.
 236   <p>
 237     <em>Path to Chimera program</em> - Optional, as Jalview will search
 238     standard installation paths for Windows, Linux or MacOS. If you have
 239     installed Chimera in a non-standard location, you can specify it
 240     here, by entering the full path to the Chimera executable program.
 241     Double-click this field to open a file chooser dialog.
 242   <p>
 243     <a name="connections"><strong>&quot;Connections&quot;
 244         Preferences tab</strong></a>
 245   </p>
 246   <p>
 247     <em>Default Browser (Unix)</em><br> Its difficult in Java to
 248     detect the default web browser for Unix users. If Jalview can't find
 249     your default web browser, enter the name or full path to your web
 250     browser application.
 251   </p>
 252   <p>
 253     <em>Proxy Server</em><br> If you normally use a proxy server
 254     for using the internet, you must tick the box &quot;Use a Proxy
 255     Server&quot; and enter the address and port details as necessary.
 256     Web Services will not work if you are using a proxy server and do
 257     not enter the settings here.
 258   </p>
 259   <p>
 260     <em>Usage statistics, Questionnaire and Version checks</em><br>
 261     Uncheck these options to prevent Jalview from submitting usage
 262     statistics to google analytics, checking for Jalview questionnaires
 263     or retrieving details of the latest release version (at
 264     www.jalview.org). See the <a href="../privacy.html">user privacy
 265       statement</a> for more information.
 266   </p>
 267   <p>
 268     <a name="links"><strong>The &quot;Links&quot; Preferences
 269         tab</strong></a>
 270   </p>
 271   <p>
 272     This panel shows a table, and two sections - <em>Edit</em> and <em>Filter</em>.
 273     The table shows the available URL link definitions (consisting of a
 274     database, Name, and URL template string), a checkbox <em>In
 275       Menu</em> which indicates if the link is enabled, and <em>Double
 276       Click</em> which marks the link that will be opened if a sequence's ID
 277     is double clicked. The table can be sorted by clicking on the column headers.
 278   </p>
 279   <p><em>Edit Links</em><br /> This section contains three buttons,
 280     <em>New</em>, <em>Edit</em> and <em>Delete</em>, which allow you to
 281     create, modify and remove user-defined URL links from the Sequence
 282     ID's links submenu.
 283   </p>
 284   <p>
 285     <em>Filter</em><br /> The <em>Filter text</em> box allows you to
 286     quickly show rows in the table containing a particular text string.
 287     The <em>Custom only</em> button limits the entries in the table to
 288     just those you have configured yourself <em>via</em> the <em>Edit
 289       Links</em> buttons. Press <em>Show all</em> to clear any filters.
 290   </p>
 291   <p>The links table is prepoulated with persistent URLs for many common
 292     bioinformatics databases (since 2.10.2). These links are downloaded by Jalview from
 293     the <em>identifiers.org</em> website, and the names and URLs are not
 294     user editable.
 295     <a href="../webServices/urllinks.html#urllinks">Read more about configuring
 296       URL links.</a>
 297   </p>
 298   <p>
 299     <a name="output"><strong>Output Preferences tab</strong></a>
 300   </p>
 301   <p>
 302     <em>EPS Rendering Style</em><br> This is a selection box which
 303     allows the user to set a default rendering style for EPS export:
 304   <ul>
 305     <li>&quot;Prompt each time&quot;<br> Choose this to be
 306       asked select between Lineart and Text each time you make an EPS
 307       file.
 308     </li>
 309     <li>&quot;Lineart&quot;<br> EPS files will accurately
 310       reproduce the alignment view in Jalview and all characters will be
 311       converted into line art. Files generated in this way are large and
 312       are not easily editable, but have no font table dependencies.
 313     </li>
 314     <li>&quot;Text&quot;<br> EPS files will be a mixture of
 315       text and lineart. This produces compact files that can be edited
 316       easily in programs like Microsoft Word and Adobe Illustrator, but
 317       can be problematic if the fonts available to Jalview are not
 318       accessible by the program reading the EPS file.
 319   </ul>
 320   <p>
 321     <em>Automatically set ID width</em><br> When enabled, the
 322     column containing sequence and annotation labels at the left hand
 323     side of an exported figure will be made large enough to display each
 324     sequence ID and annotation label in its own line. Enable this if you
 325     have particularly long sequence IDs and need to generate EPS or PNG
 326     figures or web pages.
 327   </p>
 328   <p>
 329     <em>Figure ID column width</em><br> Manually specify the width
 330     of the left hand column where sequence IDs and annotation labels
 331     will be rendered in exported alignment figures. This setting will be
 332     ignored if <em>&quot;Automatically set ID width&quot;</em> is set.
 333   </p>
 334   <p>
 335     <em>Sequence//Start-End Numbering</em><br> The output tab also
 336     has a group of checkboxes for each file format. If these are ticked,
 337     then Jalview will write files with the start and end sequence
 338     positions appended to each sequence id:
 339   <pre>
 340   >ID/1-10
 341   AACDEAAFEA
 342 </pre>
 343   <p>If the boxes are left unchecked for a particular format, the
 344     sequence limits will not be appended to the sequence id.</p>
 345   <p>
 346     <em>Embed BioJSON to HTML export</em>
 347   </p>
 348   <p>
 349     When this option is enabled, Jalview embeds <a
 350       href="bioJsonFormat.html">BioJSON</a> data within HTML files
 351     exported from Jalview at generation time. This enables the exported
 352     HTML files to be extracted and imported back into the Jalview
 353     desktop application at a later time.
 354   <p>
 355     <em>Use Modeller Output</em>
 356   </p>
 357   <p>
 358     This option only applies to PIR format output. Jalview automatically
 359     reads PIR files with sequence descriptions compatible with the
 360     program <a href="http://salilab.org/modeller/">Modeller</a>. If this
 361     option is selected <a href="../io/modellerpir.html">Jalview will
 362       write Modeller style PIR files</a> with correct start/end numbering
 363     and PDB file association (if available). The Jalview id/start-end
 364     option is ignored if Modeller output is selected.
 365   <p>
 366     <a name="editing"><strong>&quot;Editing&quot; Preferences tab</strong></a>
 367   </p>
 368   <p>There are currently three options available which can be
 369     selected / deselected.</p>
 370   <p>
 371     <em>AutoCalculate Consensus</em> - For large alignments it can be
 372     useful to deselect &quot;Autocalculate Consensus&quot; when editing.
 373     This prevents lengthy calculations which are performed after each
 374     sequence edit. New alignment windows will have their
 375     &quot;Autocalculate Consensus&quot; option set according to this
 376     setting.
 377   </p>
 378   <p>
 379     <em>Pad Gaps when Editing</em> - New alignment windows will
 380     &quot;Pad Gaps&quot; according to this setting.
 381   </p>
 382   <p>
 383     <em>Sort with New Tree</em> - When selected, any trees calculated or
 384     loaded onto the alignment will automatically sort the alignment.
 385   </p>
 386   <p>&nbsp;</p>
 387   <p>&nbsp;</p>
 388 </body>
 389 </html>