f395b1d1b77f278dced358694c147b898168563d
[jalview.git] / help / html / menus / desktopMenu.html
1 #-------------------------------------------------------------------------------
2 # Jalview - A Sequence Alignment Editor and Viewer (Version 2.5.1)
3 # Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
4
5 # This file is part of Jalview.
6
7 # Jalview is free software: you can redistribute it and/or
8 # modify it under the terms of the GNU General Public License 
9 # as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
10
11 # Jalview is distributed in the hope that it will be useful, but 
12 # WITHOUT ANY WARRANTY; without even the implied warranty 
13 # of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
14 # PURPOSE.  See the GNU General Public License for more details.
15
16 # You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
17 #-------------------------------------------------------------------------------
18 <html>
19 <!--
20  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
21  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
22  * 
23  * This file is part of Jalview.
24  * 
25  * Jalview is free software: you can redistribute it and/or
26  * modify it under the terms of the GNU General Public License 
27  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
28  * 
29  * Jalview is distributed in the hope that it will be useful, but 
30  * WITHOUT ANY WARRANTY; without even the implied warranty 
31  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
32  * PURPOSE.  See the GNU General Public License for more details.
33  * 
34  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
35 -->
36 <head>
37 <title>Desktop Menus</title>
38 </head>
39
40 <body>
41 <p><strong>Desktop Menus</strong></p>
42 <ul>
43         <li><em> <strong>File</strong></em>
44         <ul>
45                 <li><strong>Input Alignment from</strong><em> (See more on <a
46                         href="../io/index.html">file formats</a>) </em>
47                 <ul>
48                         <li><strong>File (Control O)</strong><br>
49                         <em>open file(s) on your local file system</em></li>
50                         <li><strong>URL</strong><br>
51                         <em>open a file from a website. The URL MUST start with http://</em></li>
52                         <li><strong>Textbox</strong><br>
53                         <em>copy and paste an alignment into a text window</em></li>
54                 </ul>
55                 </li>
56                 <li><strong>Fetch Sequence<br>
57                 </strong><em>Shows a dialog window in which you can select known ids from
58                 Uniprot, EMBL, EMBLCDS or PDB database using Web Services provided by
59                 the European Bioinformatics Institute.</em></li>
60                 <li><strong>Save Project</strong><br>
61                 <em>Saves all currently open alignment windows with their current
62                 view settings and any associated trees, as a <a
63                         href="../features/jalarchive.html">Jalview Archive</a> (which has a
64                 .jar extension).</em></li>
65                 <li><strong>Load Project</strong><br>
66                 <em>Loads Jalview archives <strong>only</strong>.</em></li>
67                 <li><strong>Quit</strong><br>
68         <em>Close Jalview. <br>
69         <strong>Note - any annotation you have made on alignments will be lost 
70         unless you Save your work before quitting.</strong></em><br>
71       </li>
72         </ul>
73         </li>
74         <li><strong>Tools</strong>
75         <ul>
76                 <li><strong><a href="../features/preferences.html">Preferences<br>
77                 </a></strong><em>Change the default visual settings for opening new alignment
78                 windows.</em></li>
79                 <li><strong>Show Memory Usage<br></strong>
80                 <em>When ticked, the currently available memory will be displayed in the 
81                 bottom right of the desktop background area.<br>
82                 See the <a href="../memory.html">help on jalview memory settings</a> for more information.</em></li>
83                 <li><strong>Collect Garbage<br></strong>
84                 <em>Selecting this will initiate the Java Virtual Machine garbage collector, which might help free up some memory... perhaps.
85                 </em></li>
86                 <li><strong>Java Console<br/></strong>
87                 <em>Toggles the display of a the Jalview Java Console window. This setting will be remembered in your user preferences.</em></li>
88                 <li><strong>Groovy Console...<em> (only available if groovy is on the classpath)</em><br></strong>
89                 <em>Open's the <a href="../groovy.html">Groovy Console</a> for interactive scripting.</em><strong><br></strong></li>
90                 
91         </ul>
92         </li>
93         <li><strong>Vamsas</strong>
94         <em>For more details, read the <a href="../vamsas/index.html">Jalview VAMSAS documentation</a>.<br/>
95         When no session is active, the menu provides options for initiating a new VAMSAS session:</em>
96         <ul>
97         <li><strong>Connect to<br/></strong>
98         <em>Connect to one of the existing sessions available.</em></li>
99         <li><strong>New VAMSAS session<br/></strong>
100         <em>Initiates a new local VAMSAS session.</em></li>
101         <li><strong>Load VAMSAS session...<br/></strong>
102         <em>Opens a file browser allowing you to choose a VAMSAS document to import into a new local session.</em></li>
103         </ul>
104         <em>When Jalview is joined to a VAMSAS session, the menu contains the following:</em>
105         <ul>
106         <li><strong>Session Update<br/></strong>
107         <em>Sends alignment data in the Jalview desktop to the VAMSAS session.</em></li>
108         <li><strong>Save VAMSAS Session...<br/></strong>
109         <em>Saves the current session to a VAMSAS document archive.</em></li>
110         <li><strong>Stop VAMSAS Session<br/></strong>
111         <em>Disconnects from the current session. You may be asked if you want to save the current session's data if no other VAMSAS clients are connected.</em></li>
112         </ul>
113         </li>
114         <li><strong>Help </strong>
115         <ul>
116                 <li><strong>About<br>
117                 </strong><em>Displays the version and creation date of the application, as
118                 well as acknowledgements and a citation reference. </em></li>
119                 <li><strong>Documentation<br>
120                 </strong><em>Displays help files as a browseable, searchable set of pages
121                 with a table of contents. </em><strong><br>
122                 </strong></li>
123         </ul>
124         </li>
125         <li><strong>Window</strong><br>
126         <em>Each time a new window is added to the Jalview Desktop a
127         corresponding menu item will be added to the &quot;Window&quot; menu
128         that will bring the window to the top of the pile when it is selected.
129         <ul>
130                 <li><strong>Close All</strong><br>
131                 Close all alignment and analysis windows.<br><strong>Note: This will erase all alignments from memory, and cannot be undone!</strong></li>
132                 <li><strong>Raise Associated Windows</strong><br>
133                 Bring all windows associated with the current alignment to the top of the pile. 
134                 </li>
135                 <li><strong>Minimise Associated Windows</strong><br>
136                 Hide all windows related to the current alignment behind icons on the Jalview Desktop.
137                 </ul>
138                 </em></li>
139         </ul>
140 </body>
141 </html>