Andrea has included Histogram changes, Theme addition, + other cleanup
[goodguy/cin-manual-latex.git] / parts / Windows.tex
index 1bfd0547be37ab98ccdbdcabc3e497c02429bb95..57c30ca6c33b9f2e9c237f76be4c40cfe19e0a7b 100644 (file)
@@ -18,7 +18,7 @@ and pointers to the media so that the media is not modified. The EDL is describe
 
 The main window is called the \textit{Program} window and is often just referred to as the \textit{timeline}.  Here is where you enter the main menu operations.  
 This timeline consists of a vertical stack of tracks with time represented horizontally on the track. 
-It is the output of the rendering operations and this is what is saved when you run the File pulldown, Save command.
+It is the output of the rendering operations and this is what is saved when you run the \textit{File} pulldown, Save command.
 Immediately to the left of the timeline is the patchbay. The patchbay contains options that affect each track.  
 These options are described in great detail in \nameref{sec:patchbay}.
 
@@ -106,7 +106,7 @@ Shortcuts, \texttt{Ctrl-Pgup} and \texttt{Ctrl-Pgdown}, change the track zoom to
 
 \emph{Automation type} is used for selecting one of the following: Audio Fade, Video Fade, Zoom, Speed, X, or Y (X and Y are for the compositor's Camera and Projector).  When an auto line is present on
 the timeline and is being manipulated, a small square the same color as the line will be shown to 
-the left of the Automation type when the left mouse button is pressed.  This is just an indicator to make it easy to see what is being worked.
+the left of the Automation type when the left mouse button (LMB) is pressed.  This is just an indicator to make it easy to see what is being worked.
  
 The \emph{curve zoom} affects the curves for the selected \emph{automation type} in all the tracks of that type and determines the value range for those curves. 
 Use the tumbler arrows to the left of the numbers for the minimum value and the tumblers to the right for the maximum value, or manually enter the values in the text box. 
@@ -138,10 +138,9 @@ The Track Menu contains a number of options:
 
 \begin{description}
     \item[Attach Effect] opens a dialog box of effects applicable to the type of track of audio or video.
-    \item[Move up] moves the tracks one step up in the stack with the top track going to the bottom.
-This is applicable to all armed and disarmed tracks.
-    \item[Move down]  moves the tracks one step down in the stack with the bottom track going to
-the top.  This is applicable to all armed and disarmed tracks.
+    \item[Move up] moves the tracks one step up in the stack with the top track going to the bottom.  This is applicable to all armed and disarmed tracks.
+    \item[Move down]  moves the tracks one step down in the stack with the
+bottom track going to the top.  This is applicable to all armed and disarmed tracks.
     \item[Delete track]  removes the track from the timeline.
     \item[Add Track]  adds a track of the same media type as the one selected, audio or video, above the selected track.
     \item[Find in Resources]  the media file on that track at the location of the insert pointer will be highlighted in the media folder in the Resources window. If the 
@@ -153,8 +152,8 @@ the top.  This is applicable to all armed and disarmed tracks.
         media. In Drag and Drop editing mode, if you select multiple edits all of those clips will have
 their title name changed.
     \item[Bar color]  allows the user to select a specific color for the title bar.  This helps to more easily locate a piece of media.
-    \item[Swap up] moves the selected track one step up in the stack.  Disarmed tracks affect the results.
-    \item[Swap down]  moves the selected track one step down in the stack.  Disarmed tracks affect the results.
+    \item[Swap up] allows for changing the order of the tracks up. Disarmed tracks affect the results.
+    \item[Swap down]  allow for changing the order of the tracks down.  Disarmed tracks affect the results.
     \item[Resize Track]  resizes the track; this is only applicable to video tracks.
     \item[Match Output Size]  resizes the track to match the current output size; this is only applicable to video tracks.
 \end{description}
@@ -214,7 +213,7 @@ the \texttt{I-beam} in the Transport and Buttons bar. In figure~\ref{fig:inserti
 the green colored highlight \protect\footnote{green is used in the default Cakewalk theme, but the highlight color will be different in other themes} on the arrow icon indicating that you are currently in 
 \emph{drag and drop mode}.
 
-With the arrow highlighted for \emph{drag and drop mode}, a double click with the left mouse button (LMB) in the timeline selects the edit the mouse pointer is over. 
+With the arrow highlighted for \emph{drag and drop mode}, a double click with the left mouse button in the timeline selects the edit the mouse pointer is over. 
 Then dragging in the timeline repositions that edit and this can be used for moving effects,
 changing the order of playlists, or moving video pieces around. 
 There are numerous methods to cut and paste in \emph{drag and drop mode} by setting In/Out points to define
@@ -335,19 +334,21 @@ function to delete them all. The same precedence rules apply to this operation a
 is, if both In/Out points are set and there is a highlighted area also set, the highlighted area's 
 labels will be cleared and not those between the In/Out points.
 
-If you enable \emph{Edit labels} in the Settings pulldown menu or disable the \emph{Lock labels from moving}
+If you enable \emph{Edit labels} in the \textit{Settings} pulldown menu or disable the \emph{Lock labels from moving}
 button on the Transport and Buttons bar, labels will be cut, copied or pasted along with the selected
 area of the first armed track. 
 In the same manner, if a selected area of media is spliced from the viewer to the timeline in a position 
 before labels, the labels will be moved to the right on the timebar so that the label maintains its 
 relative position to its edit. 
 To prevent labels from moving on the timebar, enable the \emph{Lock labels from moving} icon or
-disable the \emph{Edit labels} option under the Settings pulldown.
+disable the \emph{Edit labels} option under the \textit{Settings} pulldown.
 
 \subsection{Color Title Bars and Assets}%
 \label{sub:color_title_bars_and_assets}
 
-In order to visually aid in locating clips on the timeline that are from the same media file, you can have them auto-colored or self-colored.  
+In order to visually aid in locating clips on the timeline that are from the same media file, you can have them auto-colored or self-colored.  Auto-color is
+an automatic system to always color the files on the timeline when loaded. 
+Self-color is a manual coloring requiring the user to take definitive action.
 Use of this feature requires additional memory and cpu on every timeline redraw, therefore it is recommended that smaller computers leave it turned off.
 
 For auto-color the color will be based on a hashed filename so that whenever you load this particular media, it will always have the same color on the title bar even if you use proxy.  
@@ -360,11 +361,11 @@ Choose the option \textit{Bar Color} to bring up the color picker and choose a c
 You can also change the alpha value in the color picker and this alpha takes precedence over the current alpha slider bar value unless the color picker's alpha value is set to 1.0.   
 The color will only change after you click on the checkmark.  
 The \emph{Bar Color} option works in either Drag and Drop or Cut and Paste editing mode and also works if \textit{Autocolor assets} is not set.  
-In Drag and Drop editing mode, if you select several clips and then bring up the Edits popup with the right mouse button over a track, you can use the \emph{Bar Color} option to change all of those selected to the same color.
+In Drag and Drop editing mode, if you select several clips (reference "Create a 
+group" in ~\ref{sub:grouping_edits}) and then bring up the Edits popup with the right mouse button over a track, you can use the \emph{Bar Color} option to change all of those selected to the same color.
 
 To go back to the default colors, uncheck \textit{Autocolor assets} in Preferences, but this does not affect the specially chosen self-colored ones as they are preserved.  
-To change these individually or  selectively, use the Edits popup \emph{Bar Color} option and click on \textit{Default} in the color picker window.  Auto-color does not honor armed/disarmed tracks.  
-Self-color does honor armed/disarmed tracks.
+To change these individually or selectively, use the Edits popup \emph{Bar Color} option and click on \textit{Default} in the color picker window.  
 
 And that’s not all!  
 There is an \emph{alpha fader slider bar} on the bottom of the main window on the right hand side of the Zoom Panel.  
@@ -425,7 +426,7 @@ Proxy and Transcode (\ref{sec:proxy_settings}), as well as the others.
 \label{sub:window_layouts}
 
 If you like to use different window layouts than the default for certain scenarios, you can setup, save, and load 4 variations.   
-First, position your \CGG{} windows where you want them to be and then use the Window pulldown and choose \emph{Save layout}. Note the words \emph{Save layout} highlighted in Figure~\ref{fig:window_layouts}a with 4 names shown to the right and below of that highlight. 
+First, position your \CGG{} windows where you want them to be and then use the \textit{Window} pulldown and choose \emph{Save layout}. Note the words \emph{Save layout} highlighted in Figure~\ref{fig:window_layouts}a with 4 names shown to the right and below of that highlight. 
 To use the default name of \textit{Layout \#}, when the popup comes up, just click the green checkmark OK on the Layout popup menu.  
 If you would like a specific name for your layout so you can remember what its best use case is,
 keyin 1-8 english characters that are meaningful to you (english characters mean you can not use the German umlaut, the French accent, or the Spanish ñ). 
@@ -450,14 +451,15 @@ To rename a currently existing layout, use the \emph{Save layout} option again o
 
 The files containing the coordinates for your layouts will automatically be saved in the \texttt{\$HOME/.bcast5} directory as \texttt{layout\#\_rc} or \texttt{layout\#\_8chars\_rc}.
 
-To use the desired layout, keyin the shortcut or use the Window pulldown and choose \emph{Load layout} and then make your choice. It is very beneficial to learn the shortcuts for your
-layouts because they can be executed from any of the 4 windows instead of just the main
+To use the desired layout, keyin the shortcut or use the \textit{Window} pulldown and choose \emph{Load layout} and then make your choice. It is very beneficial to 
+learn the the associated shortcut layouts (Ctrl+Shift+Fx where x is 1,2,3, or 4)
+because they can be executed from any of the 4 windows instead of just the main
 timeline window.
 
 \subsection{Multi-Pane Support}%
 \label{sub:multipane_support}
 
-The main \CGG{} edit window holds the Track Canvas which can be divided into 4 panes of track data: 1 or 2 vertical panes and/or 1 or 2 horizontal panes.  To split the track, use the Window pulldown, and then click on \textit{Split X} or \textit{Split Y} depending on how you wish to split the track.  Alternatively, the canvas pane types can be changed using keys \textit{<Ctrl-1>} for toggle split horizontal or \textit{<Ctrl-2>} for toggle split vertical.  Or the track can be split into panes by using the \textit{+ widget} in the lower right hand corner of the track canvas.  Once the track has been divided, you can use the + widget shortcut or the drag bars to change the size of the panes.
+The main \CGG{} edit window holds the Track Canvas which can be divided into 4 panes of track data: 1 or 2 vertical panes and/or 1 or 2 horizontal panes.  To split the track, use the \textit{Window} pulldown, and then click on \textit{Split X} or \textit{Split Y} depending on how you wish to split the track.  Alternatively, the canvas pane types can be changed using keys \textit{<Ctrl-1>} for toggle split horizontal or \textit{<Ctrl-2>} for toggle split vertical.  Or the track can be split into panes by using the \textit{+ widget} in the lower right hand corner of the track canvas.  Once the track has been divided, you can use the + widget shortcut or the drag bars to change the size of the panes.
 
 Multi-Pane, or split screen, allows you to look at the first part of a movie at the same time as a part that is a long ways away on the timeline which would have been off the screen.  By having multiple panes, you can see the 2 parts you want to look at simultaneously and drag/drop easily between the 2.  Also, the \textit{X pane split} is extremely convenient for laptop users and computer monitors with small screens since it can be used with horizontal scrolling with the mouse wheel + Ctrl.  The \textit{Y-pane split} makes it easy to see 2 simultaneous drag and drop zones when you have lots of tracks (figure~\ref{fig:multi-pane01}).
 
@@ -563,7 +565,8 @@ For the keyboards without a numeric keypad or if you prefer to use keys closer t
        Alt + p&=&reverse fast playback\\
 \end{tabular}
 \begin{minipage}{.45\linewidth}
-+ Shift key, results in the reverse of whether audio is included or not.
++ Shift key, single frame forward/reverse will include audio; all others
+will not include audio.
 \vspace{1ex}
 
 + Shift + Ctrl, results in the transport function operating only between the in/out pointers.
@@ -612,7 +615,7 @@ As you would expect, whenever the video is zoomed so that only part of the image
 in the window, scrollbars are automatically added as needed on the bottom, the right hand 
 side, or both.
 Other options include \emph{Reset camera} and \emph{Reset projector} which obviously are used
-to reset the camera and the projector
+to reset the camera and the projector (reference~\ref{sub:camera_and_projector}).
 The \emph{Hide controls/Show controls} option is great for hiding the left hand toolbar and
 bottom set of controls for a cleaner look. 
 
@@ -654,12 +657,12 @@ Once you have set the zoom to the desired size, use the vertical and horizontal
 As mentioned earlier, this
 variety of zoom only affects the video and not the resizing of the Compositor window.  After
 utilizing this slider bar for zooming around, you may want to switch back to \textit{Auto} 
-using the Controls on the bottom of the window.
+using the controls on the bottom of the window.
 This slider bar is also displayed
 when you click on the icons for \textit{Adjust camera automation} or \textit{Adjust projector automation}.  
 
 The Compositor window image in figure~\ref{fig:zoom_slider} shows the zoom slider bar with rectangular shaped slider about in the middle.  Note that the magnifying glass is enabled which
-automatically pops-up the slider and the Protect video from changes is disabled.  Also note that
+automatically pops-up the slider and the \textit{Protect video from changes} is disabled.  Also note that
 there is a scroll bar on the bottom and right side of the image since the image at this magnification
 does not fit in the window.
 The Controls zoom textbox shows $\times0.82$ size.  
@@ -698,17 +701,22 @@ subsequent section~\ref{sub:camera_and_projector}.
     \item[Crop a layer or output]  this is a cropping tool used to reduce the visible picture area.
 More detail for usage is provided in a 
 subsequent paragraph (\ref{sub:cropping}).  There is also a Crop \& Position plugin that provides
-a different set of capabilities~\ref{sub:crop_position}.
+a different set of capabilities described in~\ref{sub:crop_position}.
+    Enable \textit{Show tool info} to get the menu to popup if it does not come
+up automatically.
     \item[Get color / eyedropper]  brings up the eyedropper used to detect the color at a
 particular spot.  Enable the \textit{Show tool info} if the Color popup menu does not come up 
 automatically or if that menu was accidentally dismissed.  Click on a specific color in the video
 output with the LMB to see the selected color. You can then use that color's 
-value to be applied to some effects depending on how the effect handles the eyedropper.
+value to be applied to some effects depending on how the effect handles the eyedropper.  If you set the \textit{Radius} to a larger number, a square appears
+around the cross cursor and an average value of the color will be the result.
+If you \textit{Use maximum}, instead of an average value of the color, the result
+will be the maximum of all values within that square.
     \item[Show tool info]  this tool button is used in conjunction with the other tools on the
 compositor's toolbar. You only need to click on this if one of these tools popup menu does not
 come up or has been dismissed - Mask, Ruler, Camera, Projector, Crop, or Eyedropper tools.
 You can also use it when highlighted to dismiss the highlighted tool's dialog box.
-It is not needed for Protect video from changes, Zoom view, and Show safe regions since they have
+It is not needed for \textit{Protect video from changes}, \textit{Zoom view}, and \textit{Show safe regions} since they have
 no dialog popup menus.
 
 \begin{figure}[htpb]
@@ -770,7 +778,7 @@ cropped.
 The \textit{Track size} is used to define the temporary size with each track having a different size (viewports). It also serves to conform the input media to a chosen format (aspect ratio). So each track can have a different format (viewport).
 You can see or set the track size by RMB click on a track and then select \emph{Resize Track} to resize
 the track to any size. Or select \emph{Match output size} to make the track the same size as the
-output. Or from the Resources window, RMB on a video media and choose \textit{Info} and then \textit{Resize}. When a track is resized what it looks like on the compositor changes.  The relationship
+output. Or from the Resources window, RMB on a video media and choose \textit{Info} and then \textit{Resize}. When a track is resized then what it looks like on the compositor changes.  The relationship
 between the track and the project's output size makes it possible to magnify or reduce the size of
 a track in regards to the final output. This feature means you can create visual effects such as different aspect ratios, adjust split screens, zooms, and pans in the compositor.
 
@@ -1033,13 +1041,15 @@ The \textit{Enable} row of masks makes it so you can enable all or none of the m
 
 There are 4 shapes that are automatically available for usage as masks – square, circle, triangle, and oval.  In addition, the next 3 symbols in this section are for the purpose of loading, saving, and deleting your own customized shapes.  The first symbol, \textit{Load} preset, will bring up a list of your previously saved presets.  Clicking on \textit{Save} preset brings up a popup window allowing you to provide a name used to identify the preset you want to save, along with a pulldown to see the names of your other saved presets.   Clicking on \textit{Delete} preset also brings up a textbox with a pulldown to choose which one to delete.  There is a file, called \texttt{mask\_rc}, in \texttt{\$HOME/.bcast5} that records your custom masks.  
 
-When you click \textit{Load} preset, keep in mind that it will write the mask number that you have selected so if you already have a mask at that location, it will write over it – just \textit{Undo mask} under the main window Edit pulldown (shortcut `z') to revert to the previous if you made this mistake.
+When you click \textit{Load} preset, keep in mind that it will write the mask number that you have selected so if you already have a mask at that location, it will write over it – just \textit{Undo mask} under the main window \textit{Edit} pulldown (shortcut `z'or `Ctrl-z') to revert to the previous if you made this mistake.
 
 \subsubsection*{Position \& Scale section}%
 \label{ssub:position_scale_section}
 
 \textit{Center} mask button allows for quickly centering a mask on the video track. 
-\textit{Normalize} mask button makes it easy to normalize the size of the mask based on the scale of the video. 
+\textit{Normalize} mask button makes it easy to normalize the size of the mask based on the scale of the video - about 1/4 the window size in the X and Y 
+directions.  Normalization makes the mask fit in the space to avoid having
+it wander off of the window, then you can move it around easily before resizing.
 The next 3 symbols concern the direction to \textit{drag translate} a mask using the \texttt{Alt+LMB} thus making it easy to preserve the current $X$ or $Y$ value when desirable.  For some desktop window managers,
 such as \textit{UbuntuStudio 16.4} and \textit{Arch}, the Alt key is already in use by the Operating System
 so you will have to use Alt+Ctrl instead.
@@ -1067,7 +1077,7 @@ background colors are at a transparency value of zero. So the largest transparen
 \paragraph{Case 2, Negative Fade:} When the program computes the background color for any number of masks that includes negative
 mask(s), it uses the largest transparency number as the determining factor for the background. Only 1 of the masks can be largest, and wins for the background transparency result.
 
-\vspace{3ex}\textit{Feather}: works in a similar manner to a \textit{gradient Fade} aligned on the mask boundary but is a logical function instead of a mathematical function so will be faster.  The \textit{Gang feather} symbol also works in a similar fashion and is surrounded by a gold colored background when it is in effect.
+\vspace{3ex}\textit{Feather}: works in a similar manner to a \textit{gradient Fade} aligned on the mask boundary but is a logical function instead of a mathematical function so will be faster.  The \textit{Gang feather} symbol also works in a similar fashion and is surrounded by a colored background when it is in effect.
 
 \subsubsection*{Mask Points section}%
 \label{ssub:masks_points_section}
@@ -1096,7 +1106,7 @@ A \textit{gang} symbol on the right hand side of this section, tooltip of \texti
 
 The \textit{X:} and \textit{Y:} coordinates mark the value of the current \textit{Pivot Point} used for rotation, scaling, and translation.  You can either directly key in numerical values or use the tumblers to change the values as long as the \textit{Focus} checkbox is checked.
 
-The \textit{Focus} checkbox is used in case you want to set a different point in the Compositor for pivoting instead.  And the \textit{Gang} symbol for rotate/scale/translate means that these operations will be performed on all points of the enabled masks.  The gang symbol is surrounded by a gold colored background when it is in effect.  When performing a rotate operation on a mask with the mouse wheel, \textit{acceleration} is in effect -- this means the faster you wheel, the more space is covered so that you do not have to wheel dozens of time to make a full rotation.  Then when you wheel around slower, you can fine tune the result.
+The \textit{Focus} checkbox is used in case you want to set a different point in the Compositor for pivoting instead.  And the \textit{Gang} symbol for rotate/scale/translate means that these operations will be performed on all points of the enabled masks.  The gang symbol is surrounded by a colored background when it is in effect.  When performing a rotate operation on a mask with the mouse wheel, \textit{acceleration} is in effect -- this means the faster you wheel, the more space is covered so that you do not have to wheel dozens of time to make a full rotation.  Then when you wheel around slower, you can fine tune the result.
 Note that in order to be able to rotate/scale around pointer, the Focus checkbox must be unchecked.
 
 \subsubsection*{Other sections}%
@@ -1997,7 +2007,7 @@ This could affect performance on slower systems
 \label{sub:show_overlays}
 
 Color Coded Keyframe Curves are a big feature in the \textit{Show Overlays} window because by changing the colors to suit the user, it helps to remove confusion from multiple curves on the track canvas.  
-They can be viewed from the pulldown menu of \texttt{Window $\rightarrow$ Show overlays} but they will operate the same as when used from the View pulldown menu.  
+They can be viewed from the pulldown menu of \texttt{Window $\rightarrow$ Show overlays} but they will operate the same as when used from the \textit{View} pulldown menu.  
 The \textit{Color Coded Keyframe Curves} have distinct colors associated with each type for ease of identification.  
 By clicking LMB on the \textit{Color Ball} to the right of any keyframe type in the \textit{Show overlays} menu you have the ability to change the colors to whatever works best for your video.  
 The color ball changes made will be retained across sessions.
@@ -2027,7 +2037,7 @@ The slider is in the same color as the color coded keyframe type line which is t
 
 Overlays Window Nuances:
 
-The Overlays window is an alternative to the main track canvas View pulldown, and thus the order is mostly maintained to match each other.  
+The Overlays window is an alternative to the main track canvas \textit{View} pulldown, and thus the order is mostly maintained to match each other.  
 To make it easier to get a quick temporary look at a specific option, there is a shortcut of Shift-LMB (left mouse button) that can be used as opposed to having to uncheck everything that is currently checked and then having to recheck them on when done.  
 Here is a list of how they work.  Keep in mind that if the Expander on the patchbay is enabled, you still see the track.
 
@@ -2063,7 +2073,7 @@ Here is a list of how they work.  Keep in mind that if the Expander on the patch
 
 \begin{itemize}
     \item  Shift+LMB on a non-\textit{hot} spot will simply check or uncheck a box and there is no previous state.
-    \item This all works in conjunction with the View pulldown menu which, of course, has no hot spots.
+    \item This all works in conjunction with the \textit{View} pulldown menu which, of course, has no hot spots.
     \item  Caveat \#1 - Shift+LMB on the top 4 choices of Assets, Titles, Transitions, Plugin Keyframes will turn
         off all of the checkboxes below because it makes sense to do so.
     \item  Caveat \#2 - Shift+LMB on the Autos will not turn off Assets, Titles, Transitions, or Plugin Keyframes
@@ -2077,7 +2087,7 @@ Here is a list of how they work.  Keep in mind that if the Expander on the patch
 \subsection{Sound Level Meters Window}%
 \label{sub:sound_level_meters_window}
 
-An additional window, the levels window, can be brought up from the Window pulldown.  
+An additional window, the levels window, can be brought up from the \textit{Window} pulldown.  
 The levels window displays the output audio levels after all mixing is done.  
 The visible range of the sound level meters is configurable in \texttt{Settings $\rightarrow$ Preferences, Interface tab} under the Operations section.