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