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