explaining in more detail about disabling feature colours if they are shown in the...
[jalview-manual.git] / TheJalviewTutorial.tex
index 361dfba..4f3cd2d 100644 (file)
@@ -259,49 +259,33 @@ Alignment' submenu of a window's `File' dropdown menu.
 \end{center}
 \end{figure}
 
-This tutorial is based on the Jalview
-Desktop application. Much of the information will also be useful for users of
-the JalviewJS, which has the same core editing, analysis and visualization capabilities. The Jalview Desktop, however, is much more powerful, and
-includes additional support for interaction with external web services, and
-production of publication quality graphics.
-
-The Jalview Desktop application can be downloaded from the Jalview website.
-Click the Download link in the top right hand corner of the Jalview homepage.
-This opens the download webpage, the options available will reflect if you have Mac or PC computer.
-The application is downloaded by clicking the link as appropriate for your computer operating system.
-Instal the Jalview application by clicking on the downloaded file and following the instructions.
-Jalview has the functionality to automatically update itself when a new version is released.
-%%launched from the
-%%web {\sl via} Java webstart, or as an application loaded onto your hard drive. 
-%%The webstart version is launched from the `Launch Jalview Desktop
-%%button' at the top right hand side of pages of the website 
-%%\href{http://www.jalview.org}{(www.jalview.org)}.
-%%To download the locally installable version, follow the links on the download
-%%page
-%%\href{http://www.jalview.org/download}{(www.jalview.org/download) }
-%% (Figure \ref{download}).
-%%These links will launch the latest stable release of Jalview.\par
-
-%% this paragraph needs to be rewritten for the new signed certificate from Certum.
-
-%%When the application is launched with webstart, dialogs may appear before
-%%the application starts. If your browser is not set up to handle webstart, then
-%%clicking the launch link may download a file that needs to be opened
-%%manually, or prompt you to select the program to handle the webstart
-%%file. If that is the case, you will need to locate the {\bf javaws} program
-%%on your system\footnote{The file that is downloaded will have a type of {\bf
-%%application/x-java-jnlp-file} or {\bf .jnlp}. The {\bf javaws} program that can run
-%%this file is usually found in the {\bf bin} directory of your Java
-%%installation}. Once java webstart has been launched, you may also be prompted to
-%%accept a security certificate signed by the Barton Group.\footnote{On some
-%%systems, the certificate may be signed by 'UNKNOWN'. In this case, clicking
-%%through the dialogs to look at the detailed information about the certificate
-%%should reveal it to be a Barton group certificate.} You can always trust us, so
-%%click trust or accept as appropriate. The splash screen (Figure \ref{splash})
-%%gives information about the version and build date that you are running,
-%%information about later versions (if available), and the paper to cite in your
-%%publications. This information is also available on the Jalview web site at 
-%%\url{http://www.jalview.org}.
+This tutorial is based on the Jalview Desktop application. Much of the
+information will also be useful for users of the JalviewJS, which has the same
+core editing, analysis and visualization capabilities. The Jalview Desktop,
+however, is much more powerful, and includes additional support for interaction
+with external web services, powerful molecular graphics programs, and production
+of publication quality graphics.
+
+The Jalview Desktop application can be downloaded from the download link on the
+Jalview website, which takes you to
+\href{http://www.jalview.org/download}{(www.jalview.org/download)}. The page
+automatically displays the options available for your computer (e.g. if you have
+Mac or PC), and a button to show all available downloads. These include special
+'executable Jar' distributions useful if you want to run a specific version of
+Jalview.
+To ensure you are running the latest version of Jalview, we recommend
+downloading the Jalview Desktop Installer package for your platform, clicking on
+the downloaded file and following the instructions to install it.
+Once installed, the Jalview Application will automatically update itself when a
+new version is released.
+
+When the Jalview Desktop application is launched, you will first see a loading
+screen whilst it checks for updates, then the program will start with the
+Jalview splash screen (Figure \ref{splash}).
+This gives information about the version and build date that you are running,
+information about later versions (if available), and the paper to cite in your
+publications. This information is also available on the Jalview web site at
+\url{http://www.jalview.org}.
 
 %[fig 2] 
 \begin{figure}[htbp]
@@ -344,13 +328,13 @@ Preferences...} menu on the desktop. A `Preference'
 dialog box opens, untick the box adjacent to the `Open file' entry in the
 `Visual' preferences tab.
 Click {\sl OK} to save the preferences.}
-%%\exstep{Launch another Jalview workbench from the web site by clicking on the
-%%The example alignment should not be loaded as Jalview starts up.}
+%%\exstep{Quit Jalview and open it again to check that the
+%%The example alignment is not loaded wehn Jalview starts up.}
 \exstep{To reload the original demo file select the
 {\em File$\Rightarrow$ From URL} entry in the Desktop menu. Click on
 the URL history button (a downward arrow on the right hand side of the dialog
-box) to view the files, select exampleFile\_2\_7.jar
-(\url{http://www.jalview.org/examples/exampleFile_2_7.jar}) 
+box) to view the files, select exampleFile\_2\_7.jvp
+(shown as \url{https://www.jalview.org/examples/exampleFile_2_7.jvp}) 
 then click {\sl OK}.}
 \begin{list}{$\circ$}{\newline
   \newline {\bf
@@ -360,8 +344,6 @@ then click {\sl OK}.}
 to the {\sl Tools $\Rightarrow$
 Preferences...} menu on the desktop. Then tick the `Open file' entry of `Visual'
 preferences tab, type in the URL of the sequence you want to load.}
-%%\item {You may want to move the jalview.jnlp file from your {\bf downloads} to another folder.}
-%%\item {Opening Jalview via the jnlp file will also allow Jalview to be launched offline.}
 \end{list}
 
 {\bf See the video at:
@@ -823,13 +805,14 @@ $\Rightarrow$ Load Project} menu option. Observe how many of the windows
 reopen. Are they the same as when they were saved ? } {\bf See the video at:
 \url{http://www.jalview.org/Help/Getting-Started}.} }
 
+%% Suzanne: Jim's comment: this now appears at the end of the section, over the page from the exercise. I doubt anyone will read it there.
 \subsection{Jalview Projects}
 \parbox[c]{4in}{If you wish to save a complete Jalview session rather than
 just a single alignment (e.g. because you have calculated trees or multiple
 different alignments) then save your work as a Jalview Project
-file (.jvp).\footnote{Tip: Ensure that you have allocated plenty of memory to
+file (.jvp).\footnote{Tip: Ensure that that plenty of memory is available to
 Jalview when working with large alignments in Jalview projects. See Section 
-\ref{memorylimits} for how to do this.}
+\ref{memorylimits} for how to check this.}
 From the main menu select {\sl File $\Rightarrow$ Save Project} and a file save
 dialog box will appear. Loading a project will restore Jalview to exactly the
 view at which the file was saved, complete with all alignments, trees,
@@ -1013,10 +996,10 @@ context menu in the alignment window.
 Open the {\sl Selection $\Rightarrow$ Edit New Group $\Rightarrow$ Group Colour
 } menu and select {\sl Percentage Identity}.
 This will turn the selected region into a group and colour it accordingly.}
-\exstep{Hold down [CTRL] ([CMD] on Mac) or [SHIFT] and use the mouse to select and deselect sequences in
+\exstep{Hold down [CTRL] ([CMD] on Mac) and use the mouse to select and deselect sequences in
 the alignment by clicking on their Sequence ID label. Note how the group expands
 to include newly selected sequences, and the Percentage Identity colouring changes. }
-\exstep{ Another way to resize the group is by using the mouse to click and drag
+\exstep{ Another way to resize the group is simply to use the mouse to click and drag
 the right-hand edge of the selected group.}
 
 \exstep{The current selection can be exported and saved, place mouse on the text
@@ -1160,9 +1143,9 @@ Reveal All}.
 }
 \exstep{Repeat the above using columns to hide and reveal columns
 instead of sequences.}
-\exstep{Select a region of the alignment, and experiment with the {\sl Hide all
-but selected region} option. In the alignment window menu, {\sl View $\Rightarrow$ Hide $\Rightarrow$ All
-but selected region.}} \exstep{Select some sequences, pick one to represent the rest by hovering
+\exstep{Select a region of the alignment, and experiment with {\sl View $\Rightarrow$ Hide $\Rightarrow$ Hide all
+but selected region} and {\sl View $\Rightarrow$ Hide $\Rightarrow$ All
+but selected region} options in the alignment window menu.} \exstep{Select some sequences, pick one to represent the rest by hovering
 the mouse over this sequence. Bring up the Sequence ID context menu by right
 clicking and select {\sl (Sequence ID name) $\Rightarrow$ Represent group
 with (Sequence ID name )}. To reveal these hidden sequences, right click on the
@@ -1243,8 +1226,10 @@ together). Note that the deletion will only occur if the gaps are in the same
 columns in all sequences in the selected group, and those columns are to the
 right of the selected residue.
 
+{\bf That's it for this chapter. Don't forget the exercises on the next page!}
+\newpage
 
-\exercise{Editing Alignments Homework Exercise}
+\exercise{Editing Alignments}
   %\label{mousealedit}
 % TODO: VERIFY FOR 2.6.1 and 2.7 - NUMBERING/INSTRUCTIONS APPEAR OFF
 {
@@ -1253,6 +1238,8 @@ You are going to manually reconstruct part of the example Jalview
 alignment available at
  \href{http://www.jalview.org/examples/exampleFile.jvp}
  {http://www.jalview.org/examples/exampleFile.jvp}.
+ {\sl {\bf Note: this is a homework exercise for jalview course participants!}}
 
 {\sl {\bf Mac Users:} Please use the Apple or [CMD] key in place of [CTRL]
 for key combinations such as [CTRL]-A. }
@@ -1324,12 +1311,14 @@ backwards and replay the edits you have made.}
 }
 
 
-\exercise{Keyboard Edits Homework Exercise}
+\exercise{Keyboard Edits}
 {
 \label{keyboardsex}
 This continues on from the previous exercise, and recreates the final part of the example ferredoxin
 alignment from the unaligned sequences using Jalview's keyboard editing mode.
 
+{\bf Note: This is a homework exercise for jalview course participants}
+
 {\bf Window users:} Please {\em only use} [SHIFT]-[SPACE] in this
 exercise.
 
@@ -1379,7 +1368,7 @@ appears to happen, it may be that you have sequence feature annotation
 displayed, and you may have to disable it using the {\sl View $\Rightarrow$
 Show Sequence Features} option before you can see your colourscheme.
 
-There are two main types of colouring styles: {\bf simple static residue}
+There are two main types of colouring styles: simple {\bf static residue}
 colourschemes and {\bf dynamic schemes} which use conservation and consensus
 analysis to control colouring. {\bf Hybrid colouring} is also possible, where
 static residue schemes are modified using a dynamic scheme. The individual schemes are described in Section \ref{colscheme}.
@@ -1600,7 +1589,7 @@ assigned colours (left). The profile is saved (center) and can then be accessed
 \exercise{Colouring Alignments}{
 \label{color}
 Note: Ensure that the {\sl Apply Colour
-To All Groups} flag is not selected (ie unticked) in {\sl Colour} menu in the alignment window.
+To All Groups} flag is not selected (i.e. not ticked) in {\sl Colour} menu in the alignment window.
 % patch needed for 2.10 This must be turned {\sl off} specifically as it is on
 % by default.
 
@@ -1609,7 +1598,7 @@ seed database. Select the alignment menu option {\sl Colour $\Rightarrow$
 Clustalx} and note the colour change. Now try all the other colour schemes in the {\sl Colour} menu. 
 Note that some colour schemes do not colour all residues.}
 \exstep{Colour the alignment using {\sl Colour  $\Rightarrow$ Blosum62 score}. Select a group
-of around 4 similar sequences. Use the context menu (right click on the residues in the group)
+of around 4 similar sequences. Use the context menu (opened by right clicking on the residues in the group)
 option {\sl Selection $\Rightarrow$ Edit New Group $\Rightarrow$ Group Colour
 $\Rightarrow$ Blosum62 score} to colour the selection. Notice how some residues which
 were not coloured are now coloured. The calculations performed for dynamic
@@ -1621,8 +1610,12 @@ the group using {\sl Colour  $\Rightarrow$ Taylor}.
 Select the menu option  {\sl Colour  $\Rightarrow$ By Conservation}. 
 Slide the selector in the Conservation Colour Increment dialog box from side
 to side and observe the changes in the alignment colouring in the selection and in the complete alignment.}
-Note: Feature colours overlay residue colouring, and this may mask residue colouring. If this is an issue, he features colours can be
-toggled off by going to {\sl View  $\Rightarrow$ Show Sequence Features}.
+
+Note: If you don't see any changes in appearance, it might be because sequence
+features are currently displayed (these are introduced later, in Section
+\ref{featannot}). To see if features are obscuring your colour scheme settings, look to see if the {\sl View 
+$\Rightarrow$ Show Sequence Features} option in the alignment window menu is
+ticked. If it is, select it to disable feature colouring.
 
 {\bf See the video at: \url{http://www.jalview.org/training/Training-Videos}.}
 }