typo fix spotted by Andrew
[goodguy/cin-manual-latex.git] / parts / Windows.tex
index 8614b43b31a0ef71598ade1bbae928a72f2af494..760a69601ed98a7a7e6b384bd7f2aed42368dbf4 100644 (file)
     \label{fig:Fenstergrundposition-en}
 \end{figure}
 
-First it is important to know what an EDL is. When \CGG{} saves a file, it saves the EDL,
+First, it is important to know what an EDL is. When \CGG{} saves a file, it saves the EDL,
 Edit Decision List, of your project which contains all the settings and locations of edits
-and pointers to the media so that the media is not modified. The EDL is described in \nameref{sec:edl_edit_decision_list}.
+and pointers to the media so that the media is not modified. The EDL is described 
+in \nameref{sec:edl_edit_decision_list}.
+
+Second, for those users who would like to keep all 4 windows together for a better workflow,
+see \nameref{sec:focus_group}.
 
 \section{Program Window}%
 \label{sec:program_window}
 \index{program window}
 
-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.  
+The main window is called the \textit{Program} window and is often just referred to as the \textit{timeline} \index{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 \textit{File} pulldown, Save command.
 Immediately to the left of the timeline is the patchbay \index{patchbay}. The patchbay contains options that affect each track.  
@@ -136,7 +140,7 @@ without having to modify your Preference.
 
 \subsection{Zoom Panel}%
 \label{sub:zoom_panel}
-\index{zoom panel}
+\index{zoom!panel}
 
 Below the displayed tracks in the timeline, you will find the zoom panel as seen in figure~\ref{fig:patchbay}.
 In addition to the scrollbars, these options and their values are another set of tools for positioning the timeline.  
@@ -175,12 +179,12 @@ Shortcuts, \texttt{Ctrl-Pgup} and \texttt{Ctrl-Pgdown}, change the track zoom to
 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 (LMB) is pressed.  This is just an indicator to make it easy to see what is being worked.
  
-The \emph{curve zoom} \index{autos 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. 
+The \emph{curve zoom} \index{autos!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. 
 Good default values for audio fade are -40.0 to 6.0 and for video fade are 0.0 to 100.0. 
 The tumbler arrows change curve amplitude, but the only way to curve offset is to use the fit curves button on the curve itself.
 
-The \emph{selection start time}, \emph{selection length}, and \emph{selection end time} \index{timeline selection} display the current selected timeline values. When there is no selection, both the start and end time are the current
+The \emph{selection start time}, \emph{selection length}, and \emph{selection end time} \index{timeline!selection} display the current selected timeline values. When there is no selection, both the start and end time are the current
 position of the timeline and the selection length is 0.
 The \emph{alpha slider} \index{alpha slider} allows for varying the alpha value when using colors on the tracks as set in your \texttt{Preferences $\rightarrow$ Appearance} for \texttt{Autocolor assets}.  
 It has no function without that flag set.
@@ -197,7 +201,7 @@ there is an X with the tooltip of "Cancel operation" \index{cancel operation} us
 
 \subsection{Track Popup Menu}%
 \label{sub:track_popup_menu}
-\index{track popup menu}
+\index{track!popup menu}
 
 Each Track has a popup menu. 
 To activate the track popup menu, Right mouse click (RMB) on the track. 
@@ -293,6 +297,13 @@ There are numerous methods to cut and paste in \emph{drag and drop mode} by sett
 a selected region or using the Copy/Paste Behavior as outlined in~\ref{sub:copy_paste_behavior}. 
 In this mode, clicking the LMB in the timeline does not reposition the \textit{Insertion Point}. 
 
+\begin{figure}[htpb]
+       \centering
+       \includegraphics[width=0.4\linewidth]{i-beam.png}
+       \caption{I-beam + in/out  +  labels}
+       \label{fig:i-beam}
+\end{figure}
+
 When the I-beam is highlighted, you are in \emph{cut and paste mode}.
 In cut and paste mode, clicking the LMB in the timeline does reposition the \textit{Insertion Point}. 
 Double clicking in the timeline selects the entire edit the cursor is over, i.e.\ that column. 
@@ -300,13 +311,6 @@ Dragging in the timeline with the LMB pressed down, highlights a selected region
 and paste operations.  It is also the playback range used for the subsequent playback operation. 
 Holding down the Shift key while clicking in the timeline extends the highlighted region.
 
-\begin{figure}[htpb]
-    \centering
-    \includegraphics[width=0.4\linewidth]{i-beam.png}
-    \caption{I-beam + in/out  +  labels}
-    \label{fig:i-beam}
-\end{figure}
-
 \subsection{In/Out Points}%
 \label{sub:in_out_points}
 \index{in/out point}
@@ -355,6 +359,12 @@ Some of the useful operations concerning the In/Out pointers are listed next.
     \item[Ctrl-t]  clears both In/Out points
 \end{description}
 
+\subsection{Guide on timeline}%
+\label{sub:guide_timeline}
+\index{guide lines}
+
+It can be useful to have visual reference points on the timeline to help you position edits relative to other tracks. For example in manual synchronization of audio and video. You can set two points on the timeline with In/Out points or by selecting a range in Cut and Paste mode. Now we use \texttt{Settings $\rightarrow$ Loop Playback} (Shift - L) to make two vertical green lines appear at the edges of the selection. Originally this function is used to limit the playback within this range, but we can take advantage of the fact that the green lines remain even when we move the insertion point or delete the In/Out points or deselect the range. So they can be used as a visual reference when we want to move the edits precisely. To delete these guides press \textit{Shift-L} again.
+
 \subsection{Labels}%
 \label{sub:labels}
 \index{label}
@@ -421,7 +431,7 @@ disable the \emph{Edit labels} option under the \textit{Settings} pulldown.
 \subsection{Color Title Bars and Assets}%
 \label{sub:color_title_bars_and_assets}
 \index{bar color}
-\index{asset color}
+\index{asset!color}
 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.
@@ -483,13 +493,13 @@ The main window pulldowns as pointed out in figure~\ref{fig:insertion-points} ar
 \begin{description}
     \item[File] \index{file} options for loading, saving, and rendering as described in other sections (\ref{cha:load_save_and_the_EDL}).
     \item[Edit] \index{edit} edit functions; most of which have shortcuts that you will quickly learn (\ref{cha:editing}).
-    \item[Keyframes] \index{keyframes} keyframe options which are described in the Keyframe section (\ref{cha:keyframes}).
+    \item[Keyframes] keyframe options which are described in the Keyframe section (\ref{cha:keyframes}).
     \item[Audio] \index{audio} audio functions such as \textit{Add track}, \textit{Attach effect}
 and \textit{Attach transition}.  The \textit{Attach effect} is especially useful when
 you need the effect to be applied to all related audio tracks as a \textit{Shared effect}
 and is described as an alternative method of application in section \ref{sec:shared_effect_tracks}.
     \item[Video] \index{video} video functions such as \textit{Add track, Default/Attach transition, Render effect}.
-    \item[Tracks] \index{tracks} move or delete tracks are the most often used plus \textit{Align Timecodes}.
+    \item[Tracks] \index{track} move or delete tracks are the most often used plus \textit{Align Timecodes}.
     \item[Settings] \index{settings} much of this is described elsewhere with the most frequently used to include
 Preferences (\ref{cha:configuration_settings_preferences}), Format (\ref{cha:project_and_media_attributes}), 
 Proxy and Transcode (\ref{sec:proxy_settings}), as well as the others.
@@ -500,7 +510,7 @@ Proxy and Transcode (\ref{sec:proxy_settings}), as well as the others.
 
 \subsection{Window Layouts}%
 \label{sub:window_layouts}
- \index{window layout}
+ \index{window!layout}
 
 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 \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. 
@@ -518,7 +528,9 @@ To rename a currently existing layout, use the \emph{Save layout} option again o
         %TODO High res image replace
     \end{minipage}
     \begin{minipage}{.49\linewidth}
+%begin{latexonly}
         \vspace{13ex}
+%end{latexonly}
         \center{\includegraphics[width=1\linewidth]{window_layout2.png}}\\ b)
         %TODO Alpha channel
     \end{minipage}
@@ -612,7 +624,7 @@ Now you can clip/play/expand or edit the previous playback selection.
 
 \subsubsection*{Playback Speed Automation Support}%
 \label{ssub:playback_speed_automation_support}
- \index{autos speed}
+ \index{autos!speed}
 
 The speed automation causes the playback sampling rate to increase or decrease to a period controlled by the speed automation curve.  
 This can make playback speed-up or slow-down according to the scaled sampling rate, as \textit{time is multiplied by speed} (Speed $\times$ Unit\_rate). For more information on changing
@@ -654,7 +666,7 @@ will not include audio.
 
 \section{Compositor Window}%
 \label{sec:compositor_window}
- \index{compositor window}
+ \index{compositor!window}
 
 \begin{figure}[htpb]
     \centering
@@ -676,7 +688,7 @@ in more detail in the following sections.
 
 \subsection{Compositor Controls}%
 \label{sub:compositor_controls}
-\index{compositor controls}
+\index{compositor!controls}
 
 On the bottom of the window, there are many
 of the same transport buttons \index{transport buttons} and controls that are available in the Program window.
@@ -685,13 +697,13 @@ when you mouse over each of the icons so their use is fairly obvious.  However,
 of particular note is the button \textit{Click to play} \index{click to play} which is described in~\ref{sub:click_to_play_in_viewer_and_compositor}.  Next is the \textit{Videoscope} \index{videoscope} button which is used to enable the scopes window
 without having to apply the filter to the tracks/edits.
 
-Next to all of these controls all the way to the right side, there is a \textit{zoom menu} \index{zoom menu} and a \textit{tally light}.  The \textit{zoom menu} has a pulldown with different settings that you can choose from
+Next to all of these controls all the way to the right side, there is a \textit{zoom menu} \index{zoom!menu} and a \textit{tally light}.  The \textit{zoom menu} has a pulldown with different settings that you can choose from
 or you can just use the tumbler arrows to the right. Generally when just getting started, you
 will be using the default \textit{Auto} option.  The window size is not changed, but rather
 the size of the video itself. In addition there are many shortcuts for zooming that you
 will find in the Shortcuts chapter (\ref{cha:shortcuts}).
 
-Using a RMB click in the compositor window brings up a menu with several options \index{compositor RMB options}.  One of these
+Using a RMB click in the compositor window brings up a menu with several options \index{compositor!RMB options}.  One of these
 is \emph{Resize Window} which allows for resizing the entire window instead of just the video
 and if you highlight that, you can choose from several variations for the window size. 
 Other available options include self-explanatory ones of \emph{Fullscreen} with "f" as a toggle
@@ -709,7 +721,7 @@ bottom set of controls for a cleaner look.
 
 Next to the zoom tumbler arrows, is a \textit{tally light} that will be filled in with some color
 (often red or blue) when a rendering operation
-is taking place \index{render operation light}. This is especially helpful when loading a very large video so you know
+is taking place \index{rendering!operation light}. This is especially helpful when loading a very large video so you know
 when it is finished loading.  You should pay attention to this \textit{tally light} when performing
 a particularly time-consuming operation so that you do not keep executing more operations
 that just have to wait until completion of that CPU intensive operation.  Also, you should look
@@ -721,7 +733,7 @@ be accomplished with the bottom and right hand side scroll bars when displayed.
 
 \subsection{Compositor Toolbar}%
 \label{sub:compositor_toolbar}
-\index{compositor toolbar}
+\index{compositor!toolbar}
 
 On the left hand side of the Compositor window, there is a toolbar with several icons that
 provide functions for viewing and compositing the video. Each of these operational features 
@@ -733,7 +745,7 @@ compositor output when clicking on the Compositor window. It allows for using th
 to prevent an accidental click from making unwanted changes. When you enable this option, any
 of the other enabled tools will automatically be disabled.
 
-     \item[Zoom view / magnifying glass] \index{zoom slider} when enabled, the \textit{Zoom view} immediately results
+     \item[Zoom view / magnifying glass] \index{zoom!slider} when enabled, the \textit{Zoom view} immediately results
 in the addition of a zoom slider for fine viewing.  
 The vertically oriented \textit{zoom slider} will be displayed underneath the last icon of the toolbar and extends
 to almost the end of the toolbar.
@@ -865,7 +877,7 @@ cropped.
 
 \subsubsection*{Track and Output size}%
 \label{ssub:track_size}
-\index{track size}
+\index{track!size}
 \index{output size}
 
 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).
@@ -1032,7 +1044,7 @@ In the \textit{Curve type} section we can choose between various interpolation a
        \item[bump:] has 2 values, one viewed from the left/right, discontinuous.
 \end{description}
 
-In the \textit{Keyframe} \index{keyframes} section we can create new keyframes and set them as Bump autos (\textit{Right/Left edges} and \textit{Span} buttons). For further details see \nameref{sec:bump_autos}.
+In the \textit{Keyframe} section we can create new keyframes and set them as Bump autos (\textit{Right/Left edges} and \textit{Span} buttons). For further details see \nameref{sec:bump_autos}.
 
 \subsubsection*{Reset to Default}%
 \label{ssub:reset_default}
@@ -1344,7 +1356,7 @@ click on the \emph{Apply} button in the menu to actually perform the crop operat
 
 \section{Viewer Window}%
 \label{sec:viewer_window}
-\index{viewer window}
+\index{viewer!window}
 
 The Viewer window (figure~\ref{fig:viewer_window}) is convenient for previewing your media and 
 clips. It can also be used for editing with cuts and then paste operations into the timeline or
@@ -1373,7 +1385,7 @@ Note that you can have multiple Viewer windows open with different or even the s
 After the media is loaded you can use the transport buttons to play, rewind, stop, and so on, or
 for fast previewing drag with the LMB anywhere on the timebar slider.  There is also the Videoscope \index{videoscope}
 button which is to used to enable the scopes window without having to apply the filter to the tracks/edits.
-A few more options available in the Viewer window can be accessed with a RMB click on the display \index{viewer RMB options}.
+A few more options available in the Viewer window can be accessed with a RMB click on the display \index{viewer!RMB options}.
 These functions are listed next.
 
 \begin{enumerate}
@@ -1539,7 +1551,7 @@ As you type in characters a match is made with that substring.
 Names that do not match are filtered out making it a lot easier to find the item you are looking for.  
 The characters can be any where within the phrase and it does not matter if upper or lower case. 
 
-Other options you will see if you \textit{right mouse click in the folder} which brings up the menu are described next \index{folders contents RMB options}.  
+Other options you will see if you \textit{right mouse click in the folder} which brings up the menu are described next \index{folders!RMB options}.  
 
 \begin{description}
     \item[ Load files ]  for convenience to load files same as from the main window so you do not have to move the mouse so far in case you have multiple monitors.
@@ -1552,11 +1564,11 @@ Other options you will see if you \textit{right mouse click in the folder} which
     \item[Snapshot/Grabshot]  use to take a quick snapshot or to grab a specific area on the screen.  These functions are described in detail in section \ref{sub:snapshot_grabshot}).
 \end{description}
 
-Using the right mouse click to bring up a menu in the folder area \index{folders RMB options}, you can also switch from Display text to Display icons, Sort items and create, delete and manipulate user defined folders/bins. Select Folder to create a user Folder or modify an existing folder.
+Using the right mouse click to bring up a menu in the folder area \index{folders!RMB options}, you can also switch from Display text to Display icons, Sort items and create, delete and manipulate user defined folders/bins. Select Folder to create a user Folder or modify an existing folder.
 
 If you \textit{right mouse click on a highlighted/selected resource}, several options are available depending on whether the resource is an effect or transition or a piece of media.  
 You can highlight several for some options so that it is applicable to all of them, such as Info.  
-Those listed immediately below are the available choices for media assets \index{asset RMB options}.
+Those listed immediately below are the available choices for media assets \index{asset!RMB options}.
 
 
 \begin{description}
@@ -1577,12 +1589,12 @@ Those listed immediately below are the available choices for media assets \index
 \end{description}
 
 In the case of Effects or Transitions \index{effects/transitions info}, a right mouse click on a highlighted selection leads to an \emph{Info} button which gives a short 1 line description of what the effect/transition can be used for.
-For Labels \index{label RMB options}, choices are \emph{Edit}, \emph{Label}, and \emph{Go to}.
-For Clips \index{clip RMB options}, \emph{Nest} and \emph{UnNest} as described elsewhere are available.
+For Labels \index{label!RMB options}, choices are \emph{Edit}, \emph{Label}, and \emph{Go to}.
+For Clips \index{clip!RMB options}, \emph{Nest} and \emph{UnNest} as described elsewhere are available.
 
 \subsection{Info Asset Details}%
 \label{sub:info_asset_details}
-\index{asset info}
+\index{asset!info}
 The asset \emph{Info} window also can be used to display detailed information about the selected/highlighted media file -- available for any loaded media of type mpeg or ffmpeg.  
 This is extremely helpful in determining what type of media it is, size, resolution, format, and type/number of audio streams.  It is especially useful for multiple program streams.  You can have the info window popped on several of your assets simultaneously.
 
@@ -1633,7 +1645,9 @@ Below are steps illustrating an easy way to set up a folder.
             \hfill
             \begin{minipage}{.37\linewidth}
                 \centering
+%begin{latexonly}
                 \vspace{18ex}
+%end{latexonly}
 
                 \includegraphics[width=0.9\linewidth]{folder_new.png}
                 \caption{Type in your folder name in the textbox.  Click OK.}
@@ -1852,8 +1866,8 @@ Or        &Time&  Around&2018/08/02 06:00:00 + 02:00:00  & files at 4AM to 8 AM\\\bottom
 
 \subsection{Vicons \& Aicons – aka Video Icons / Audio Icons}%
 \label{sub:vicons_aicons_aka_video_icons_audio_icons}
-\index{vicons : video icons}
-\index{aicons: audio icons}
+\index{vicon!video icons}
+\index{aicon!audio icons}
 
 Vicons are video icons.  
 Aicons are audio icons.  
@@ -2068,7 +2082,7 @@ A red circle reticle can be moved to the area to grab; use left mouse drag to su
 
 Transport controls are useful for navigation and for playing media.  
 Each of the Viewer, Compositor, and Program windows has its own transport panel.  
-The controls generally all contain a yellow colored tooltip when you mouse over the control, providing a hint of their function and shortcuts for usage.
+The controls generally all contain a colored tooltip when you mouse over the control, providing a hint of their function and shortcuts for usage.
 
 The transport panel is controlled by the keyboard as well as the graphical interface. 
 For each of the operations it performs, the starting position is the position of the insertion point in the Program window and the slider in the Compositor and Viewer windows.