Jalview 2.6 source licence
[jalview.git] / help / html / features / preferences.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
4  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
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 of the License, or (at your option) any later version.
11  * 
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
18 -->
19 <head>
20 <title>Preferences</title>
21 </head>
22
23 <body>
24 <p><strong>Preferences</strong></p>
25 <p>There are four tabs in the Preferences dialog box:
26 <ul>
27         <li>The <a href="#visual"><strong>&quot;Visual&quot;</strong>
28         Preferences</a> tab allows you to configure the default display for a new
29         alignment window.</li>
30         <li>The <a href="#connections"><strong>&quot;Connections&quot;</strong>
31         Preferences</a> tab allows you to change the links made from Jalview to
32         your default web browser.</li>
33         <li>The <a href="#output"><strong>&quot;Output&quot;</strong>
34         Preferences</a> tab contains settings affecting the export of sequence
35         alignments and EPS files.</li>
36         <li>The <a href="#editing"><strong>&quot;Editing&quot;</strong>
37         Preferences</a> tab contains settings affecting the export of sequence
38         alignments and EPS files.</li>
39         <li>The <a href="dassettings.html"><strong>&quot;DAS
40         Settings&quot;</strong> Preferences</a> tab allows you to select which DAS sources
41         to use when fetching DAS Features.</li>
42 </ul>
43 </p>
44 <p><strong><a name="visual">Visual</a> Preferences tab</strong></p>
45 <p><em>Maximise Window</em> - If this is selected, a new alignment
46 window will stretch to fit the available space.</p>
47 <p><em>Open Overview Window</em> - When this is selected, the <a
48         href="overview.html">alignment overview</a> panel is opened by default
49 for a new alignment window.</p>
50 <p><em>Show Annotations</em> - If this is selected the new window
51 will display an annotation panel below the sequences. This annotation
52 panel may have several rows describing the whole alignment. The 3
53 standard annotations <em>Conservation</em>, <em>Quality</em> and <em>Consensus</em>
54 for the alignment may be shown or hidden by default using the checkboxes
55 below.</p>
56 <p><em>Show group: Conservation and Consensus</em> controls the
57 display of per-group automatic annotation.</p>
58 <p><em>Consensus: Histogram and Logo</em> checkboxes control the
59 display of the consensus histogram and sequence logo for consensus
60 annotation rows.</p>
61 <p><em>Full Sequence ID</em> - If selected the ID panel will display
62 the name of a sequence plus the start and end residues in the format
63 name/start-end. If not selected, the displayed ID will be the name of
64 the sequence.</p>
65 <p><em>Right Align IDs</em> - select to align all sequence IDs to
66 the left-hand edge of the sequence alignment, rather than the left-hand
67 edge of the alignment display window.</p>
68 <p><em>Font</em> - The default font name, size and style can be set
69 for a new alignment window.</p>
70 <p><em>Sequence ID Tooltip</em>: Control the display of Database
71 References and Non-positional annotation in the tooltip displayed when
72 the mouse is over a sequence's ID.</p>
73 <p><em>Sequence Name Italics</em> - select to apply the italicised
74 vbersion of the font to sequence labels.</p>
75 <p><em>Smooth Font</em> - Toggles anti-aliasing on / off for faster
76 rendering of the alignment.</p>
77 <p><em>Wrap Alignment</em> - Select whether to open new alignment
78 windows in wrapped mode or not.</p>
79 <p><em>Gap Symbol</em> - The default gap symbol may be set to either
80 &quot;-&quot; or &quot;.&quot;</p>
81 <p><em>Colour</em> - The default colour scheme for a new alignment
82 window. If the chosen option is &quot;User Defined&quot; then the last
83 User Defined Colour loaded or saved via the User Defined Colours panel
84 will be loaded.</p>
85 <p><em>Sort by</em> - When the alignment is loaded in, it will can
86 be sorted by Id or pairwise identity.</p>
87 <p><em>Open file</em> - If this is selected then the default
88 alignment file will be opened when Jalview is started. You can change
89 the default file by clicking on file name and either typing in the file
90 path or selecting it from the file chooser window.</p>
91 <p><a name="connections"><strong>&quot;Connections&quot;
92 Preferences tab</strong></a></p>
93 <p><em>URL Link From Sequence ID</em><br>
94 These definitions are used to generate URLs from a sequence's ID or
95 database cross references. Read more about <a
96         href="../webServices/urllinks.html#urllinks">configuring URL links
97 here</a>.</p>
98 <p><em>Default Browser (Unix)</em><br>
99 Its difficult in Java to detect the default web browser for Unix users.
100 If Jalview can't find your default web browser, enter the name or full
101 path to your web browser application.</p>
102 <p><em>Proxy Server</em><br>
103 If you normally use a proxy server for using the internet, you must tick
104 the box &quot;Use a Proxy Server&quot; and enter the address and port
105 details as necessary. Web Services will not work if you are using a
106 proxy server and do not enter the settings here.</p>
107 <p><em>Usage statistics, Questionnaire and Version checks</em><br>
108 Uncheck these options to prevent Jalview from submitting usage
109 statistics to google analytics, checking for jalview questionnaires or
110 retrieving details of the latest release version (at www.jalview.org).
111 See the <a href="../privacy.html">user privacy statement</a> for more
112 information.</p>
113 <p><a name="output"><strong>Output Preferences tab</strong></a></p>
114 <p><em>EPS Rendering Style</em><br>
115 This is a selection box which allows the user to set a default rendering
116 style for EPS export:
117 <ul>
118         <li>&quot;Lineart&quot;<br>
119         EPS files will accurately reproduce the alignment view in Jalview and
120         all characters will be converted into line art. Files generated in this
121         way are large and are not easily editable, but have no font table
122         dependencies.</li>
123         <li>&quot;Text&quot;<br>
124         EPS files will be a mixture of text and lineart. This produces compact
125         files that can be edited easily in programs like Microsoft Word and
126         Adobe Illustrator, but can be problematic if the fonts available to
127         jalview are not accessible by the program reading the EPS file.
128         <li>&quot;Prompt each time&quot;<br>
129         Choose this to be asked select between Lineart and Text each time you
130         make an EPS file.</li>
131 </ul>
132 </p>
133 <p><em>Sequence//Start-End Numbering</em><br>
134 The output tab also has a group of checkboxes for each file format. If
135 these are ticked, then Jalview will write files with the start and end
136 sequence positions appended to each sequence id: <pre>
137   >ID/1-10
138   AACDEAAFEA
139 </pre>
140 <p>If the boxes are left unchecked for a particular format, the
141 sequence limits will not be appended to the sequence id.</p>
142 </p>
143 <p><em>Use Modeller Output</em></p>
144 <p>This option only applies to PIR format output. Jalview
145 automatically reads PIR files with sequence descriptions compatible with
146 the program <a href="http://salilab.org/modeller/">Modeller</a>. If this
147 option is selected <a href="../io/modellerpir.html">Jalview will
148 write Modeller style PIR files</a> with correct start/end numbering and PDB
149 file association (if available). The Jalview id/start-end option is
150 ignored if Modeller output is selected.
151 <p><a name="editing"><strong>Editing Preferences tab</strong></a></p>
152 <p>There are currently 2 options available which can be selected /
153 deselected.</p>
154 <p><em>AutoCalculate Consensus</em> - For large alignments it can be
155 useful to deselect &quot;Autocalculate Consensus&quot; when editing.
156 This prevents lengthy calculations which are performed after each
157 sequence edit. New alignment windows will have their &quot;Autocalculate
158 Consensus&quot; option set according to this setting.</p>
159 <p><em>Pad gaps when editing</em> - New alignment windows will
160 &quot;Pad Gaps&quot; according to this setting.</p>
161 <p>&nbsp;</p>
162 <p>&nbsp;</p>
163 </body>
164 </html>