JAL-1551 spotlessApply
[jalview.git] / help / help / html / features / preferences.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
4  * Copyright (C) $$Year-Rel$$ 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>
28     <strong>Preferences</strong>
29   </p>
30   <p>
31     The preferences panel is opened from the Jalview Desktop&rsquo;s <strong><em>Tools</em></strong>
32     menu.
33   </p>
34   <p>There are eight tabs in the Preferences dialog box:
35   <ul>
36     <li>The <a href="#visual"><strong>&quot;Visual&quot;</strong>
37         Preferences</a> tab allows you to configure the default display for
38       a new alignment window.
39     </li>
40     <li>The <a href="#colours"><strong>&quot;Colours&quot;</strong>
41         Preferences</a> tab allows you to configure default colourschemes
42       for a new alignment window.
43     </li>
44     <li>The <a href="#overview"><strong>&quot;Overview&quot;</strong>
45         Preferences</a> tab configures defaults for the overview window.
46     </li>
47     <li>The <a href="#structure"><strong>&quot;Structure&quot;</strong>
48         Preferences</a> tab allows you to configure options for obtaining
49       and displaying structure information.
50     </li>
51     <li>The <a href="#connections"><strong>&quot;Connections&quot;</strong>
52         Preferences</a> tab allows you to configure Jalview's internet
53       settings.
54     </li>
55     <li>The <a href="#links"><strong>&quot;Links&quot;</strong>
56         Preferences</a> tab shows the currently configured <em>URL
57         Links</em> shown in the <strong>Link</strong> submenu in the Sequence
58       ID popup menu.
59     </li>
60     <li>The <a href="#output"><strong>&quot;Output&quot;</strong>
61         Preferences</a> tab contains settings affecting the export of
62       sequence alignments and EPS files.
63     </li>
64     <li>The <a href="#editing"><strong>&quot;Editing&quot;</strong>
65         Preferences</a> tab contains settings affecting behaviour when editing alignments.
66     </li>
67     <li>The <a href="#startup"><strong>&quot;Startup&quot;</strong>
68         Preferences</a> tab allows you to adjust how much memory is
69       allocated to Jalview when it is launched.
70     </li>
71     <li>The <a href="../webServices/webServicesPrefs.html"><strong>&quot;Web
72           Service&quot;</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.
76     </li>
77   </ul>
78   </p>
79   <p>
80     <strong><a name="visual">Visual</a> Preferences tab</strong>
81   </p>
82   <p>
83     <em>Maximise Window</em> - If this is selected, a new alignment
84     window will stretch to fit the available space.
85   </p>
86   <p>
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.
90   </p>
91   <p>
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
98     below.
99   </p>
100   <p>
101     <em>Show group: Conservation and Consensus</em> controls the display
102     of per-group automatic annotation.
103   </p>
104   <p>
105     <em>Consensus: Histogram and Logo</em> checkboxes control the
106     display of the consensus histogram and sequence logo for consensus
107     annotation rows.
108   </p>
109   <p>
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
113     of the sequence.
114   </p>
115   <p>
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.
119   </p>
120   <p>
121     <em>Font</em> - The default font name, size and style can be set for
122     a new alignment window.
123   </p>
124   <p>
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.
128   </p>
129   <p>
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.
133   </p>
134   <p>
135     <em>Sequence Name Italics</em> - select to apply the italicised
136     version of the font to sequence labels.
137   </p>
138   <p>
139     <em>Smooth Font</em> - Toggles anti-aliasing on / off for faster
140     rendering of the alignment.
141   </p>
142   <p>
143     <em>Gap Symbol</em> - The default gap symbol may be set to either
144     &quot;-&quot; or &quot;.&quot;
145   </p>
146   <p>
147     <em>Wrap Alignment</em> - Select whether to open new alignment
148     windows in wrapped mode or not.
149   </p>
150   <p>
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.
153   </p>
154   <p>
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>
160   </p>
161   <p>
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>
168   </p>
169   <p>
170     <a name="colours"><strong>&quot;Colours&quot;
171         Preferences tab</strong>
172   </p>
173   <p>
174     <em>Alignment Colour</em> - The default colour scheme for a new
175     alignment window. If the chosen option is &quot;User Defined&quot;
176     then the last User Defined Colour loaded or saved via the User
177     Defined Colours panel will be loaded.
178   </p>
179   <p>
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
184     menu.
185   </p>
186    <p>
187     <a name="overview"><strong>&quot;Overview&quot;
188         Preferences tab</strong>
189   </p>
190   <p>
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.
194   </p>
195   <p>
196     <em>Show Hidden regions when opening overview</em> - default setting
197     for inclusion of hidden regions.
198   </p>
199   <p>
200     <em>Gap Colour</em> - When legacy gap colouring is not enabled, this
201     configures the default colour for gaps in the overview.
202   </p>
203   <p>
204     <em>Hidden Colour</em> - colour used to highlight regions in the
205     overview that are hidden in the alignment.
206   </p>
207   <p>
208     <a name="structure"><strong>&quot;Structure&quot;
209         Preferences tab</strong></a><em> added in Jalview 2.8.2</em>
210   </p>
211   <p>
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.
215   <p>
216     <em>Add secondary structure annotation to alignment</em> - if
217     selected, <a href="http://swift.cmbi.ru.nl/gv/dssp/">Jmol's
218       implementation DSSP</a> will be used to add annotation to polypeptide
219     chains in the structure.
220   <p>
221     <em>Add Temperature Factor annotation to alignment</em> - if
222     selected, values extracted from the Temperature Factor column for
223     the backbone atoms in the PDB file will be extracted as annotation
224     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>
225   <p>
226     <em><strong>Default structure viewer</strong></em> - choose Jmol, CHIMERA, CHIMERAX or PYMOL for
227     viewing 3D structures.
228   <p>
229     <em>Path to Chimera/X/Pymol program</em> - Optional, as Jalview will search
230     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
231     installed the chosen viewer in a non-standard location, you can specify it
232     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>
233   <p>
234     <em>Sequence &lt;-&gt; Structure Mapping Method</em> - This setting controls whether
235     Jalview attempts to retrieve mappings between Uniprot protein
236     sequences and 3D structures in the PDBe with SIFTS, or constructs a
237     mapping by conservative alignment between the sequences and chains
238     in the 3D structure data using the Needleman and Wunsch algorithm.
239     SIFTS is enabled by default. 
240   <p>
241     <em>PDB Fields shown in Search and Structure Summaries</em> - ticks
242     in this table indicate fields shown by default when browsing results
243     of a free text search via the PDB sequence fetcher, or 3D structures
244     offered by the 3D Structure Chooser.<p>
245   <p>
246     <a name="connections"><strong>&quot;Connections&quot;
247         Preferences tab</strong></a>
248   </p>
249   <p>
250     <em>Default Browser (Unix)</em><br> It's difficult in Java to
251     detect the default web browser for Unix users. If Jalview can't find
252     your default web browser, enter the name or full path to your web
253     browser application.
254   </p>
255   <p>
256     <em>Proxy Server</em><br>
257     There are three settings to choose from:<br>
258     <ul>
259             <li><em>No proxy servers</em> will configure Jalview to use a
260                     direct internet connection.</li>
261             <li><em>System proxy servers</em> will configure Jalview to use
262                     the proxy server passed to it by your system at startup.</li>
263             <li><em>Use these proxy servers:</em> allows you to set a custom
264                     proxy server.</li>
265     </ul>
266     If you normally use a proxy server for using the internet, you must
267     choose one of <em>System proxy servers</em>, or if these have not been
268     passed correctly you should set your own proxy servers to use by selecting
269     <em>Use these proxy servers</em>.
270     You will then need to enter the host and port details as necessary.
271     Web Services will not work if you are using a proxy server and do
272     not choose the system proxy or enter your own settings here.<br>
273     There are separate host and port settings for HTTP and HTTPS proxies.
274     Often these are the same but you should enter the host and port into both
275     rows.<br>
276     You can also check the <em>Authentication required</em> box if your proxy
277     requires username and password authentication.  You can enter both the
278     <em>Username</em> and <em>Password</em> but only the <em>Username</em> will
279     be stored in Jalview's preferences file, the password will only be stored
280     until the end of the current Jalview session.<br>
281     This means that if the proxy settings are still valid, Jalview will ask for
282     the password when it starts the next session.
283   </p>
284   <p>
285     <em>Usage statistics, Questionnaire and Version checks</em><br>
286     Uncheck these options to prevent Jalview from submitting usage
287     statistics to google analytics, checking for Jalview questionnaires
288     or retrieving details of the latest release version (at
289     www.jalview.org). See the <a href="../privacy.html">user privacy
290       statement</a> for more information.
291   </p>
292   <p>
293   <a name="backups"><strong>The &quot;Backups&quot; Preferences Tab</strong></a>
294   </p>
295   <p>Since Jalview 2.11.0, overwriting an existing file when saving
296     or exporting data will by default trigger a backup file to be
297     created. Several options are provided to control how backup files
298     are named, and how many old versions will be kept.</p>
299     <p>
300     <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.
301     </p><p>
302     <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>. 
303     </p>
304     <p><em>Scheme Examples</em> - shows how backup files will appear according to the currently selected scheme and parameters. 
305     </p>
306     <p><em>Deleting Old Backup Files</em> - these settings control how many backups are kept.</p>
307     <p><em>Backup filename strategy</em> - specify the naming convention for numbered backups and how they are ordered.</p> 
308   <p>
309     <a name="links"><strong>The &quot;Links&quot; Preferences
310         tab</strong></a>
311   </p>
312   <p>
313     This panel shows a table, and two sections - <em>Edit</em> and <em>Filter</em>.
314     The table shows the available URL link definitions (consisting of a
315     database, Name, and URL template string), a checkbox <em>In
316       Menu</em> which indicates if the link is enabled, and <em>Double
317       Click</em> which marks the link that will be opened if a sequence's ID
318     is double clicked. The table can be sorted by clicking on the column headers.
319   </p>
320   <p><em>Edit Links</em><br /> This section contains three buttons,
321     <em>New</em>, <em>Edit</em> and <em>Delete</em>, which allow you to
322     create, modify and remove user-defined URL links from the Sequence
323     ID's links submenu.
324   </p>
325   <p>
326     <em>Filter</em><br /> The <em>Filter text</em> box allows you to
327     quickly show rows in the table containing a particular text string.
328     The <em>Custom only</em> button limits the entries in the table to
329     just those you have configured yourself <em>via</em> the <em>Edit
330       Links</em> buttons. Press <em>Show all</em> to clear any filters.
331   </p>
332   <p>The links table is prepopulated with persistent URLs for many common
333     bioinformatics databases (since 2.10.2). These links are downloaded by Jalview from
334     the <em>identifiers.org</em> website, and the names and URLs are not
335     user editable.
336     <a href="../webServices/urllinks.html#urllinks">Read more about configuring
337       URL links.</a>
338   </p>
339   <p>
340     <a name="output"><strong>Output Preferences tab</strong></a>
341   </p>
342   <p>
343     <em>EPS Rendering Style</em><br> This is a selection box which
344     allows the user to set a default rendering style for EPS export:
345   <ul>
346     <li>&quot;Prompt each time&quot;<br> Choose this to be
347       asked to select between Lineart and Text each time you make an EPS
348       file.
349     </li>
350     <li>&quot;Lineart&quot;<br> EPS files will accurately
351       reproduce the alignment view in Jalview and all characters will be
352       converted into line art. Files generated in this way are large and
353       are not easily editable, but have no font table dependencies.
354     </li>
355     <li>&quot;Text&quot;<br> EPS files will be a mixture of
356       text and lineart. This produces compact files that can be edited
357       easily in programs like Microsoft Word and Adobe Illustrator, but
358       can be problematic if the fonts available to Jalview are not
359       accessible by the program reading the EPS file.
360   </ul>
361   <p>
362     <em>Automatically set ID width</em><br> When enabled, the
363     column containing sequence and annotation labels at the left hand
364     side of an exported figure will be made large enough to display each
365     sequence ID and annotation label in its own line. Enable this if you
366     have particularly long sequence IDs and need to generate EPS or PNG
367     figures or web pages.
368   </p>
369   <p>
370     <em>Figure ID column width</em><br> Manually specify the width
371     of the left hand column where sequence IDs and annotation labels
372     will be rendered in exported alignment figures. This setting will be
373     ignored if <em>&quot;Automatically set ID width&quot;</em> is set.
374   </p>
375   <p>
376     <em>Sequence/Start-End Numbering</em><br> The output tab also
377     has a group of checkboxes for each file format. If these are ticked,
378     then Jalview will write files with the start and end sequence
379     positions appended to each sequence id:
380   <pre>
381   >ID/1-10
382   AACDEAAFEA
383 </pre>
384   <p>If the boxes are left unchecked for a particular format, the
385     sequence limits will not be appended to the sequence id.</p>
386   <p>
387     <em>Embed BioJSON to HTML export</em>
388   </p>
389   <p>
390     When this option is enabled, Jalview embeds <a
391       href="bioJsonFormat.html">BioJSON</a> data within HTML files
392     exported from Jalview at generation time. This enables the exported
393     HTML files to be extracted and imported back into the Jalview
394     desktop application at a later time.
395   <p>
396     <em>Use Modeller Output</em>
397   </p>
398   <p>
399     This option only applies to PIR format output. Jalview automatically
400     reads PIR files with sequence descriptions compatible with the
401     program <a href="http://salilab.org/modeller/">Modeller</a>. If this
402     option is selected <a href="../io/modellerpir.html">Jalview will
403       write Modeller style PIR files</a> with correct start/end numbering
404     and PDB file association (if available). The Jalview id/start-end
405     option is ignored if Modeller output is selected.
406   <p>
407     <a name="editing"><strong>&quot;Editing&quot; Preferences tab</strong></a>
408   </p>
409   <p>There are currently three options available which can be
410     selected / deselected.</p>
411   <p>
412     <em>AutoCalculate Consensus</em> - For large alignments it can be
413     useful to deselect &quot;Autocalculate Consensus&quot; when editing.
414     This prevents lengthy calculations which are performed after each
415     sequence edit. New alignment windows will have their
416     &quot;Autocalculate Consensus&quot; option set according to this
417     setting.
418   </p>
419   <p>
420     <em>Pad Gaps when Editing</em> - New alignment windows will
421     &quot;Pad Gaps&quot; according to this setting.
422   </p>
423   <p>
424     <em>Sort with New Tree</em> - When selected, any trees calculated or
425     loaded onto the alignment will automatically sort the alignment.
426   </p>
427   <p>&nbsp;</p>
428   <p>
429     <a name="startup"><strong>Startup</strong></a>
430   </p>
431   <p>
432     When Jalview is launched it by default examines the available memory
433     and requests up to 90% to be allocated to the application, or 32G,
434     which ever is smaller. The <em>Startup</em> tab allows you to adjust
435     the maximum percentage and hard limits for Jalview memory allocation
436     stored in your .jalview_properties file.
437   </p>
438   <p>&nbsp;</p>
439   <em>Web Services Preferences</em> - documentation for this tab is
440   given in the
441   <a href="../webServices/webServicesPrefs.html">Web Services
442     Preferences section</a>.
443   <p>&nbsp;</p>
444 </body>
445 </html>