Georgy addition of Context Help documentation; formatting by Andrea
[goodguy/cin-manual-latex.git] / parts / Introduction.tex
index 4939e72e4dff3c1da96a059a08467e8d2a40a6b8..a50836c3bf59439a4ba5272d891a93f3719e6029 100644 (file)
@@ -19,6 +19,8 @@ years.  William Morrow merged all of the known changes, whenever
 possible, into this \CGG{} version and has been adding numerous
 features, updates, and fixes.
 
+{\small NOTE: This manual is a Work in Progress: monthly parts are added to cover the new features introduced in \CGG{}. The texts are continuously revised to make them clearer and more complete. In order to have a better and better product we rely on the suggestions and criticisms of our readers. Do not hesitate to let us know your opinions. For this continuous variability, we recommend that you download the manual at least once a month, during the release of \CGG{}, so that its content is always up to date.}
+
 The \CGG{} software is under
 \href{https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html}{GPLv2+}
 license. A notice of this is included in the software and shown here.
@@ -54,6 +56,12 @@ the \emph{current state} of Linux software, enhanced with additional
 imagined by dedicated users and then implemented by professional
 programmers.
 
+\textit{Context Help} when using \CGG{} accesses pages of the HTML
+version of this manual when requested.  A relevant section of the manual
+can be quickly recalled in the user's configured web browser window by
+pointing with the mouse on the GUI item of interest and pressing the
+hotkey Alt/h. For more detailed information see \ref{sec:help_context_help}.
+
 \begin{description}
     \item[Website] \href{https://www.cinelerra-gg.org}{https://www.cinelerra-gg.org}\\
         The website for the cinelerra-gg software is a good place to start for information, help, and documentation.
@@ -84,6 +92,7 @@ programmers.
                 and recently released AV1 and WebP
             \item raw image format for over 700 supported cameras, courtesy Dave Coffin's DCraw
         \end{itemize}
+
         \item[Standard Features]~\\
             \begin{itemize}
                 \item Program window for video and audio tracks, navigation, popups, playing and seeking functions.
@@ -105,6 +114,7 @@ programmers.
                 \item Numerous pre-defined output formats automatically available and allowance for user-defined formats.
                 \item Capture and Recording capability to include Broadcast TV recording, editing, and viewing.
                 \item Hundreds of Shortcuts are defined which are easily viewed using the shell commands pulldown.
+               \item Context Help in the program for numerous window, menu, GUI elements, buttons, and other items via the user's configured web browser.
                 \item PorterDuff operations are available in the patchbay of the main timeline window for alpha blending.
                 \item Color correction + 8-bit and 10-bit color space.
                 \item Up to 8K video supported.
@@ -122,7 +132,7 @@ programmers.
             \item[Innovative New Features]~\\
                 \begin{itemize}
                     \item Inter-View mode as invented through a collaborative effort by a user and the developer.
-                    \item Proxy settings for large formatted media with the coveted Scalar option and proxy quick switch.
+                    \item Proxy settings for large formatted media with the coveted Scalar option and proxy quick switch.  Includes a 1:1 proxy setting used to save CPU time with a reduced bitrate.
                     \item Multiple cameras / Mixer Viewer with the number of cameras only limited by the resources on the user’s computer (on a large system, 50 are known to work).
                     \item Audio/Video sync via waveforms, or timecodes to include syncing with externally recorded audio.
                     \item DVD/bluray creation, editing, and copying for non-commercial media greatly enhanced for usability.
@@ -160,12 +170,11 @@ And which chapters are important for beginning to learn to use \CGG{}. At the en
 
     \item[Chapter~\ref{cha:load_save_and_the_EDL}] \nameref{cha:load_save_and_the_EDL}.
 
+               The EDL is the list of changes that \CGG{} would make to the original media in order to produce the desired output
         Since this is important to not losing your work, you should read this chapter for some basic usage concepts and for some lesser used functions that may come in handy.
         Besides how to Load and Save files, there is also information on using raw camera formats.
-        Helpful hints on working with image sequences, such as a bunch of pictures from your camera all loaded at once, is a time saver. Understanding that the EDL is the list of changes that
-would be made to the original media in order to produce the desired output is key to ensuring
-that that media remains intact.
-
+        Helpful hints on working with image sequences, such as a bunch of pictures from your camera all loaded at once, is a time saver. Understanding that the EDL is the list of changes that would be made to the original media in order to produce the desired output is key to ensuring that that media remains intact.
+        
     \item[Chapter~\ref{cha:editing}] \nameref{cha:editing}.
 
         New and occasional users will find it necessary to read this chapter. However, you can decide which editing mode you prefer and concentrate on reading that section.
@@ -236,7 +245,7 @@ that that media remains intact.
 
     \item[Chapter~\ref{cha:troubleshooting_help}] \nameref{cha:troubleshooting_help}.
 
-        Use this chapter for diagnosing a problem and find out what to report to get the best resolution or help.
+        Use this chapter for diagnosing a problem and find out what to report to get the best resolution or help.  Context Help, using Alt/h, is explained here.
 
     \item[Chapter~\ref{cha:performance_tips}]  \nameref{cha:performance_tips}.