3 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
4 * Copyright (C) $$Year-Rel$$ The Jalview Authors
6 * This file is part of Jalview.
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.
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.
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.
23 <title>Preferences</title>
28 <strong>Preferences</strong>
31 The preferences panel is opened from the Jalview Desktop’s <strong><em>Tools</em></strong>
34 <p>There are eight tabs in the Preferences dialog box:
36 <li>The <a href="#visual"><strong>"Visual"</strong>
37 Preferences</a> tab allows you to configure the default display for
38 a new alignment window.
40 <li>The <a href="#colours"><strong>"Colours"</strong>
41 Preferences</a> tab allows you to configure default colourschemes
42 for a new alignment window.
44 <li>The <a href="#overview"><strong>"Overview"</strong>
45 Preferences</a> tab configures defaults for the overview window.
47 <li>The <a href="#structure"><strong>"Structure"</strong>
48 Preferences</a> tab allows you to configure options for obtaining
49 and displaying structure information.
51 <li>The <a href="#connections"><strong>"Connections"</strong>
52 Preferences</a> tab allows you to configure Jalview's internet
53 settings and specify your default web browser.
55 <li>The <a href="#links"><strong>"Links"</strong>
56 Preferences</a> tab shows the currently configured <em>URL
57 Links</em> shown in the <strong>Link</strong> submenu in the Sequence
60 <li>The <a href="#output"><strong>"Output"</strong>
61 Preferences</a> tab contains settings affecting the export of
62 sequence alignments and EPS files.
64 <li>The <a href="#editing"><strong>"Editing"</strong>
65 Preferences</a> tab contains settings affecting behaviour when editing alignments.
67 <li>The <a href="#startup"><strong>"Startup"</strong>
68 Preferences</a> tab allows you to adjust how much memory is
69 allocated to Jalview when it is launched.
71 <li>The <a href="../webServices/webServicesPrefs.html"><strong>"Web
72 Service"</strong> Preferences</a> tab allows you to configure the <a
73 href="http://www.compbio.dundee.ac.uk/jabaws">JABAWS</a>
74 servers that Jalview uses, and change the layout of the
75 alignment's Web Services menu.
80 <strong><a name="visual">Visual</a> Preferences tab</strong>
83 <em>Maximise Window</em> - If this is selected, a new alignment
84 window will stretch to fit the available space.
87 <em>Open Overview Window</em> - When this is selected, the <a
88 href="overview.html">alignment overview</a> panel is opened
89 by default for a new alignment window.
92 <em>Show Annotations</em> - If this is selected the new window will
93 display an annotation panel below the sequences. This annotation
94 panel may have several rows describing the whole alignment. The 4
95 standard annotations <em>Conservation</em>, <em>Quality</em>,
96 <em>Occupancy</em> and <em>Consensus</em> for the alignment may
97 be shown or hidden by default using the checkboxes adjacent and
101 <em>Show group: Conservation and Consensus</em> controls the display
102 of per-group automatic annotation.
105 <em>Consensus: Histogram and Logo</em> checkboxes control the
106 display of the consensus histogram and sequence logo for consensus
110 <em>Full Sequence ID</em> - If selected the ID panel will display
111 the name of a sequence plus the start and end residues in the format
112 name/start-end. If not selected, the displayed ID will be the name
116 <em>Right Align IDs</em> - select to align all sequence IDs to the
117 left-hand edge of the sequence alignment, rather than the left-hand
118 edge of the alignment display window.
121 <em>Font</em> - The default font name, size and style can be set for
122 a new alignment window.
125 <em>Sequence ID Tooltip</em>: Control the display of Database
126 References and Non-positional annotation in the tooltip displayed
127 when the mouse is over a sequence's ID.
130 <em>Show Unconserved</em> - When this is selected, all consensus
131 sequence symbols will be rendered as a '.', highlighting mutations
132 in highly conserved alignments.
135 <em>Sequence Name Italics</em> - select to apply the italicised
136 version of the font to sequence labels.
139 <em>Smooth Font</em> - Toggles anti-aliasing on / off for faster
140 rendering of the alignment.
143 <em>Gap Symbol</em> - The default gap symbol may be set to either
144 "-" or "."
147 <em>Wrap Alignment</em> - Select whether to open new alignment
148 windows in wrapped mode or not.
151 <em>Sort alignment by</em> - When the alignment is loaded in, it can
152 be ordered as read (No sort), or sorted by Id or pairwise identity.
155 <em>Sort annotations by</em> - Annotations can be unsorted, sorted
156 by the order of the related sequences in the alignment, or by label.
157 Autocalculated annotations (e.g. Consensus) can be shown either last
158 (below sequence annotations) or first (above sequence annotations).
159 <em>Since Jalview 2.8.2.</em>
162 <em>Open file</em> - If this is selected then the default alignment
163 file will be opened when Jalview is started. You can change the
164 default file by clicking on file name and either typing in the file
165 path or selecting it from the file chooser window.<br /> <em>Note:
166 The default example alignment is updated periodically to
167 demonstrate new features in Jalview.</em>
170 <a name="colours"><strong>"Colours"
171 Preferences tab</strong>
174 <em>Alignment Colour</em> - The default colour scheme for a new
175 alignment window. If the chosen option is "User Defined"
176 then the last User Defined Colour loaded or saved via the User
177 Defined Colours panel will be loaded.
180 <em>Annotation Shading Default</em> - set the default minimum and
181 maximum colours used when <a
182 href="../colourSchemes/annotationColouring.html">Colour
183 by Annotation...</a> is selected from the alignment window's colours
187 <a name="overview"><strong>"Overview"
188 Preferences tab</strong>
191 <em>Use legacy gap colouring (gaps are white)</em> - when enabled,
192 Jalview's overview shows gaps as white, and sequences with no
193 colourscheme applied as grey.
196 <em>Show Hidden regions when opening overview</em> - default setting
197 for inclusion of hidden regions.
200 <em>Gap Colour</em> - When legacy gap colouring is not enabled, this
201 configures the default colour for gaps in the overview.
204 <em>Hidden Colour</em> - colour used to highlight regions in the
205 overview that are hidden in the alignment.
208 <a name="structure"><strong>"Structure"
209 Preferences tab</strong></a><em> added in Jalview 2.8.2</em>
212 <em>Process secondary structure from PDB</em> - if selected, then
213 structure information read from PDB will be processed and annotation
214 added to associated sequences.
216 <em>Use RNAView for secondary structure</em> - if selected, the
217 pyRNA RNAView service (<a href="https://github.com/fjossinet/PyRNA">https://github.com/fjossinet/PyRNA</a>)
218 will be called to derive secondary structure information for RNA
221 <em>Add secondary structure annotation to alignment</em> - if
222 selected, <a href="http://swift.cmbi.ru.nl/gv/dssp/">Jmol's
223 implementation DSSP</a> will be used to add annotation to polypeptide
224 chains in the structure.
226 <em>Add Temperature Factor annotation to alignment</em> - if
227 selected, values extracted from the Temperature Factor column for
228 the backbone atoms in the PDB file will be extracted as annotation
229 lines shown on the alignment.<br/><em>Since 2.11.2, scores from the Temperature Column for structures imported via the 3D-Beacons network may be shown instead as model quality or reliability scores.</em>
231 <em>Default structure viewer</em> - choose Jmol, CHIMERA, CHIMERAX or PYMOL for
232 viewing 3D structures.
234 <em>Path to Chimera/X/Pymol program</em> - Optional, as Jalview will search
235 standard installation paths for Windows, Linux or MacOS. If Jalview cannot locate the installation for your selected structure viewer, a dialog will be shown. If you have
236 installed the chosen viewer in a non-standard location, you can specify it
237 here, by entering the full path to its executable.<br/>For Chimera, locate the path to the chimera program, similarly for ChimeraX and Pymol. Rather than typing in the path, you can also <em>double-click this field</em> to open a file chooser dialog.</p>
239 <em>PDB Fields shown in Search and Structure Summaries</em> - ticks
240 in this table indicate fields shown by default when browsing results
241 of a free text search via the PDB sequence fetcher, or 3D structures
242 offered by the 3D Structure Chooser.<p>
244 <a name="connections"><strong>"Connections"
245 Preferences tab</strong></a>
248 <em>Default Browser (Unix)</em><br> It's difficult in Java to
249 detect the default web browser for Unix users. If Jalview can't find
250 your default web browser, enter the name or full path to your web
254 <em>Proxy Server</em><br>
255 There are three settings to choose from:<br>
257 <li><em>No proxy servers</em> will configure Jalview to use a
258 direct internet connection.</li>
259 <li><em>System proxy servers</em> will configure Jalview to use
260 the proxy server passed to it by your system at startup.</li>
261 <li><em>Use these proxy servers:</em> allows you to set a custom
264 If you normally use a proxy server for using the internet, you must
265 choose one of <em>System proxy servers</em>, or if these have not been
266 passed correctly you should set your own proxy servers to use by selecting
267 <em>Use these proxy servers</em>.
268 You will then need to enter the host and port details as necessary.
269 Web Services will not work if you are using a proxy server and do
270 not choose the system proxy or enter your own settings here.<br>
271 There are separate host and port settings for HTTP and HTTPS proxies.
272 Often these are the same but you should enter the host and port into both
274 You can also check the <em>Authentication required</em> box if your proxy
275 requires username and password authentication. You can enter both the
276 <em>Username</em> and <em>Password</em> but only the <em>Username</em> will
277 be stored in Jalview's preferences file, the password will only be stored
278 until the end of the current Jalview session.<br>
279 This means that if the proxy settings are still valid, Jalview will ask for
280 the password when it starts the next session.
283 <em>Usage statistics, Questionnaire and Version checks</em><br>
284 Uncheck these options to prevent Jalview from submitting usage
285 statistics to google analytics, checking for Jalview questionnaires
286 or retrieving details of the latest release version (at
287 www.jalview.org). See the <a href="../privacy.html">user privacy
288 statement</a> for more information.
291 <a name="backups"><strong>The "Backups" Preferences Tab</strong></a>
293 <p>Since Jalview 2.11.0, overwriting an existing file when saving
294 or exporting data will by default trigger a backup file to be
295 created. Several options are provided to control how backup files
296 are named, and how many old versions will be kept.</p>
298 <em>Schemes</em> - select from three default schemes <em>Single Backup</em>, <em>Keep All Versions</em>, and <em>Rolled Backup Files</em>, or choose <em>Custom</em> to enable a previously defined custom scheme.
300 <em>Custom</em> - Check this box to adjust the parameters of the currently selected scheme. Once <em>OK</em> is selected these parameters will be saved as the <em>Custom</em> scheme in your user preferences. To revert changes hit <em>Cancel</em>.
302 <p><em>Scheme Examples</em> - shows how backup files will appear according to the currently selected scheme and parameters.
304 <p><em>Deleting Old Backup Files</em> - these settings control how many backups are kept.</p>
305 <p><em>Backup filename strategy</em> - specify the naming convention for numbered backups and how they are ordered.</p>
307 <a name="links"><strong>The "Links" Preferences
311 This panel shows a table, and two sections - <em>Edit</em> and <em>Filter</em>.
312 The table shows the available URL link definitions (consisting of a
313 database, Name, and URL template string), a checkbox <em>In
314 Menu</em> which indicates if the link is enabled, and <em>Double
315 Click</em> which marks the link that will be opened if a sequence's ID
316 is double clicked. The table can be sorted by clicking on the column headers.
318 <p><em>Edit Links</em><br /> This section contains three buttons,
319 <em>New</em>, <em>Edit</em> and <em>Delete</em>, which allow you to
320 create, modify and remove user-defined URL links from the Sequence
324 <em>Filter</em><br /> The <em>Filter text</em> box allows you to
325 quickly show rows in the table containing a particular text string.
326 The <em>Custom only</em> button limits the entries in the table to
327 just those you have configured yourself <em>via</em> the <em>Edit
328 Links</em> buttons. Press <em>Show all</em> to clear any filters.
330 <p>The links table is prepopulated with persistent URLs for many common
331 bioinformatics databases (since 2.10.2). These links are downloaded by Jalview from
332 the <em>identifiers.org</em> website, and the names and URLs are not
334 <a href="../webServices/urllinks.html#urllinks">Read more about configuring
338 <a name="output"><strong>Output Preferences tab</strong></a>
341 <em>EPS Rendering Style</em><br> This is a selection box which
342 allows the user to set a default rendering style for EPS export:
344 <li>"Prompt each time"<br> Choose this to be
345 asked to select between Lineart and Text each time you make an EPS
348 <li>"Lineart"<br> EPS files will accurately
349 reproduce the alignment view in Jalview and all characters will be
350 converted into line art. Files generated in this way are large and
351 are not easily editable, but have no font table dependencies.
353 <li>"Text"<br> EPS files will be a mixture of
354 text and lineart. This produces compact files that can be edited
355 easily in programs like Microsoft Word and Adobe Illustrator, but
356 can be problematic if the fonts available to Jalview are not
357 accessible by the program reading the EPS file.
360 <em>Automatically set ID width</em><br> When enabled, the
361 column containing sequence and annotation labels at the left hand
362 side of an exported figure will be made large enough to display each
363 sequence ID and annotation label in its own line. Enable this if you
364 have particularly long sequence IDs and need to generate EPS or PNG
365 figures or web pages.
368 <em>Figure ID column width</em><br> Manually specify the width
369 of the left hand column where sequence IDs and annotation labels
370 will be rendered in exported alignment figures. This setting will be
371 ignored if <em>"Automatically set ID width"</em> is set.
374 <em>Sequence/Start-End Numbering</em><br> The output tab also
375 has a group of checkboxes for each file format. If these are ticked,
376 then Jalview will write files with the start and end sequence
377 positions appended to each sequence id:
382 <p>If the boxes are left unchecked for a particular format, the
383 sequence limits will not be appended to the sequence id.</p>
385 <em>Embed BioJSON to HTML export</em>
388 When this option is enabled, Jalview embeds <a
389 href="bioJsonFormat.html">BioJSON</a> data within HTML files
390 exported from Jalview at generation time. This enables the exported
391 HTML files to be extracted and imported back into the Jalview
392 desktop application at a later time.
394 <em>Use Modeller Output</em>
397 This option only applies to PIR format output. Jalview automatically
398 reads PIR files with sequence descriptions compatible with the
399 program <a href="http://salilab.org/modeller/">Modeller</a>. If this
400 option is selected <a href="../io/modellerpir.html">Jalview will
401 write Modeller style PIR files</a> with correct start/end numbering
402 and PDB file association (if available). The Jalview id/start-end
403 option is ignored if Modeller output is selected.
405 <a name="editing"><strong>"Editing" Preferences tab</strong></a>
407 <p>There are currently three options available which can be
408 selected / deselected.</p>
410 <em>AutoCalculate Consensus</em> - For large alignments it can be
411 useful to deselect "Autocalculate Consensus" when editing.
412 This prevents lengthy calculations which are performed after each
413 sequence edit. New alignment windows will have their
414 "Autocalculate Consensus" option set according to this
418 <em>Pad Gaps when Editing</em> - New alignment windows will
419 "Pad Gaps" according to this setting.
422 <em>Sort with New Tree</em> - When selected, any trees calculated or
423 loaded onto the alignment will automatically sort the alignment.
427 <a name="startup"><strong>Startup</strong></a>
430 When Jalview is launched it by default examines the available memory
431 and requests up to 90% to be allocated to the application, or 32G,
432 which ever is smaller. The <em>Startup</em> tab allows you to adjust
433 the maximum percentage and hard limits for Jalview memory allocation
434 stored in your .jalview_properties file.
437 <em>Web Services Preferences</em> - documentation for this tab is
439 <a href="../webServices/webServicesPrefs.html">Web Services
440 Preferences section</a>.