JAL-1384 JAL-1388 revised popup menu documentation for group create/edit/remove
[jalview.git] / help / html / menus / popupMenu.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
4  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
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 of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
18 -->
19 <head>
20 <title>Popup Menu</title>
21 </head>
22
23 <body>
24 <p><strong>Popup Menu</strong><br>
25 <em>This menu is visible when right clicking either within a
26 selected region on the alignment or on a selected sequence name. It may
27 not be accessible when in 'Cursor Mode' (toggled with the F2 key).</em></p>
28 <ul>
29   <li><strong>Selection</strong> 
30     <ul>
31       <li><a name="sqreport"><strong>Sequence Details ...<br>
32           </strong></a><em>(Since Jalview 2.8)<br>Open an <a href="../io/exportseqreport.html">HTML report containing the annotation
33             and database cross references</a> normally shown in the sequence's
34             tooltip.</em></li>
35       <li><strong>Edit </strong> 
36         <ul>
37           <li><strong>Copy</strong><br>
38             <em>Copys the selected region. In the applet version, the copied sequences 
39             are not available to the system clipboard.</em></li>
40           <li><strong>Cut<br>
41             </strong><em>Cuts the selected region from the alignment. In the applet 
42             version, the copied sequences are not available to the system clipboard.</em></li>
43           <li><strong>Edit Sequence</strong><br>
44             <em>Edit the selected sequence(s) directly. Spaces will be converted 
45             to the current gap character.</em></li>
46           <li><strong>To Upper Case</strong><em><strong><br>
47             </strong><em>Changes the case of selected region to lower case.</em> 
48             </em></li>
49           <li><strong>To Lower Case<br>
50             </strong><em>Changes the case of selected region to upper case.</em><strong> 
51             </strong></li>
52           <li><strong>Toggle Case</strong><br>
53             <em>Switches the case of all residues within the selected region.</em></li>
54         </ul>
55       </li>
56       <li><strong>Output to Textbox<br>
57         </strong><em>The selection area will be output to a a text window in the 
58         selected alignment format. </em></li>
59       <li><strong><a href="../features/creatinFeatures.html">Create Sequence Feature...</a></strong><br>
60         <em>Opens the dialog box for creating sequence features over the currently 
61         selected region on each selected sequence.</em></li>
62       <li><strong>Create Group<br>
63             </strong><em>This will define a new group from the current selection.</em><strong> 
64             </strong></li>
65           <li><strong>Remove Group<br>
66             </strong><em>This will undefine the selected group. </em><strong> 
67             </strong></li>
68           <li><strong>Edit (New) Group</strong><br>
69         <em>Group Editing Menu</em> <br />Options in this menu modify
70                                         the name and display properties of the currently selected group, or
71                                         a new group defined using the current selection.
72                                         <ul>
73           <li><strong>Name: &lt;Group&gt;</strong> or <strong>Edit name and description</strong><br><em>The first entry in the
74           menu displays the name for the currently selected group, if it has one. Selecting this option opens a window allowing the name and
75           description for this group to be edited. Click OK to set the
76           new name and decription, and cancel to leave the existing
77           name and description unchanged.</em></li>
78           <li><strong>Group Colour<br>
79             </strong><em>Sets the <a href="../colourSchemes/index.html">colour</a> 
80             of the group.</em><strong> </strong></li>
81           <li><strong>Boxes<br>
82             </strong><em>If selected the background of a residue within the selected 
83             group will be coloured according to the assigned colour scheme.</em><strong> 
84             </strong></li>
85           <li><strong>Text<br>
86             </strong><em>If selected the selected group will display text. </em></li>
87           <li><strong>Colour Text<br>
88             </strong><em>If selected the selected group will display text in a 
89             colour slightly darker than the background colour of that residue.</em></li>
90           <li><strong>Border Colour <br>
91             </strong><em>Selecting this will display a &quot;Colour Chooser&quot; 
92             window. Select a colour than press OK to set the border colour of 
93             a group.</em></li>
94         <li><strong>Show Unconserved<br>
95           </strong><em>When this is selected, all symbols in the group matching the consensus sequence at that column will be rendered as a '.', highlighting mutations in the group area.
96         </em></li>
97                     </ul>
98       </li>
99 <!-- not available in 2.5 yet
100     <li><strong>Group Links<br>
101     </strong><em>This menu is only visible if there are group links available for the current selection.
102     </em> 
103     <ul>
104     <li><em>ID links</em> allow you to send IDs associated with the current selection to a web server.</li>
105     <li><em>Sequence links</em> allow you to send the sequences in the currently selected region to a web server.</li>
106     <li><em>Sequence and ID links</em> allow you to send sets of IDs and sequences associated with the current selection to a web server.</li>
107     </ul>
108     <em>Group Links were added in Jalview 2.5</em></li>
109 -->    </ul>
110   </li>
111   <li><strong>Sequence Id<br>
112     </strong><em>This menu is only visible if you right-click on a sequence name. 
113     </em> 
114     <ul>
115       <li><a name="sqreport"><strong>Sequence Details ...<br>
116                                         </strong></a><em>(Since Jalview 2.8)<br>Open an <a href="../io/exportseqreport.html">HTML report containing the annotation
117                                                 and database cross references</a> normally shown in the sequence's
118                                                 tooltip.</em></li>
119                         <li><strong>Edit Name/Description<br>
120         </strong><em>You may edit the name and description of each sequence. A 
121         window will be displayed asking for a new sequence name and sequence description 
122         to be entered. Press OK to accept your edit. To save sequence descriptions, 
123         you must save in Fasta, PIR or Jalview File format.</em></li>
124       <li><em> </em></li>
125       <li><strong>Represent Group With (Sequence Id)</strong><br>
126         <em>All sequences in the current selection group will be hidden, apart 
127         from (Sequence Id). Any edits performed on the visible representative 
128         sequence will be propagated to the hidden sequences. </em></li>
129       <li><a name="sqid.popup"><strong>Link</strong><br>
130         <em>This menu item lists all links which have been set up in the <a href="../features/preferences.html">Preferences</a> 
131         Connections tab.<br>
132         Since Jalview 2.4, links will also be made for database cross 
133         references (where the database name exactly matches the link name set up in <a href="../features/preferences.html">Preferences</a>).
134         <br>Since Jalview 2.5, links are also shown for non-positional sequence features attached to 
135         the sequence, and any regular-expression based URL links that 
136         matched the description line.
137         </em><strong><br>
138         </strong></li>
139     </ul>
140   </li>
141   <li><strong>Structure</strong> 
142     </strong><em>This menu is only visible if you right-click on a sequence name. 
143     </em> 
144     <ul>
145       <li><strong>Associate Structure with Sequence</strong> 
146         <ul>
147           <li><strong>From File<br>
148             </strong><em>Load a PDB file from local disk which will be associated 
149             with this sequence. This file will be used if the user subsequently 
150             clicks on &quot;View PDB Structure&quot; menu item.</em></li>
151           <li><strong>Enter PDB id<br>
152             </strong><em>Enter the PDB id from an input window. This PDB id will 
153             be used by the service WSDBFetch, provided by the EBI, to fetch the 
154             PDB file if the user subsequently clicks on &quot;View PDB Structure&quot; 
155             menu item. </em></li>
156           <li><strong>Discover PDB ids<br>
157             </strong><em>This will use the service WSDBFetch, provided by the 
158             EBI, to retrieve all PDB ids associated with the sequences in the 
159             alignment if the sequences have valid Uniprot names or accession ids. 
160             </em></li>
161         </ul>
162       </li>
163       <li><strong>View Structure<br>
164         </strong><em> If the sequence has an associated PDB file added by one 
165         of the methods described above, Jalview will open a 3D interactive 
166         view of the file.<br>
167         These entries will only be present if the sequence has <a
168                         href="../features/viewingpdbs.html">associated PDB structures</a>.<br/>
169                         If the sequence or alignment has RNA structure, then <strong>2D RNA</strong> entries will also be present enabling you to open a linked view of the RNA structure in <a href="../features/varna.html">VARNA</a>.</em><br>
170       </li>
171     </ul>
172   </li>
173   <li><strong>Hide Sequences</strong><br>
174     <em>Hides the currently selected sequences in this alignment view.</em><strong><br>
175     <br>
176     </strong></li>
177 </ul>
178 </body>
179 </html>