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