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