Merge branch 'develop' into features/JAL-2360colourSchemeApplicability
[jalview.git] / help / html / menus / desktopMenu.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>Desktop Menus</title>
24 </head>
25
26 <body>
27   <p>
28     <strong>Desktop Menus</strong>
29   </p>
30   <ul>
31     <li><em> <strong>File</strong></em>
32       <ul>
33         <li><strong>Input Alignment from</strong><em> (See
34             more on <a href="../io/index.html">file formats</a>)
35         </em>
36           <ul>
37             <li><strong>File (Control O)</strong><br> <em>open
38                 file(s) on your local file system</em></li>
39             <li><strong>URL</strong><br> <em>open a file
40                 from a website. The URL MUST start with http://</em></li>
41             <li><strong>Textbox</strong><br> <em>copy and
42                 paste an alignment into a text window</em></li>
43           </ul></li>
44         <li><strong>Fetch Sequence<br>
45         </strong><em>Shows a dialog window in which you can select known ids
46             from UniProt, EMBL, EMBLCDS or PDB database using Web
47             Services provided by the European Bioinformatics Institute.</em></li>
48         <li><strong>Save Project</strong><br> <em>Saves
49             all currently open alignment windows with their current view
50             settings and any associated trees, as a <a
51             href="../features/jalarchive.html">Jalview
52               Archive</a> (which has a .jar extension).
53         </em></li>
54         <li><strong>Load Project</strong><br> <em>Loads
55             Jalview archives <strong>only</strong>.
56         </em></li>
57         <li><strong>Quit</strong><br> <em>Close Jalview.
58             <br> <strong>Note - any annotation you have
59               made on alignments will be lost unless you Save your work
60               before quitting.</strong>
61         </em><br></li>
62       </ul></li>
63     <li><strong>Tools</strong>
64       <ul>
65         <li><strong><a href="../features/preferences.html">Preferences<br>
66           </a></strong><em>Change the default visual settings for opening new
67             alignment windows.</em></li>
68         <li><strong>Show Memory Usage<br></strong> <em>When
69             ticked, the currently available memory will be displayed in
70             the bottom right of the desktop background area.<br>
71             See the <a href="../memory.html">help on Jalview memory
72               settings</a> for more information.
73         </em></li>
74         <li><strong>Collect Garbage<br></strong> <em>Selecting
75             this will initiate the Java Virtual Machine garbage
76             collector, which might help free up some memory... perhaps.
77         </em></li>
78         <li><strong>Java Console<br /></strong> <em>Toggles
79             the display of a the Jalview Java Console window. This
80             setting will be remembered in your user preferences.</em></li>
81         <li><strong>Jalview News<br /></strong> <em>Opens the
82             <a href="../webServices/newsreader.html">Jalview News</a>
83             dialog box.
84         </em></li>
85         <li><strong>Groovy Console...<br></strong> <em>Opens
86             the <a href="../features/groovy.html">Groovy Console</a> for
87             interactive scripting.
88         </em><strong><br></strong></li>
89
90       </ul></li>
91     <li><strong>Vamsas</strong> <em>For more details, read the
92         <a href="../vamsas/index.html">Jalview VAMSAS documentation</a>.<br />
93         When no session is active, the menu provides options for
94         initiating a new VAMSAS session:
95     </em>
96       <ul>
97         <li><strong>Connect to<br /></strong> <em>Connect to
98             one of the existing sessions available.</em></li>
99         <li><strong>New VAMSAS session<br /></strong> <em>Initiates
100             a new local VAMSAS session.</em></li>
101         <li><strong>Load VAMSAS session...<br /></strong> <em>Opens
102             a file browser allowing you to choose a VAMSAS document to
103             import into a new local session.</em></li>
104       </ul> <em>When Jalview is joined to a VAMSAS session, the menu
105         contains the following:</em>
106       <ul>
107         <li><strong>Session Update<br /></strong> <em>Sends
108             alignment data in the Jalview desktop to the VAMSAS session.</em></li>
109         <li><strong>Save VAMSAS Session...<br /></strong> <em>Saves
110             the current session to a VAMSAS document archive.</em></li>
111         <li><strong>Stop VAMSAS Session<br /></strong> <em>Disconnects
112             from the current session. You may be asked if you want to
113             save the current session's data if no other VAMSAS clients
114             are connected.</em></li>
115       </ul></li>
116     <li><strong>Help </strong>
117       <ul>
118         <li><strong>About<br>
119         </strong><em>Displays the version and creation date of the
120             application, as well as acknowledgements and a citation
121             reference. </em></li>
122         <li><strong>Documentation<br>
123         </strong><em>Displays help files as a browseable, searchable set of
124             pages with a table of contents. </em><strong><br> </strong></li>
125       </ul></li>
126     <li><strong>Window</strong><br> <em>Each time a new
127         window is added to the Jalview Desktop a corresponding menu item
128         will be added to the &quot;Window&quot; menu that will bring the
129         window to the top of the pile when it is selected.
130         <ul>
131           <li><strong>Close All</strong><br> Close all
132             alignment and analysis windows.<br> <strong>Note:
133               This will erase all alignments from memory, and cannot be
134               undone!</strong></li>
135           <li><strong>Raise Associated Windows</strong><br>
136             Bring all windows associated with the current alignment to
137             the top of the pile.</li>
138           <li><strong>Minimise Associated Windows</strong><br>
139             Hide all windows related to the current alignment behind
140             icons on the Jalview Desktop.
141         </ul>
142     </em></li>
143   </ul>
144 </body>
145 </html>