added Andrea_Paz Plugins corrections; added status of translation files
[goodguy/cin-manual-latex.git] / parts / Windows.tex
index 7c9433b8c64cd577c335ee999b1b0f36f5202366..95b98b27653bab3d80c05a728e0db78dda95f14b 100644 (file)
 \section{Program Window}%
 \label{sec:program_window}
 
-The main window is called the Program window and contains the timeline as well as the entry point for all menu driven operations.  
-It is often just called the \textit{timeline}.  
-The timeline consists of a vertical stack of tracks with a horizontal representation of time. 
-This defines the output of rendering operations and what is saved when you save files. 
-To the left of the timeline is the patchbay which contains options affecting each track.  
-The patchbay is described in detail in the Editing section (\ref{sec:patchbay}).
-
-The \textit{Window} pulldown on this main window contains options that affect the 4 main windows. 
-Default positions repositions all the windows to a 4 screen editing configuration.
-On dual headed displays,
-the Default positions operation fills only one monitor with windows.
+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.
+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 the Editing section (\ref{sec:patchbay}).
+
+The \textit{Window} pulldown on the main window contains options that affect the 4 main windows. The first 3 options are used to display each of the windows in case one is accidentally closed.  You can
+move or resize the windows as needed, save that particular layout, and revert to the default positions
+to reposition all 4 windows to the original screen configuration.
+On dual headed displays, the \textit{Default positions} operation only uses the one monitor to display the windows, but as you
+can see in the \textit{Window} pulldown you have more options to change that. Usage with dual monitors is
+explained in \ref{sec:multiscreen_playback_configuration}.
 
 \subsection{Video and Audio Tracks and Navigation}%
 \label{sub:video_and_audio_tracks_and_navigation}
 
-The program window (figure~\ref{fig:pathbay})   contains many features for navigation and displays the timeline as it is structured in memory: tracks stacked vertically and extending across time horizontally. 
-The horizontal scroll bar allows you to scan across time. 
-The vertical scroll bar allows you to scan across tracks.
+The \textit{Program} window (figure~\ref{fig:patchbay}) has many features for navigation and displays the timeline as it is structured in memory. The tracks are stacked vertically with horizontal movement over time.
+There is a vertical scroll bar which allows for moving across tracks and a horizontal scroll bar for scanning across time. 
 
 \begin{figure}[htpb]
     \centering
-    \includegraphics[width=0.8\linewidth]{images/pathbay.png}
-    \caption{Patchbay  | Timeline with pulldowns \& navigation icons, Video/Audio tracks \& bottom Zoom}
-    \label{fig:pathbay}
+    \includegraphics[width=0.8\linewidth]{images/patchbay.png}
+    \caption{Patchbay  | Timeline with pulldowns, navigation icons, Video/Audio tracks | bottom Zoom Panel}
+    \label{fig:patchbay}
 \end{figure}
 
+Video tracks represent the duration of your media, just as if you placed old-fashioned rolls of photographic
+film one right after the other on a table.
+Individual images that are drawn on each track are snapshots of what is located at that place on the timeline.
 
-Video tracks represent the duration of your videos and clips, just as if you placed real photographic film stock end-to-end on a table. 
-The individual images you see on the track are samples of what is located at that particular instant on the timeline.
+Audio tracks represent the sound media as an audio waveform, or if you change a preference setting, a rectified audio waveform. 
+This too looks like old-fashioned digital magnetic tape laid out horizontally across a table.
+Using the \textit{Zoom Panel} controls at the bottom of the timeline,
+you can adjust the horizontal and vertical size of the video and audio waveform displays.
+Each track on the timeline has a set of attributes on its left side in the patchbay which is used to 
+control some options of that particular track. 
 
-Audio tracks represent your sound media as an audio waveform. 
-Following the film analogy, it would be as if you \textit{viewed} magnetic tape horizontally on your table. 
-You can adjust the horizontal and vertical magnification of the tracks and the magnification of the audio \textit{waveform} display using the zoom panel controls. 
-Every track on the timeline has a set of attributes on the left, called the patch-bay. 
-It is used to control some of the behavior of the tracks.
+Track Navigation is performed by selecting a video or audio track and moving to a certain time in the track. 
+Use the vertical scroll bar to scan across tracks, or even easier you can use the mouse wheel. 
+And use the horizontal scroll bar to scan across time, or again even easier, you can use the mouse wheel with the Ctrl key.  
 
-Track Navigation involves both selecting a specific audio or video track and moving to a certain time in the track. 
-The vertical scroll bar allows you to scan across tracks. 
-For vertical scrolling you can also use the mouse wheel. 
-The horizontal scroll bar allows you to scan across time. For horizontal scrolling you can use the mouse wheel with the Ctrl key.  
-
-In addition to the graphical tools, you can use the keyboard to navigate.  
-There is a shortcuts document for keyboard navigation (\ref{sub:main_menu_keys}); it includes, for example, shortcuts like use the \texttt{Home} and \texttt{End} keys to instantly go to the beginning or end of the timeline.  
-Or in the default cut and paste mode, hold down \texttt{Shift} while pressing \texttt{Home} or \texttt{End} in order to select the region of the timeline between the insertion point and the key pressed.
+Once you have become familiar with many of the graphical tools and pulldowns, you can switch to using more of
+the keyboard to navigate.  Many of the key equivalences are listed in each of the pulldowns to the right of the option
+ as a shortcut. All of the shortcuts are listed in a document for keyboard 
+navigation (\ref{sub:main_menu_keys}). This includes, for example, shortcuts like the \texttt{Home} and \texttt{End} keys to go to the beginning or end of the timeline.  
+Another example is in the default cut and paste mode, hold down \texttt{Shift} while pressing \texttt{Home} or \texttt{End} in order to select the region of the timeline between the insertion point and the key pressed.
 
 \subsection{Zoom Panel}%
 \label{sub:zoom_panel}
 
-Below the timeline, you will find the zoom panel. 
-The zoom panel contains values for sample zoom (duration visible on the timeline), amplitude (audio waveform scale), track zoom (height of tracks in the timeline), and curve zoom (automation range). 
-In addition to the scrollbars, these zooms are the main tools for positioning the timeline.  
-Also on the zoom panel is selection change and alpha slider.
+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.  
+In order of appearance in the zoom panel as rectangular boxes and either tumbler arrows or a up/down arrow, this next list shows each option along with its tooltip description if available.
+Then more details are provided in the next paragraphs.
 
-\begin{figure}[htpb]
-    \centering
-    \includegraphics[width=0.99\linewidth]{images/zoompanel.png}
-    \caption{Zoom panel on the bottom of the main program window}
-    \label{fig:zoompanel}
-\end{figure}
+\vspace{2ex}
+\begin{tabular}{ l  l }
+   \hline
+       Sample zoom & Duration visible on the timeline \\
+       Amplitude & Audio waveform scale \\
+       Track zoom & Height of tracks in the timeline \\
+         (type) & Automation Type \\
+       Curve zoom & Automation range minimum and maximum \\
+       Selection change & 3 boxes with starting point, length, and ending point \\
+       Alpha slider & Slider bar to control alpha value for colored assets \\
+   \hline
+\end{tabular}
 
-Changing the \emph{sample zoom} causes the unit of time displayed in the timeline to change size. 
-It allows you to view your media all the way from individual frames to the entire length of your project. 
-The higher the setting, the more frames you can see per screen. 
-The sample zoom value is not an absolute reference for the unit of time since it refers to the duration visible on the timeline and thus changes also as you modify the length of the program window horizontally.
-Use the $\uparrow$ and $\downarrow$ arrows to change the sample zoom by a power of two. 
-Or if your mouse has a wheel, mouse over the tumblers and use the wheel to zoom in and out.
+Changing the \emph{sample zoom} changes the amount of time displayed on the timeline 
+so you can see your media as individual frames or as the entire length of your media. 
+To see more frames, use a higher setting. 
+The sample zoom value is not an absolute time reference because it refers to the duration visible on the timeline. It will change as you modify the length of the program window horizontally.
+You can either use the $\uparrow$ and $\downarrow$ arrows to change the sample zoom by a power of two, or use the mouse wheel on the tumblers to zoom in and out.
 
 
-The \emph{amplitude} only affects audio which determines how large the waveform appears. \texttt{Ctrl-$\uparrow$} and \texttt{Ctrl-$\downarrow$} cause the amplitude zoom to change.
+The next option is \emph{amplitude} and it only affects the audio waveform size. \texttt{Ctrl-$\uparrow$} and \texttt{Ctrl-$\downarrow$} are shortcuts used to change the amplitude zoom as an alternative to the down arrow to the right of the numerical size.
 
-The \emph{track zoom} affects all tracks. 
-It determines the height of each track. 
-If you change the track zoom, the amplitude zoom compensates so that the audio waveforms look proportional. 
-\texttt{Ctrl-Pgup} and \texttt{Ctrl-Pgdown} cause the track zoom to change.
+The \emph{track zoom} affects all tracks and determines the height of each track
+If you change the track zoom, the amplitude zoom will be changed also so that the audio waveforms
+are proportionally sized.
+Shortcuts, \texttt{Ctrl-Pgup} and \texttt{Ctrl-Pgdown}, change the track zoom.
 
-The \emph{curve zoom} affects the curves in all the tracks of the same type. 
-It determines the value range for curves. 
-First select the automation type (audio fade, video fade, zoom, X,Y) then use the left tumblers for the minimum value and the right tumblers for the maximum value or manually enter the values in the text box. 
-Normally you will use -40.0 to 6.0 for audio fade and 0.0 to 100.0 for video fade. 
-The tumblers change curve amplitude, but the only way to curve offset is to use the fit curves button.
+\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.  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. 
+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} display the current selected timeline values.  
+The \emph{selection start time}, \emph{selection length}, and \emph{selection end time} 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} 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.
 
+There are 3 additional pieces of information in the line immediately below the \textit{zoom panel}.
+In the lower left hand corner there could be messages such as "Welcome to Cinelerra" when there is no 
+need to display a red-colored error message or a line that reads "Rendering took H:MM:SS" after a render
+has just been completed. Or when working with an auto, a small square the color of that auto line, will be
+present along with its keyframe type, location on the timeline, and its current value.  This is simply
+for easy recognition of what is being worked. The second piece of helpful information is all the way to
+the right which is a long rectangular box indicating the percentage completion of a render. Finally
+there is an X with the tooltip of "Cancel operation" used to stop an ongoing render
+(the cancel operation may seem slow due to the amount of data still in the buffer upon cancellation).
+
 \subsection{Track Popup Menu}%
 \label{sub:track_popup_menu}
 
@@ -107,19 +128,20 @@ 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 selected track one step up in the stack.
-    \item[Move down]  moves the selected track one step down in the stack.
+    \item[Move up] moves the selected track one step up in the stack of its corresponding type - audio or video.
+    \item[Move down]  moves the selected track one step down in the stack of its corresponding type - audio or video.
     \item[Delete track]  removes the track from the timeline.
-    \item[Add Track]  adds a track of the same media type, audio or video, as the one selected above that track.
+    \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]  that media file will be highlighted in the media folder in the Resources window.
     \item[Show edit]  will point out the exact start and stop points along with the length of the current edit on
-        that track as well as the media name.
+        that track as well as the media name, track name and number, and edit number.
     \item[User title]  is used to change the title name.  This is really handy for files that have very long and
         similar names that would get cut off during edits.  You can use short names to better differentiate the
-        media. If you select multiple, all those clips will have title name changed.
-    \item[Bar color]  allows the user to select a specific color for the title bar.  This helps ease of locating.
-    \item[Resize Track]  resizes the track.
-    \item[Match Output Size]  resizes the track to match the current output size.
+        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[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}
 
 
@@ -342,20 +364,21 @@ In this screencast (figure~\ref{fig:autocolor_assets_alpha}b), the alpha is set
 \subsection{More about Pulldowns}%
 \label{sub:more_about_pulldowns}
 
-The main window pulldowns are quite obvious in their meaning and usage, so here is only a summary.  
+The main window pulldowns as pointed out in figure~\ref{fig:insertion-points} are quite obvious in their meaning and usage, so here is only a summary.  
+
 %TODO Figure 3 shows an example of the pulldowns as displayed in the main window.Appearance
 
 
 \begin{description}
     \item[File]  options for loading, saving, and rendering as described in other sections (\ref{cha:load_save_and_the_EDL}).
-    \item[Edit]  edit functions; most of which have shortcuts that you will quickly learn.
+    \item[Edit]  edit functions; most of which have shortcuts that you will quickly learn (\ref{cha:editing}).
     \item[Keyframes]  keyframe options which are described in the Keyframe section (\ref{cha:keyframes}).
     \item[Audio]  audio related functions such as \textit{Add track}, \textit{Attach transition/effect}.
     \item[Video]  video functions such as \textit{Default/Attach transition}.
     \item[Tracks]  move or delete tracks are the most often used.
-    \item[Settings]  this is mostly described in other sections (\ref{cha:configuration_settings_preferences}).  
-        However, \textit{typeless keyframes} are not described anywhere else.  
-        They allow keyframes from any track to be pasted on either audio or video tracks.
+    \item[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.
     \item[View]  for display or modifying asset parameters and values to include Fade, Speed, and Cameras.
     \item[Window]  window manipulation functions.
 \end{description}
@@ -693,7 +716,7 @@ In the compositing window, there is a popup menu of options for the camera and p
     \item Start by shrinking the projector to $z=0,500$ ($\frac{1}{4}$ of the original frame).
     \item The next step is to switch to the camera and note that the green box has assumed the size of the projector, i.e. the red box. The value of $z$ of the camera is always equal to $1,000$ (default) but the frame is $\frac{1}{4}$ of the original frame, i.e. it has the size of the projector that has $z=0,500$. This is the current viewport size.
     \item You enlarge the room bringing $z=2,000$. You can see that the dimensions of the viewport (green box) do not change, remaining the same as those of the projector. However, the frame has been enlarged and this variation is indicated by the enlargement of the yellow box. Let's remember that this follows the changes made with the camera tool.
-    \item We can drag the room so that we can center the frame to our liking. The movement of the yellow box shows well the variation compared to the green box.
+    \item We can drag the room so that we can center the frame to our liking. The movement of the yellow box shows well the variation compared to the green box.
     \item Finally, if we want, we can switch to the projector tool to move the output frame to the position we want with respect to the size of the source. Of course, we can also work on the $z$, which in the example is at $z=0.500$, if we have decided to change the size of the output.
 \end{enumerate}
 
@@ -1202,6 +1225,8 @@ For Clips, \emph{Nest} and \emph{UnNest} as described elsewhere are available.
 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.
 
+\textit{Asset's interlacing}  is the type of interlacing the asset has: If the file is (H)DV type, recognition and configuration is done automatically. All other media types will be set unknown. So we have to manually set the interlacing \protect\footnote{From Igor ubuntu's mail}.
+
 Figure~\ref{fig:info_asset_details} shows the \textit{Detail} box to click on the left side and a simple, typical output in the Asset Detail window on the right side.  Also, note the highlighted media in the Resources window.
 
 \begin{figure}[htpb]