update author list in license for (JAL-826)
[jalview.git] / help / html / features / preferences.html
index 802c22a..a5af113 100755 (executable)
-<html>\r
-\r
-<head><title>Preferences</title></head>\r
-\r
-<body>\r
-<p><strong>Preferences</strong></p>\r
-<p> The <strong>&quot;Visual&quot; </strong>tab on the preferences window allows \r
-  you to configure the default display for a new alignment window. </p>\r
-<p><em>Maximise Window</em> - If this is selected, a new alignment window will stretch \r
-  to fit the available space.</p>\r
-<p><em>Show Annotations</em> - If this is selected the new window will display an annotation \r
-  panel below the sequences. This annotation panel may have several rows describing \r
-  the whole alignment. The 3 standard annotations <em>Conservation</em>, <em>Quality</em> and <em>Consensus</em> \r
-  may be shown or hidden by default.</p>\r
-<p><em>Full Sequence ID</em> - If selected the ID panel will display the name of a sequence \r
-  plus the start and end residues in the format name/start-end. If not selected, \r
-  the displayed ID will be the name of the sequence.</p>\r
-<p><em>Font</em> - The default font name, size and style can be set for a new alignment \r
-  window. </p>\r
-<p><em>Gap Symbol</em> - The default gap symbol may be set to either &quot;-&quot; or &quot;.&quot;</p>\r
-<p><em>Colour</em> - The default colour scheme for a new alignment window. If \r
-  the chosen option is &quot;User Defined&quot; then the last User Defined Colour \r
-  loaded or saved via the User Defined Colours panel will be loaded. </p>\r
-<p><em>Sort by</em> - When the alignment is loaded in, it will can be sorted by \r
-  Id or pairwise identity.</p>\r
-<p><em>Open file</em> - If this is selected then the default alignment file will \r
-  be opened when Jalview is started. You can change the default file by clicking \r
-  on file name and either typing in the file path or selecting it from the file \r
-  chooser window. </p>\r
-<p>The <strong>&quot;Connections&quot;</strong> tab allows you to change the links \r
-  made from Jalview to your default web browser.</p>\r
-<p><em>URL Link From Sequence ID</em><br>\r
-  Right click a sequence id to see a popup menu with &quot;Link&quot; as one of \r
-  the items. By default the item &quot;SRS&quot; is added to this link menu. This \r
-  link will show a web page in your default browser with the selected sequence \r
-  id as part of the URL.<br>\r
-  Jalview allows you to add your own custom links to other web pages. Click new \r
-  to add a new link. You can name the link, this will be displayed on a new menu \r
-  item under the &quot;Link&quot; menu when you right click on a sequence id. \r
-  <br>\r
-  You must enter $SEQUENCE_ID$ within your URL. This will be replaced by the chosen \r
-  sequence id when you click on it. </p>\r
-<p><em>Default Browser (Unix)</em><br>\r
-  Its difficult in Java to detect the default web browser for Unix users. If Jalview \r
-  can't find your default web browser, enter the name or full path to your web \r
-  browser application. </p>\r
-<p><em>Proxy Server</em><br>\r
-  If you normally use a proxy server for using the internet, you must tick the \r
-  box &quot;Use a Proxy Server&quot; and enter the address and port details as \r
-  necessary. Web Services will not work if you are using a proxy server and do \r
-  not enter the settings here.</p>\r
-<p>The &quot;<strong>Output</strong>&quot; tab has a selection box allowing the \r
-  user to set a default rendering style for EPS export. &quot;Lineart&quot; will \r
-  produce an accurate representation of the visible alignment in Jalview, all \r
-  the characters will be graphics objects. &quot;Text&quot; will produce a much \r
-  smaller file and will rely on the software you use to view the EPS file, such \r
-  as Adobe Illustrator, having the same font as the file was created with. You \r
-  will only be able to edit text in an EPS file if you select the &quot;Text&quot; \r
-  option.<br>\r
-  Choose &quot;Prompt each time&quot; to select between Lineart and Text each \r
-  time you make an EPS file.</p>\r
-<p>The output tab also has a group of checkboxes for each file format. If these \r
-  are ticked, then Jalview will write files with the start and end sequence positions \r
-  appended to each sequence id. If the boxes are left unchecked for a paritcular \r
-  format, the sequence limits will not be appended to the sequence id. </p>\r
-<p>&nbsp;</p>\r
-<p>&nbsp;</p>\r
-</body>\r
-</html>\r
+<html>
+<!--
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+ * 
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+-->
+<head>
+<title>Preferences</title>
+</head>
+
+<body>
+<p><strong>Preferences</strong></p>
+<p>There are six tabs in the Preferences dialog box:
+<ul>
+       <li>The <a href="#visual"><strong>&quot;Visual&quot;</strong>
+       Preferences</a> tab allows you to configure the default display for a new
+       alignment window.</li>
+       <li>The <a href="#colours"><strong>&quot;Colours&quot;</strong>
+       Preferences</a> tab allows you to configure default colourschemes for a new
+       alignment window.</li>
+       <li>The <a href="#connections"><strong>&quot;Connections&quot;</strong>
+       Preferences</a> tab allows you to change the links made from Jalview to
+       your default web browser.</li>
+       <li>The <a href="#output"><strong>&quot;Output&quot;</strong>
+       Preferences</a> tab contains settings affecting the export of sequence
+       alignments and EPS files.</li>
+       <li>The <a href="#editing"><strong>&quot;Editing&quot;</strong>
+       Preferences</a> tab contains settings affecting the export of sequence
+       alignments and EPS files.</li>
+       <li>The <a href="dassettings.html"><strong>&quot;DAS
+       Settings&quot;</strong> Preferences</a> tab allows you to select which DAS sources
+       to use when fetching DAS Features.</li>
+       <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>
+</ul>
+</p>
+<p><strong><a name="visual">Visual</a> Preferences tab</strong></p>
+<p><em>Maximise Window</em> - If this is selected, a new alignment
+window will stretch to fit the available space.</p>
+<p><em>Open Overview Window</em> - When this is selected, the <a
+       href="overview.html">alignment overview</a> panel is opened by default
+for a new alignment window.</p>
+<p><em>Show Annotations</em> - If this is selected the new window
+will display an annotation panel below the sequences. This annotation
+panel may have several rows describing the whole alignment. The 3
+standard annotations <em>Conservation</em>, <em>Quality</em> and <em>Consensus</em>
+for the alignment may be shown or hidden by default using the checkboxes
+below.</p>
+<p><em>Show group: Conservation and Consensus</em> controls the
+display of per-group automatic annotation.</p>
+<p><em>Consensus: Histogram and Logo</em> checkboxes control the
+display of the consensus histogram and sequence logo for consensus
+annotation rows.</p>
+<p><em>Full Sequence ID</em> - If selected the ID panel will display
+the name of a sequence plus the start and end residues in the format
+name/start-end. If not selected, the displayed ID will be the name of
+the sequence.</p>
+<p><em>Right Align IDs</em> - select to align all sequence IDs to
+the left-hand edge of the sequence alignment, rather than the left-hand
+edge of the alignment display window.</p>
+<p><em>Font</em> - The default font name, size and style can be set
+for a new alignment window.</p>
+<p><em>Sequence ID Tooltip</em>: Control the display of Database
+References and Non-positional annotation in the tooltip displayed when
+the mouse is over a sequence's ID.</p>
+<p><em>Sequence Name Italics</em> - select to apply the italicised
+vbersion of the font to sequence labels.</p>
+<p><em>Smooth Font</em> - Toggles anti-aliasing on / off for faster
+rendering of the alignment.</p>
+<p><em>Wrap Alignment</em> - Select whether to open new alignment
+windows in wrapped mode or not.</p>
+<p><em>Gap Symbol</em> - The default gap symbol may be set to either
+&quot;-&quot; or &quot;.&quot;</p>
+<p><em>Sort by</em> - When the alignment is loaded in, it will can
+be sorted by Id or pairwise identity.</p>
+<p><em>Open file</em> - If this is selected then the default
+alignment file will be opened when Jalview is started. You can change
+the default file by clicking on file name and either typing in the file
+path or selecting it from the file chooser window.</p>
+<p><a name="colours"><strong>&quot;Colours&quot; Preferences tab</strong></p>
+<p><em>Alignment Colour</em> - The default colour scheme for a new alignment
+window. If the chosen option is &quot;User Defined&quot; then the last
+User Defined Colour loaded or saved via the User Defined Colours panel
+will be loaded.</p>
+       <p>
+               <em>Annotation Shading Default</em> - set the default minimum
+               and maximum colours used when <a
+                       href="../colourSchemes/annotationColouring.html">Colour by
+                       Annotation ..</a> is selected from the alignment window's colours menu.
+       </p>
+       <br>
+       </p>
+<p><a name="connections"><strong>&quot;Connections&quot;
+Preferences tab</strong></a></p>
+<p><em>URL Link From Sequence ID</em><br>
+These definitions are used to generate URLs from a sequence's ID or
+database cross references. Read more about <a
+       href="../webServices/urllinks.html#urllinks">configuring URL links
+here</a>.</p>
+<p><em>Default Browser (Unix)</em><br>
+Its difficult in Java to detect the default web browser for Unix users.
+If Jalview can't find your default web browser, enter the name or full
+path to your web browser application.</p>
+<p><em>Proxy Server</em><br>
+If you normally use a proxy server for using the internet, you must tick
+the box &quot;Use a Proxy Server&quot; and enter the address and port
+details as necessary. Web Services will not work if you are using a
+proxy server and do not enter the settings here.</p>
+<p><em>Usage statistics, Questionnaire and Version checks</em><br>
+Uncheck these options to prevent Jalview from submitting usage
+statistics to google analytics, checking for jalview questionnaires or
+retrieving details of the latest release version (at www.jalview.org).
+See the <a href="../privacy.html">user privacy statement</a> for more
+information.</p>
+<p><a name="output"><strong>Output Preferences tab</strong></a></p>
+<p><em>EPS Rendering Style</em><br>
+This is a selection box which allows the user to set a default rendering
+style for EPS export:
+<ul>
+       <li>&quot;Lineart&quot;<br>
+       EPS files will accurately reproduce the alignment view in Jalview and
+       all characters will be converted into line art. Files generated in this
+       way are large and are not easily editable, but have no font table
+       dependencies.</li>
+       <li>&quot;Text&quot;<br>
+       EPS files will be a mixture of text and lineart. This produces compact
+       files that can be edited easily in programs like Microsoft Word and
+       Adobe Illustrator, but can be problematic if the fonts available to
+       jalview are not accessible by the program reading the EPS file.
+       <li>&quot;Prompt each time&quot;<br>
+       Choose this to be asked select between Lineart and Text each time you
+       make an EPS file.</li>
+</ul>
+</p>
+<p><em>Sequence//Start-End Numbering</em><br>
+The output tab also has a group of checkboxes for each file format. If
+these are ticked, then Jalview will write files with the start and end
+sequence positions appended to each sequence id: <pre>
+  >ID/1-10
+  AACDEAAFEA
+</pre>
+<p>If the boxes are left unchecked for a particular format, the
+sequence limits will not be appended to the sequence id.</p>
+</p>
+<p><em>Use Modeller Output</em></p>
+<p>This option only applies to PIR format output. Jalview
+automatically reads PIR files with sequence descriptions compatible with
+the program <a href="http://salilab.org/modeller/">Modeller</a>. If this
+option is selected <a href="../io/modellerpir.html">Jalview will
+write Modeller style PIR files</a> with correct start/end numbering and PDB
+file association (if available). The Jalview id/start-end option is
+ignored if Modeller output is selected.
+<p><a name="editing"><strong>Editing Preferences tab</strong></a></p>
+<p>There are currently 2 options available which can be selected /
+deselected.</p>
+<p><em>AutoCalculate Consensus</em> - For large alignments it can be
+useful to deselect &quot;Autocalculate Consensus&quot; when editing.
+This prevents lengthy calculations which are performed after each
+sequence edit. New alignment windows will have their &quot;Autocalculate
+Consensus&quot; option set according to this setting.</p>
+<p><em>Pad gaps when editing</em> - New alignment windows will
+&quot;Pad Gaps&quot; according to this setting.</p>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+</body>
+</html>