Andreas's last index entries; some minor fixes from Phyllis; rename index.png to...

diff --git a/images/index-01.png b/images/index-01.png
new file mode 100644 (file)
index 0000000..5dff752
Binary files /dev/null and b/images/index-01.png differ

diff --git a/parts/Attributes.tex b/parts/Attributes.tex
index 7b13583c9cf993f72f54a7dfb53cf93d9f0c737e..5822280690b0acb80b68433a6aa8d5b30e939730 100644 (file)
--- a/parts/Attributes.tex
+++ b/parts/Attributes.tex
@@ -139,7 +139,7 @@ will be in non-square pixels.
 dialog always recalculates the Aspect ratio setting based upon the
 given Canvas size. This ensures pixels are always square.
 
 dialog always recalculates the Aspect ratio setting based upon the
 given Canvas size. This ensures pixels are always square.
 

-\item[Color model:] \index{color model} the internal color space of \CGG{} is X11 sRGB
+\item[Color model:] \index{color!model} the internal color space of \CGG{} is X11 sRGB

 without color profile. \CGG{} always switches to sRGB when applying
 filters or using the compositing engine. Different case for
 decoding/playback or encoding/output; the project will be stored in
 without color profile. \CGG{} always switches to sRGB when applying
 filters or using the compositing engine. Different case for
 decoding/playback or encoding/output; the project will be stored in

diff --git a/parts/AuxilaryPrograms.tex b/parts/AuxilaryPrograms.tex
index 6fee7a293dbb5e081e4735c6fa02944f050232bd..9ee23085a676f4fca414d89578aea1d506e0c37f 100644 (file)
--- a/parts/AuxilaryPrograms.tex
+++ b/parts/AuxilaryPrograms.tex
@@ -3,6 +3,7 @@
 
 \section{Using Ydiff to check results}
 \label{sec:ydiff_check_results}
 
 \section{Using Ydiff to check results}
 \label{sec:ydiff_check_results}

+\index{Ydiff}

 
 Delivered with Infinity \CGG{} and in the \CGG{} path, there is a file \texttt{ydiff.C} This program compares the output from 2 files to see the differences . Do: \texttt{cd cin\_path} and key in \texttt{make ydiff}.
 
 
 Delivered with Infinity \CGG{} and in the \CGG{} path, there is a file \texttt{ydiff.C} This program compares the output from 2 files to see the differences . Do: \texttt{cd cin\_path} and key in \texttt{make ydiff}.
 


@@ -57,6 +58,7 @@ Now render yourfile using different quality levels and run ydiff to compare the
 
 \section{Image Sequence Creation}
 \label{sec:image_sequence_creation}
 
 \section{Image Sequence Creation}
 \label{sec:image_sequence_creation}

+\index{image sequence}

 
 Example script to create a jpeglist sequence file is next:
 \begin{lstlisting}[numbers=none]
 
 Example script to create a jpeglist sequence file is next:
 \begin{lstlisting}[numbers=none]


@@ -174,6 +176,7 @@ number of \textit{threads} to use during encoding\\
 
 \section{Details about .bcast5 Files}
 \label{sec:details_.bcast5_files}
 
 \section{Details about .bcast5 Files}
 \label{sec:details_.bcast5_files}

+\index{.bcast5}

 
 The following extensions of files in \CGG{}'s \texttt{.bcast5} directory are explained below.
 
 
 The following extensions of files in \CGG{}'s \texttt{.bcast5} directory are explained below.
 

diff --git a/parts/Configuration.tex b/parts/Configuration.tex
index 3e192b9f14def0117969aef802cc587c3e6acd40..3843363975b5240cf2121639f1f409a76a0f093d 100644 (file)
--- a/parts/Configuration.tex
+++ b/parts/Configuration.tex
@@ -218,7 +218,7 @@ In the Render Farm Section are many options that are explained in detail in the
     \item[Android Remote Control] check this to enable using an android device as a remote control for broradcast TV.
     \item[Port] default port 23432 is used for the android remote control.
     \item[Pin] default PIN Cinelerra is used for the android remote control.
     \item[Android Remote Control] check this to enable using an android device as a remote control for broradcast TV.
     \item[Port] default port 23432 is used for the android remote control.
     \item[Pin] default PIN Cinelerra is used for the android remote control.

-    \item[Shell Commands] \index{shel commands} this button brings up the controls for setting up your own shell commands or editing previously set up commands.  See the section on Menu Bar Shell Commands for information.
+    \item[Shell Commands] \index{shell commands} this button brings up the controls for setting up your own shell commands or editing previously set up commands.  See the section on Menu Bar Shell Commands for information.

     \item[Reload plugin index] \index{plugins!reload index} execute this reload command when you have modified plugins and want to make sure your changes take effect.
     \item[Nested Proxy Path] \index{nested proxy path} designates the default directory path for Nested Proxy files.
     \item[Default LV2\_Path] \index{default lv2 path} when there is no system \texttt{LV2\_PATH} set, if you want lv2 plugins loaded, you must set the correct directory path name here. When you change this field, cin will automatically restart and load the newly specified lv2 plugins.
     \item[Reload plugin index] \index{plugins!reload index} execute this reload command when you have modified plugins and want to make sure your changes take effect.
     \item[Nested Proxy Path] \index{nested proxy path} designates the default directory path for Nested Proxy files.
     \item[Default LV2\_Path] \index{default lv2 path} when there is no system \texttt{LV2\_PATH} set, if you want lv2 plugins loaded, you must set the correct directory path name here. When you change this field, cin will automatically restart and load the newly specified lv2 plugins.


@@ -230,7 +230,7 @@ In the Render Farm Section are many options that are explained in detail in the
 Screencast below shows part of the Preferences menu where you can change the index files setup (figure~\ref{fig:index}).
 \begin{figure}[htpb]
     \centering
 Screencast below shows part of the Preferences menu where you can change the index files setup (figure~\ref{fig:index}).
 \begin{figure}[htpb]
     \centering

-    \includegraphics[width=1.0\linewidth]{images/index.png}
+    \includegraphics[width=1.0\linewidth]{images/index-01.png}

     \caption{Index file setup for your preferred configuration for Render Farm sharing or anything}
     \label{fig:index}
 \end{figure}
     \caption{Index file setup for your preferred configuration for Render Farm sharing or anything}
     \label{fig:index}
 \end{figure}


@@ -295,10 +295,10 @@ then in Preferences window, click on the \textit{Appearance} tab. In the Editing
 
 To create a personal theme see \hyperref[sec:how_create_theme]{How to create your own theme}.
 
 
 To create a personal theme see \hyperref[sec:how_create_theme]{How to create your own theme}.
 

-\paragraph{Plugin Icons} \index{plugins!icons} here are currently 4 choices for different plugin icons to include the old original.
+\paragraph{Plugin Icons} \index{plugins!icons} There are currently 4 choices for different plugin icons to include the old original.

 \paragraph{Locale} \index{locale/language} The default is \textit{sys} so that the system language is active. With the pulldown menu we can choose among the other languages present in ... This language will be saved in
 your Configuration and used each time you start up CinGG. In order to change the environment variable, LANGUAGE, the setting must be \textit{sys} because that is the best way we could get it working.
 \paragraph{Locale} \index{locale/language} The default is \textit{sys} so that the system language is active. With the pulldown menu we can choose among the other languages present in ... This language will be saved in
 your Configuration and used each time you start up CinGG. In order to change the environment variable, LANGUAGE, the setting must be \textit{sys} because that is the best way we could get it working.

-\paragraph{Layout Scale} \index{layout scale} allows for setting up scaling for your 4K monitors or any monitor where you would like the text and icons to be just a little bigger or a lot bigger. This scale setting is automatically saved across sessions. 
+\paragraph{Layout Scale} \index{layout scale} Allows for setting up scaling for your 4K monitors or any monitor where you would like the text and icons to be just a little bigger or a lot bigger. This scale setting is automatically saved across sessions. 

 When first using \CGG{}, or if \textit{Layout Scale} has never been set, the initial value is 0.0.
 This means an automatic probe of the biggest monitor in use will be used for the setting. The advantage of this is that "new users" with a 4K monitor will not immediately be discouraged with too small text/icons.
 Leaving it at 0 instead of 1 is what most people will do and is probably preferable so that if you move to a different monitor with different dimensions/resolution, it will automatically probe. 
 When first using \CGG{}, or if \textit{Layout Scale} has never been set, the initial value is 0.0.
 This means an automatic probe of the biggest monitor in use will be used for the setting. The advantage of this is that "new users" with a 4K monitor will not immediately be discouraged with too small text/icons.
 Leaving it at 0 instead of 1 is what most people will do and is probably preferable so that if you move to a different monitor with different dimensions/resolution, it will automatically probe. 


@@ -318,9 +318,9 @@ and then when you get back into \CGG{}, fix \textit{Layout Scale} value in Prefe
 \begin{lstlisting}[numbers=none]
         BC_SCALE=1.0 {your Cinelerra path}/bin/cin
 \end{lstlisting}
 \begin{lstlisting}[numbers=none]
         BC_SCALE=1.0 {your Cinelerra path}/bin/cin
 \end{lstlisting}

-\paragraph{View thumbnail size} \index{view thumbnais size} you can increase or decrease the thumbnail size -- larger size uses more cpu.
-\paragraph{Vicon quality} \index{vicon quality}  increase the quality used for thumbnails to get more clarity of pixels -- this will use more memory.
-\paragraph{Vicon color mode} \index{vicon color mode} modify the color mode to Low, Medium, or High for the thumbnails -- High will look the best but takes more memory.
+\paragraph{View thumbnail size} \index{view thumbnais size} You can increase or decrease the thumbnail size -- larger size uses more cpu.
+\paragraph{Vicon quality} \index{vicon quality}  Increase the quality used for thumbnails to get more clarity of pixels -- this will use more memory.
+\paragraph{Vicon color mode} \index{vicon color mode} Modify the color mode to Low, Medium, or High for the thumbnails -- High will look the best but takes more memory.

 
 \subsection{Time Format section}%
 \label{sub:time_format_section}
 
 \subsection{Time Format section}%
 \label{sub:time_format_section}


@@ -343,9 +343,9 @@ Various representations of time are given so that you can select the most conven
 \label{sub:color_section}
 
 
 \label{sub:color_section}
 
 

-\paragraph{Highlighting Inversion color} \index{inverted colors} modify the selection area color; default is \textit{ffffff} which is white. When you make a selection, that area becomes an inverse image which by default becomes a whitish color.  You can set it to a different color by modifying the hex value in the box next to \textit{Highlight inversion color}.   Keep in mind that if you set the value to a low value, you will not be able to see the outlined selected area (for example the hex value "f" is not readily visible and leads to confusion).  A leading 0 or blank is not allowed and will be automatically changed to \textit{ffffff}.
+\paragraph{Highlighting Inversion color} \index{inverted colors} Modify the selection area color; default is \textit{ffffff} which is white. When you make a selection, that area becomes an inverse image which by default becomes a whitish color.  You can set it to a different color by modifying the hex value in the box next to \textit{Highlight inversion color}.   Keep in mind that if you set the value to a low value, you will not be able to see the outlined selected area (for example the hex value "f" is not readily visible and leads to confusion).  A leading 0 or blank is not allowed and will be automatically changed to \textit{ffffff}.

 \paragraph{Composer BG Color} \index{background color} You can choose the background color of the viewer window.
 \paragraph{Composer BG Color} \index{background color} You can choose the background color of the viewer window.

-\paragraph{YUV color space} \index{yuv color space} default is \textit{BT601}; others \textit{BT709} (high definition), \textit{BT2020} (ultra high definition).
+\paragraph{YUV color space} \index{yuv color space} Default is \textit{BT601}; others \textit{BT709} (high definition), \textit{BT2020} (ultra high definition).

 \paragraph{YUV color range} \index{yuv color range} JPEG [$0-255$] and MPEG [$16-235$]
 
 
 \paragraph{YUV color range} \index{yuv color range} JPEG [$0-255$] and MPEG [$16-235$]
 
 

diff --git a/parts/DVD.tex b/parts/DVD.tex
index 2a9710118ad43abede26f187ad79b9834fd5aff5..64e1aef04d3a9296f169a64d313b089e1739aa46 100644 (file)
--- a/parts/DVD.tex
+++ b/parts/DVD.tex
@@ -462,7 +462,10 @@ Note that there will be no files in the actual AUDIO\_TS directory.
 \section{Subtitles}%
 \label{sec:subtitles}
 \index{DVD!subtitles}
 \section{Subtitles}%
 \label{sec:subtitles}
 \index{DVD!subtitles}

+\index{subtitles}

 
 

+Subtitles are not just for DVDs but are useful in other videos and the following information
+covers subtitles used for any purpose.

 DVD (not blu-ray... yet) subtitles are added by using the main window pulldown   \texttt{File $\rightarrow$ Subtitle}   which brings up a window allowing you to type the filename of a previously generated text file containing the desired words/lines, the script.  After entering the filename, click \texttt{Load} to read in your script.  By creating a script file ahead of time, it lets you easily add dialog that was already written out and carefully edited for spelling and proper grammar.
 
 The format of the script/text input file has specific requirements as listed below:
 DVD (not blu-ray... yet) subtitles are added by using the main window pulldown   \texttt{File $\rightarrow$ Subtitle}   which brings up a window allowing you to type the filename of a previously generated text file containing the desired words/lines, the script.  After entering the filename, click \texttt{Load} to read in your script.  By creating a script file ahead of time, it lets you easily add dialog that was already written out and carefully edited for spelling and proper grammar.
 
 The format of the script/text input file has specific requirements as listed below:

diff --git a/parts/Developer.tex b/parts/Developer.tex
index d0f9d43b60652b933ba861e209b1ff991f646b2d..5532ce8e9d8a3406e35f1157928e0c518c3806ec 100644 (file)
--- a/parts/Developer.tex
+++ b/parts/Developer.tex
@@ -3,6 +3,7 @@
 
 \section{How Builds Really Work and Even More Options}
 \label{sec:builds_really_work_more_options}
 
 \section{How Builds Really Work and Even More Options}
 \label{sec:builds_really_work_more_options}

+\index{build!more options}

 
 This section describes how builds really work if you want to know more about making changes or understanding the process; probably only for a developer or system administrator.
 
 
 This section describes how builds really work if you want to know more about making changes or understanding the process; probably only for a developer or system administrator.
 


@@ -112,6 +113,7 @@ Since the procedure for obtaining the latest ffmpeg version is not always kept u
 
 \section{Configuration Features}
 \label{sec:configuration_features}
 
 \section{Configuration Features}
 \label{sec:configuration_features}

+\index{build!configuration}

 
 A listing of the current configuration features as of January 11, 2020:
 
 
 A listing of the current configuration features as of January 11, 2020:
 


@@ -303,6 +305,7 @@ Report bugs to <mail@lists.cinelerra-gg.org>.
 
 \section{Thirdparty Parallel Build}
 \label{sec:thirdparty_parallel_build}
 
 \section{Thirdparty Parallel Build}
 \label{sec:thirdparty_parallel_build}

+\index{build!thirdparty}

 
 The Makefile in the thirdparty build directory employs a set of macros used to create a build rule set of thirdparty library build dependencies.  The standard build sequence of [source, config, build] is used to prepare thirdparty products as static libraries.  Build package dependency can be specified in the Makefile std-build macro call.  These Makefile macro calls define the rules used for each thirdparty build.  The expanded rule definitions may be viewed by using:
 
 
 The Makefile in the thirdparty build directory employs a set of macros used to create a build rule set of thirdparty library build dependencies.  The standard build sequence of [source, config, build] is used to prepare thirdparty products as static libraries.  Build package dependency can be specified in the Makefile std-build macro call.  These Makefile macro calls define the rules used for each thirdparty build.  The expanded rule definitions may be viewed by using:
 


@@ -323,6 +326,7 @@ The rule targets create the set of thirdparty packages which are built from loca
 
 \section{Using the very latest Libraries}
 \label{sec:latest_libraries}
 
 \section{Using the very latest Libraries}
 \label{sec:latest_libraries}

+\index{build!use latest library}

 
 Using the most current libraries can be a challenge for some of the Operating System distros that use
 stable compilers, assemblers, and their own libraries.  Because they are stable, they frequently do
 
 Using the most current libraries can be a challenge for some of the Operating System distros that use
 stable compilers, assemblers, and their own libraries.  Because they are stable, they frequently do


@@ -418,6 +422,7 @@ Look into opencv4/opencv2/core/types.hpp:711;27
 
 \section{Find Lock Problems with Booby Trap}
 \label{sec:find_lock_problems_booby_trap}
 
 \section{Find Lock Problems with Booby Trap}
 \label{sec:find_lock_problems_booby_trap}

+\index{build!booby trap}

 
 A Booby Trap is used in \CGG{} for setting a trap to catch lock problems that might have been missed. It will trap boobies only if compile by adding \textit{-{}-with-booby} on the configuration command line. This is the default if you compile using \texttt{./bld.sh} from the GIT repository. It should not interfere with normal execution.
 
 
 A Booby Trap is used in \CGG{} for setting a trap to catch lock problems that might have been missed. It will trap boobies only if compile by adding \textit{-{}-with-booby} on the configuration command line. This is the default if you compile using \texttt{./bld.sh} from the GIT repository. It should not interfere with normal execution.
 


@@ -463,6 +468,7 @@ It comes back with the routine as:
 
 \section{Valgrind Support Level}
 \label{sec:valgrind_support_level}
 
 \section{Valgrind Support Level}
 \label{sec:valgrind_support_level}

+\index{build!valgrind}

 
 Valgrind is a memory mis-management detector.  It shows you memory leaks, deallocation errors, mismanaged threads, rogue reads/writes, etc.  \CGG{} memory management is designed to work with Valgrind detection methods.  This assists in developing reliable code.  Use of Valgrind points out problems so that they can be fixed.  For example, when this version of \CGG{} shuts down, it deallocates memory instead of just stopping, thus making memory leak detection possible.
 
 
 Valgrind is a memory mis-management detector.  It shows you memory leaks, deallocation errors, mismanaged threads, rogue reads/writes, etc.  \CGG{} memory management is designed to work with Valgrind detection methods.  This assists in developing reliable code.  Use of Valgrind points out problems so that they can be fixed.  For example, when this version of \CGG{} shuts down, it deallocates memory instead of just stopping, thus making memory leak detection possible.
 


@@ -494,6 +500,7 @@ When compiling \CGG{} Infinity a CFLAGS option used is \textit{Wall} where the "
 
 \section{Prof2 -- A Profiler}
 \label{sec:prof2_profiler}
 
 \section{Prof2 -- A Profiler}
 \label{sec:prof2_profiler}

+\index{build!prof2}

 
 Frequently there is a problem with a program running slow and you do not know why. You need a thumbnail analysis of where the program is spending most of its time without all of the overwhelming details. This is when a Profiler comes in handy.
 
 
 Frequently there is a problem with a program running slow and you do not know why. You need a thumbnail analysis of where the program is spending most of its time without all of the overwhelming details. This is when a Profiler comes in handy.
 


@@ -645,6 +652,7 @@ So why use a Profiler? Because it is the ``ls'' for executable functions!!
 
 \section{How to Create a new Theme}
 \label{sec:how_create_theme}
 
 \section{How to Create a new Theme}
 \label{sec:how_create_theme}

+\index{theme!create new theme}

 
 A \textit{Theme} is a base class object that is created and customized as \textit{ThemeName}.
 It is constructed during program initialization in a theme plugin
 
 A \textit{Theme} is a base class object that is created and customized as \textit{ThemeName}.
 It is constructed during program initialization in a theme plugin

diff --git a/parts/Plugins.tex b/parts/Plugins.tex
index 036bd1be7c440fdd4e4b4946fc199837fd4c2c1f..c92243a329d991ba393d7cfac612520607f122d3 100644 (file)
--- a/parts/Plugins.tex
+++ b/parts/Plugins.tex
@@ -4286,10 +4286,11 @@ The following is a list of the integrated video plug-ins.
 \item [F\_sierpinski]~\\Generate a Sierpinski carpet/triangle fractal, and randomly pan around.
 \item [F\_signalstats]~\\Separates statistics from video
   analysis.
 \item [F\_sierpinski]~\\Generate a Sierpinski carpet/triangle fractal, and randomly pan around.
 \item [F\_signalstats]~\\Separates statistics from video
   analysis.

+\index{over sharpened footage}

 \item [F\_smartblur]~\\Blurs the input video without impacting
   the outlines. Through the settings you can select the radius, the
   strength and the threshold of luma and chroma. This plugin can be used to correct 
 \item [F\_smartblur]~\\Blurs the input video without impacting
   the outlines. Through the settings you can select the radius, the
   strength and the threshold of luma and chroma. This plugin can be used to correct 

-  over-sharpened footage.  For example, on a DJI 3840x2160 D-cinelike footage using
+  over sharpened footage.  For example, on a DJI 3840x2160 D-cinelike footage using

   these settings:
 \begin{itemize}
        \item luma radius: 3.247993
   these settings:
 \begin{itemize}
        \item luma radius: 3.247993

diff --git a/parts/Quickstart.tex b/parts/Quickstart.tex
index 379d4e082a67138dcffde7420715e6c246ccb084..e81a02c7f9439453139c5411b704a2f38fa273d9 100644 (file)
--- a/parts/Quickstart.tex
+++ b/parts/Quickstart.tex
@@ -3,6 +3,7 @@
 
 \section{\CGG{} Quick Start Guide}%
 \label{sec:cin_quick_start_guide}
 
 \section{\CGG{} Quick Start Guide}%
 \label{sec:cin_quick_start_guide}

+\index{quickstart guide}

 
 \CGG{} is a software program NLE, Non-Linear Editor, that provides a way to edit, record, and play audio or video media on Linux.   It can also be used to color correction, retouch photos, motion tracking, watch TV, and create DVDs.
 
 
 \CGG{} is a software program NLE, Non-Linear Editor, that provides a way to edit, record, and play audio or video media on Linux.   It can also be used to color correction, retouch photos, motion tracking, watch TV, and create DVDs.
 


@@ -268,6 +269,7 @@ The file you created in the Render step should now be playable.  You can test th
 
 \section{YouTube with \CGG{}}%
 \label{sec:youtube_with_cinelerra}
 
 \section{YouTube with \CGG{}}%
 \label{sec:youtube_with_cinelerra}

+\index{rendering!youtube preset}

 
 To create a youtube or dailymotion video, you can easily follow the steps below.  You will have to learn a lot more about \CGG{} to take full advantage of its capabilities and make some really special videos, but this is just to get a start and to see the possibilities.
 
 
 To create a youtube or dailymotion video, you can easily follow the steps below.  You will have to learn a lot more about \CGG{} to take full advantage of its capabilities and make some really special videos, but this is just to get a start and to see the possibilities.
 

diff --git a/parts/Shortcuts.tex b/parts/Shortcuts.tex
index 9b82e921ae8d83147cd54a8b76f31010a27845c6..393aea0cf8787e23a2fe852ecdea4ea436234027 100644 (file)
--- a/parts/Shortcuts.tex
+++ b/parts/Shortcuts.tex
@@ -574,7 +574,7 @@ The Main window (also called the program window) consists of pulldown menus, but
 
 \subsection*{Other Buttons }%
 \label{ssec:other_buttons}
 
 \subsection*{Other Buttons }%
 \label{ssec:other_buttons}

-\index{shortcuts!other windows} buttons
+\index{shortcuts!other windows buttons}

 
 \begin{longtable}[h]{>{\bfseries}p{0.15\textwidth-2\tabcolsep}p{0.25\textwidth-2\tabcolsep}p{0.2\textwidth-2\tabcolsep}p{0.4\textwidth-2\tabcolsep}}
   \toprule
 
 \begin{longtable}[h]{>{\bfseries}p{0.15\textwidth-2\tabcolsep}p{0.25\textwidth-2\tabcolsep}p{0.2\textwidth-2\tabcolsep}p{0.4\textwidth-2\tabcolsep}}
   \toprule

diff --git a/parts/Stuff.tex b/parts/Stuff.tex
index f89e3f0ec85958f3aabda5d111b8936d85af7ded..da8b24175fcff861b8b2978d820a874594690742 100644 (file)
--- a/parts/Stuff.tex
+++ b/parts/Stuff.tex
@@ -5,6 +5,7 @@ This section describes in detail some areas of \CGG{} to help explain how things
 
 \section{Copy/Paste and Highlight Usage}%
 \label{sec:copy_paste_highlight_usage}
 
 \section{Copy/Paste and Highlight Usage}%
 \label{sec:copy_paste_highlight_usage}

+\index{copy/paste}

 
 There are 3 types of copy/cut and paste methods which exist in X windows, and most modern programs use 2 of them.  The 3 cases are:
 
 
 There are 3 types of copy/cut and paste methods which exist in X windows, and most modern programs use 2 of them.  The 3 cases are:
 


@@ -52,6 +53,7 @@ When a text selection is set, the selected text is redrawn using selected-highli
 
 \subsection{Playing/Seeking}%
 \label{sub:playing_seeking}
 
 \subsection{Playing/Seeking}%
 \label{sub:playing_seeking}

+\index{seek!playing}

 
 \textit{Seeking} targets and displays the next frame.  The next frame is targeted because frame zero has no previous.  When you seek, you reposition to just before the target frame, and since the play direction has not been established (there is no direction when seeking) it shows you the next frame.  This produces the expected behavior when you seek to frame zero; you see the first frame.  Seeking displays in the compositor what you are getting ready to work with/edit/etc; always showing the next frame in relation to the cursor. Technically, since seeking just resets the position, it would be correct not to update the compositor, but it is best to seek and show the next frame to confirm that it is the frame you expected to see.
 
 
 \textit{Seeking} targets and displays the next frame.  The next frame is targeted because frame zero has no previous.  When you seek, you reposition to just before the target frame, and since the play direction has not been established (there is no direction when seeking) it shows you the next frame.  This produces the expected behavior when you seek to frame zero; you see the first frame.  Seeking displays in the compositor what you are getting ready to work with/edit/etc; always showing the next frame in relation to the cursor. Technically, since seeking just resets the position, it would be correct not to update the compositor, but it is best to seek and show the next frame to confirm that it is the frame you expected to see.
 


@@ -90,6 +92,7 @@ To recap, position is usually set in the program as a location that is between a
 
 \subsection{Always Show Next Frame}%
 \label{sub:always_show_next_frame}
 
 \subsection{Always Show Next Frame}%
 \label{sub:always_show_next_frame}

+\index{always show next frame}

 
 Since some users prefer the insertion pointer to reflect the same as the Compositor a choice is available.  For playing forward, there is a preference option which results in what looks like 1 was added to the frame displayed in the Compositor window.  To enable this mode, check the box \texttt{Always show next frame}, and this will be saved to \texttt{.bcast5}.  The option checkbox is in the \texttt{Settings $\rightarrow$ Preferences $\rightarrow$ Appearance} tab and when checked, any forward \textit{plays} in the Compositor window show the same frame as you would with a seek.  Reverse plays and plays using a selection or In/Out pointers (with Ctrl) work the same as without this preference set.  But you will no longer see the odd behavior where if you frame advance forward and then frame advance backward, the displayed frame does not change -- instead it will change and look more natural.
 A color indicator that shows in the main track canvas timeline and the compositor timeline reminds the user which mode is currently active.  The cursor in the compositor turns \textit{red} for default mode and \textit{white} for \textit{Always show next frame} mode.  The top portion of the insertion cursor in the track canvas mirrors this, with red for default and white otherwise.
 
 Since some users prefer the insertion pointer to reflect the same as the Compositor a choice is available.  For playing forward, there is a preference option which results in what looks like 1 was added to the frame displayed in the Compositor window.  To enable this mode, check the box \texttt{Always show next frame}, and this will be saved to \texttt{.bcast5}.  The option checkbox is in the \texttt{Settings $\rightarrow$ Preferences $\rightarrow$ Appearance} tab and when checked, any forward \textit{plays} in the Compositor window show the same frame as you would with a seek.  Reverse plays and plays using a selection or In/Out pointers (with Ctrl) work the same as without this preference set.  But you will no longer see the odd behavior where if you frame advance forward and then frame advance backward, the displayed frame does not change -- instead it will change and look more natural.
 A color indicator that shows in the main track canvas timeline and the compositor timeline reminds the user which mode is currently active.  The cursor in the compositor turns \textit{red} for default mode and \textit{white} for \textit{Always show next frame} mode.  The top portion of the insertion cursor in the track canvas mirrors this, with red for default and white otherwise.


@@ -128,11 +131,14 @@ Figure~\ref{fig:cursor02} using the \textit{Always show next frame} method where
 
 \subsection{Seeking Issues}%
 \label{sub:seeking_issue}
 
 \subsection{Seeking Issues}%
 \label{sub:seeking_issue}

+\index{seek!issue}

 
 If you have an issue playing a video and not seeing it in the Compositor (just see a black screen), it is most likely due to the media not being designed to be \textit{editable}.  It is most likely not damaged.  Generally it just does not have keyframes which are needed for seeking which is what is done when you move around the media and start playing in the middle.  The media plays just fine in the compositor if you always play from the beginning because then you don’t need keyframes to seek.  You can get around this problem if you proxy the media.  A good choice to use for the proxy would be \textit{use scalar}, \textit{ffmpeg/mp4} and size of $\frac{1}{2}$.  The proxied media can then seek and you will see it play in the compositor because keyframes exist.
 
 \section{Color Space and Color Range Affecting Playback}%
 \label{sec:color_space_range_playback}
 
 If you have an issue playing a video and not seeing it in the Compositor (just see a black screen), it is most likely due to the media not being designed to be \textit{editable}.  It is most likely not damaged.  Generally it just does not have keyframes which are needed for seeking which is what is done when you move around the media and start playing in the middle.  The media plays just fine in the compositor if you always play from the beginning because then you don’t need keyframes to seek.  You can get around this problem if you proxy the media.  A good choice to use for the proxy would be \textit{use scalar}, \textit{ffmpeg/mp4} and size of $\frac{1}{2}$.  The proxied media can then seek and you will see it play in the compositor because keyframes exist.
 
 \section{Color Space and Color Range Affecting Playback}%
 \label{sec:color_space_range_playback}

+\index{color!space}
+\index{color!range}

 
 Playback \textit{single step} and \textit{plugins} cause the render to be in the session color model, while continuous playback with no plugins tries to use the file’s best color model for the display (for speed).
 This can create a visible effect of a switch in color in the Compositor, usually shown as grayish versus over-bright.
 
 Playback \textit{single step} and \textit{plugins} cause the render to be in the session color model, while continuous playback with no plugins tries to use the file’s best color model for the display (for speed).
 This can create a visible effect of a switch in color in the Compositor, usually shown as grayish versus over-bright.


@@ -162,6 +168,7 @@ There is now program code to look for RGB versus YUV color model mismatches.  Yo
 
 \section{Automatic "Best Model" Media Load}%
 \label{sec:conform_the_project}
 
 \section{Automatic "Best Model" Media Load}%
 \label{sec:conform_the_project}

+\index{color!model}

 When you load media with the insertion strategy of \textit{replace current project}, the program code will
 automatically use the "best model" for the render based on the media's codec.  The best model is pretty
 much going to be what works well for television.  This automation was added to facilitate easy use of
 When you load media with the insertion strategy of \textit{replace current project}, the program code will
 automatically use the "best model" for the render based on the media's codec.  The best model is pretty
 much going to be what works well for television.  This automation was added to facilitate easy use of


@@ -205,6 +212,7 @@ This is \textit{simple} animation so you can expect speech synthesis not to be t
 
 \section{Textbox Non-std Character / Unicode Insertion}%
 \label{sec:textbox_non_std_character_unicode}
 
 \section{Textbox Non-std Character / Unicode Insertion}%
 \label{sec:textbox_non_std_character_unicode}

+\index{unicode insertion}

 
 If you want to enter a special character -- like a bullet, an accent grave character, or a mathematical summation symbol -- you can use the unicode equivalent in a textbox to do so.  In the textbox, keyin Ctrl-Shift-U which puts you into single character unicode mode, then keyin the numerical value for the intended single character followed by the carriage return.  For a voluminous list of possible special characters, you can go to {\small \url{https://unicode-table.com/en/}} on the internet to choose by highlighting a character to get its numerical equivalence.  For example, $U+2022$ is a bullet.  If you make a mistake, you can use the \textit{backspace} key or if you want to exit unicode-insert-mode, use the \textit{ESC} key.  This feature is especially useful with the \textit{Title} plugin and for naming Tracks in the main window.
 
 
 If you want to enter a special character -- like a bullet, an accent grave character, or a mathematical summation symbol -- you can use the unicode equivalent in a textbox to do so.  In the textbox, keyin Ctrl-Shift-U which puts you into single character unicode mode, then keyin the numerical value for the intended single character followed by the carriage return.  For a voluminous list of possible special characters, you can go to {\small \url{https://unicode-table.com/en/}} on the internet to choose by highlighting a character to get its numerical equivalence.  For example, $U+2022$ is a bullet.  If you make a mistake, you can use the \textit{backspace} key or if you want to exit unicode-insert-mode, use the \textit{ESC} key.  This feature is especially useful with the \textit{Title} plugin and for naming Tracks in the main window.
 

diff --git a/parts/Tips.tex b/parts/Tips.tex
index 0cbd57a705665d96ee8f007c4415253968f96fd4..7d4ecce4e2139de12da18a6a09f15eb90a1a6113 100644 (file)
--- a/parts/Tips.tex
+++ b/parts/Tips.tex
@@ -22,6 +22,7 @@ Besides the above hardware recommendations, this section covers tips for perform
 
 \section{Hardware video acceleration}%
 \label{sec:hardware_video_acceleration}
 
 \section{Hardware video acceleration}%
 \label{sec:hardware_video_acceleration}

+\index{hardware!acceleration}

 
 With certain newer, more powerful graphics boards and newer device drivers, there is the potential for enhanced \textit{decode} and \textit{encode} performance.   Decode refers to loading and playing video in \CGG{}. The GPU, Graphics Processing Unit, on the graphics board is accessed via one of the following libraries: vdpau or vaapi. The hardware acceleration done by the graphics card increases performance by activating certain functions in connection with a few of the FFmpeg decoders. This use makes it possible for the graphics card to decode video, thus offloading the CPU.  Decode operations are described here next.  
 Encode refers to rendering video and is described at the end of this section
 
 With certain newer, more powerful graphics boards and newer device drivers, there is the potential for enhanced \textit{decode} and \textit{encode} performance.   Decode refers to loading and playing video in \CGG{}. The GPU, Graphics Processing Unit, on the graphics board is accessed via one of the following libraries: vdpau or vaapi. The hardware acceleration done by the graphics card increases performance by activating certain functions in connection with a few of the FFmpeg decoders. This use makes it possible for the graphics card to decode video, thus offloading the CPU.  Decode operations are described here next.  
 Encode refers to rendering video and is described at the end of this section


@@ -36,6 +37,7 @@ Currently only the most common codecs, such as MPEG-1, MPEG-2, MPEG-4, H.264 /MP
 
 \subsection{GPU hardware decoding}%
 \label{sub:gpu_hardware_decoding}
 
 \subsection{GPU hardware decoding}%
 \label{sub:gpu_hardware_decoding}

+\index{hardware!decoding}

 
 \begin{enumerate}
        \item Verify that you have installed \textit{libva-dev} or \textit{libva} on your operating system.
 
 \begin{enumerate}
        \item Verify that you have installed \textit{libva-dev} or \textit{libva} on your operating system.


@@ -122,6 +124,7 @@ Using the GPU is going to react differently depending on your hardware, software
 
 \subsubsection*{Special .opts file}%
 \label{ssub:special_opts_file}
 
 \subsubsection*{Special .opts file}%
 \label{ssub:special_opts_file}

+\index{hardware!special opts files}

 
 The situation may arise where you have enabled hardware acceleration and after loading several files for a project, you find that a file had some kind of error resulting in a black video instead of an image or you see an error message pop up which states something like \textit{Error retrieving data from GPU to CPU} or \textit{err: Unknown error occurred}. Because the \texttt{CIN\_HW\_DEV} environment variable is either all or none, ordinarily in order to correct the non-working video you would have to turn off hardware acceleration for the entire project/session.  However, there is a way to continue working on your project without having to reload all of your files. You still use the environment variable and it will be effective for all of the formats it is able to handle, but you make an exception for any of the files that erred out. To do this you simply create a file in the same directory with the same name as the erring file with the different extension of .opts. The contents of this .opts file would just be the one line of:
 
 
 The situation may arise where you have enabled hardware acceleration and after loading several files for a project, you find that a file had some kind of error resulting in a black video instead of an image or you see an error message pop up which states something like \textit{Error retrieving data from GPU to CPU} or \textit{err: Unknown error occurred}. Because the \texttt{CIN\_HW\_DEV} environment variable is either all or none, ordinarily in order to correct the non-working video you would have to turn off hardware acceleration for the entire project/session.  However, there is a way to continue working on your project without having to reload all of your files. You still use the environment variable and it will be effective for all of the formats it is able to handle, but you make an exception for any of the files that erred out. To do this you simply create a file in the same directory with the same name as the erring file with the different extension of .opts. The contents of this .opts file would just be the one line of:
 


@@ -279,6 +282,7 @@ One last item of note, \textit{nvdec} is also enabled in the ffmpeg build, but a
 
 \subsection{GPU hardware encoding}%
 \label{sub:gpu_hardware_encoding}
 
 \subsection{GPU hardware encoding}%
 \label{sub:gpu_hardware_encoding}

+\index{hardware!encoding}

 
 Encoding using hardware acceleration of your graphics board GPU is
 included in \CGG{} but it is of limited availability and works only
 
 Encoding using hardware acceleration of your graphics board GPU is
 included in \CGG{} but it is of limited availability and works only


@@ -290,6 +294,7 @@ developed by Nvidia for Nvidia graphics boards.
 
 \subsubsection*{Broadcom, Intel HD, AMD}%
 \label{ssub:broadcom_intel_amd}
 
 \subsubsection*{Broadcom, Intel HD, AMD}%
 \label{ssub:broadcom_intel_amd}

+\index{hardware!vaapi}

 
 To use hardware acceleration for rendering (that is, encoding) you do not have to set a preference or an environment variable, as was required for decoding.  To use this feature you use an ffmpeg render options file which specifies a vaapi codec, such as h264\_vaapi.  You must include this line in that options file to trigger the hardware probe: \qquad     \texttt{CIN\_HW\_DEV=vaapi}
 
 
 To use hardware acceleration for rendering (that is, encoding) you do not have to set a preference or an environment variable, as was required for decoding.  To use this feature you use an ffmpeg render options file which specifies a vaapi codec, such as h264\_vaapi.  You must include this line in that options file to trigger the hardware probe: \qquad     \texttt{CIN\_HW\_DEV=vaapi}
 


@@ -333,6 +338,7 @@ using \texttt{ydiff} as described in the Appendix (\ref{sec:ydiff_check_results}
 
 \subsubsection*{Nvidia graphics boards}%
 \label{ssub:nvidia_graphics_card}
 
 \subsubsection*{Nvidia graphics boards}%
 \label{ssub:nvidia_graphics_card}

+\index{hardware!nvenc}

 
 To use hardware acceleration for rendering (that is, encoding) you do not have to set a preference or an environment variable, as was required for decoding.  To use this feature you use an ffmpeg render options file which specifies the nvenc codec, either \texttt{h264\_nvenc.mp4} or \texttt{nvenc.mp4}.  There are several requirements in order for this to work on your computer as listed here:
 
 
 To use hardware acceleration for rendering (that is, encoding) you do not have to set a preference or an environment variable, as was required for decoding.  To use this feature you use an ffmpeg render options file which specifies the nvenc codec, either \texttt{h264\_nvenc.mp4} or \texttt{nvenc.mp4}.  There are several requirements in order for this to work on your computer as listed here:
 


@@ -365,6 +371,8 @@ There is one last potentially significant graphics speedup when using the X11-Op
 
 \subsection{Effects (OpenCL, Cuda)}%
 \label{sub:effects_opencl_cuda}
 
 \subsection{Effects (OpenCL, Cuda)}%
 \label{sub:effects_opencl_cuda}

+\index{openCL}
+\index{CUDA}

 
 CUDA® is a parallel computing platform / programming model developed by Nvidia that provides big increases in computing performance through use of the GPU. It was first introduced in about 2006 for applications in computationally intense fields such as astronomy, biology, chemistry, and physics.
 
 
 CUDA® is a parallel computing platform / programming model developed by Nvidia that provides big increases in computing performance through use of the GPU. It was first introduced in about 2006 for applications in computationally intense fields such as astronomy, biology, chemistry, and physics.
 


@@ -418,6 +426,7 @@ In wrapping up this Hardware Acceleration section, you may want to refer to the
 
 \section{Optimized Playback -- X11 Direct}%
 \label{sec:optimized_playback}
 
 \section{Optimized Playback -- X11 Direct}%
 \label{sec:optimized_playback}

+\index{playback -X11 direct}

 
 Normally, when \CGG{} reads a video frame, it is copied into a \textit{Vframe}.  This frame may also need other actions performed on it, such as a color model change.  In addition, ffmpeg and libzmpeg \textit{can\_scale\_input}.  So the read can be color transformed and scaled just by asking the library to do that.  This means that if the compositor is in a \textit{good} state with no zoom, the VFrame read can be done in the fastest render color model, and already scaled to the correct size for the compositor.  In reality, this is not what you need for editing, but quite often the \textit{virtualconsole} is not used because the render is media only -- that is \textit{just data}.  If no data transforms are needed and the input scaling can be done, the vrender program detects this, and tells the codec to transmit the data in a compatible way to the compositor canvas. This is the \textit{X11 direct} data path.
 
 
 Normally, when \CGG{} reads a video frame, it is copied into a \textit{Vframe}.  This frame may also need other actions performed on it, such as a color model change.  In addition, ffmpeg and libzmpeg \textit{can\_scale\_input}.  So the read can be color transformed and scaled just by asking the library to do that.  This means that if the compositor is in a \textit{good} state with no zoom, the VFrame read can be done in the fastest render color model, and already scaled to the correct size for the compositor.  In reality, this is not what you need for editing, but quite often the \textit{virtualconsole} is not used because the render is media only -- that is \textit{just data}.  If no data transforms are needed and the input scaling can be done, the vrender program detects this, and tells the codec to transmit the data in a compatible way to the compositor canvas. This is the \textit{X11 direct} data path.
 


@@ -436,6 +445,7 @@ Info on transcode in \nameref{sec:transcode}
 
 \section{Some Settings Parameter Values}%
 \label{sec:settings_parameter_values}
 
 \section{Some Settings Parameter Values}%
 \label{sec:settings_parameter_values}

+\index{cache}

 
 \texttt{Cache} in \texttt{Settings $\rightarrow$ Preferences, Performance} tab is used to store images on the timeline.  One 1080p frame uses about 10 MB.  The default setting is 256 and this is enough for testing and running.  However, why not use more memory if it is available.   To experiment for testing a good number tuned to the way you use your computer, set the cache to 0, start up \CGG{}, load a typical media file, play it and run \texttt{top} on the command line in another window to see how much memory is being used.  In the \textit{top} display, look at \textit{free} memory.  Whatever your computer is not using, is a good number to use for cache.  If you start other programs, or change the design of the session so that it uses a lot of frame storage, you may need to experiment again later and resize accordingly.
 
 
 \texttt{Cache} in \texttt{Settings $\rightarrow$ Preferences, Performance} tab is used to store images on the timeline.  One 1080p frame uses about 10 MB.  The default setting is 256 and this is enough for testing and running.  However, why not use more memory if it is available.   To experiment for testing a good number tuned to the way you use your computer, set the cache to 0, start up \CGG{}, load a typical media file, play it and run \texttt{top} on the command line in another window to see how much memory is being used.  In the \textit{top} display, look at \textit{free} memory.  Whatever your computer is not using, is a good number to use for cache.  If you start other programs, or change the design of the session so that it uses a lot of frame storage, you may need to experiment again later and resize accordingly.
 


@@ -464,6 +474,7 @@ A list of items to check for smaller computers that will help to use less cpu/me
 
 \section{General Crash Handling Tips}%
 \label{sec:general_crash_tips}
 
 \section{General Crash Handling Tips}%
 \label{sec:general_crash_tips}

+\index{crash handling tips}

 
 This section is a handy guide for describing various kinds of software computer system failures.  Only some of these various lockups or crashes can be dealt with.  Hopefully, it will help to have some hints to know what kind of failure it is, or to save your work or to avoid future problems.  For most of this, your user name must be root, although you can certainly try to see if it works for you when not root.
 
 
 This section is a handy guide for describing various kinds of software computer system failures.  Only some of these various lockups or crashes can be dealt with.  Hopefully, it will help to have some hints to know what kind of failure it is, or to save your work or to avoid future problems.  For most of this, your user name must be root, although you can certainly try to see if it works for you when not root.
 


@@ -545,6 +556,7 @@ To create a specific 440 Hz tone, follow these steps.  You can vary the length,
 
 \subsection{Camera supplied LUTs}%
 \label{sub:camera_supplied_luts}
 
 \subsection{Camera supplied LUTs}%
 \label{sub:camera_supplied_luts}

+\index{LUT}

 
 A LUT, acronym for Look-Up Table, is a mathematically precise way of taking specific RGB image values from a source image and modifying them to new RGB values by changing the hue, saturation and brightness values of that source image. In other words, LUTs are used to map one color space to another.  Some high-end cameras supply a .cube file to use as input. There are several different ffmpeg plugins included with CinGG for using Lut's.  These are:
 
 
 A LUT, acronym for Look-Up Table, is a mathematically precise way of taking specific RGB image values from a source image and modifying them to new RGB values by changing the hue, saturation and brightness values of that source image. In other words, LUTs are used to map one color space to another.  Some high-end cameras supply a .cube file to use as input. There are several different ffmpeg plugins included with CinGG for using Lut's.  These are:
 


@@ -560,6 +572,7 @@ For example, to use a 3dlut simply load your video, drop the F\_lut3d plugin on
 
 \subsection{Encoding into Dolby Pro Logic}%
 \label{sub:encoding_dolby_pro_logic}
 
 \subsection{Encoding into Dolby Pro Logic}%
 \label{sub:encoding_dolby_pro_logic}

+\index{dolby pro logic}

 
 Dolby pro logic is an easy way to output 6 channel audio from a 2-channel soundcard with degraded but useful results. Rudimentary Dolby pro logic encoding can be achieved with usage of some effects.
 
 
 Dolby pro logic is an easy way to output 6 channel audio from a 2-channel soundcard with degraded but useful results. Rudimentary Dolby pro logic encoding can be achieved with usage of some effects.
 


@@ -608,6 +621,7 @@ Use the Camera in the compositor to shift the picture up or down a line to remov
 
 \subsection{Remove Interlacing}%
 \label{sub:remove_interlacing}
 
 \subsection{Remove Interlacing}%
 \label{sub:remove_interlacing}

+\index{interlacing}

 
 Interlacing often exists on older video sources, such as camcorders, and was previously used in broadcast television. Playing this video results in jagged images on a computer monitor, but with \CGG{} you can use deinterlacing effects to solve this.  After some experimentation, it has been determined that the FFmpeg \textit{F\_kerndeint} plugin seems to produce the best results with the least amount of fiddling.  But some of the parameters described next are pertinent to other potential plugin usage.
 
 
 Interlacing often exists on older video sources, such as camcorders, and was previously used in broadcast television. Playing this video results in jagged images on a computer monitor, but with \CGG{} you can use deinterlacing effects to solve this.  After some experimentation, it has been determined that the FFmpeg \textit{F\_kerndeint} plugin seems to produce the best results with the least amount of fiddling.  But some of the parameters described next are pertinent to other potential plugin usage.
 


@@ -695,6 +709,7 @@ The resulting .mp3 file can be uploaded to a web server and then the phone's web
 
 \subsection{Time stretching audio}%
 \label{sub:time_stretching_audio}
 
 \subsection{Time stretching audio}%
 \label{sub:time_stretching_audio}

+\index{audio!time stretching}

 
 It may appear that time stretching audio is a matter of selecting a region of the audio tracks, enabling recording for the desired tracks, going to\texttt{ Audio $\rightarrow$ Render Effect}, and applying \textit{TimeStretch}. In actuality there are 3 audio effects for time stretching: Time Stretch, Resample, and Asset info dialog.
 
 
 It may appear that time stretching audio is a matter of selecting a region of the audio tracks, enabling recording for the desired tracks, going to\texttt{ Audio $\rightarrow$ Render Effect}, and applying \textit{TimeStretch}. In actuality there are 3 audio effects for time stretching: Time Stretch, Resample, and Asset info dialog.
 

diff --git a/parts/Translations.tex b/parts/Translations.tex
index c723856754aec27a9529d6305e824ef7dfc97c06..33545819c78065e3c04bd9575a9938ddee6186e3 100644 (file)
--- a/parts/Translations.tex
+++ b/parts/Translations.tex
@@ -11,7 +11,7 @@ of updates, and date of last update as of this writing.
        French& fr.po&  Updated often& Last update 2019 May\\
        German&  de.po& Updated often& Last update 2019 December\\
        Russian& ru.po& Updated often& Last update 2019 October\\
        French& fr.po&  Updated often& Last update 2019 May\\
        German&  de.po& Updated often& Last update 2019 December\\
        Russian& ru.po& Updated often& Last update 2019 October\\

-       Spanish& es.po& Updated often& Last update 2020 February\\
+       Spanish& es.po& Updated often& Last update 2020 October\\

 \\
        Basque& eu.po&  From CV with Google Translate & Last update 2016 October\\
        Italian&it.po&  From CV with Google Translate & Last update 2016 October\\
 \\
        Basque& eu.po&  From CV with Google Translate & Last update 2016 October\\
        Italian&it.po&  From CV with Google Translate & Last update 2016 October\\

diff --git a/parts/Trouble.tex b/parts/Trouble.tex
index 2b95aa11648e33ff7708635cd694529f75cd8644..2ff131a16786311d6550e5877c95ded36fe2b2af 100644 (file)
--- a/parts/Trouble.tex
+++ b/parts/Trouble.tex
@@ -24,6 +24,7 @@ troubleshooting help is included in other sections of this manual for specific f
 
 \section{What to Include in Problem Reports}%
 \label{cha:include_in_problem_reports}
 
 \section{What to Include in Problem Reports}%
 \label{cha:include_in_problem_reports}

+\index{report problem}

 For the best help, if you have a reproducible problem and can provide the following list of materials for analysis, it
 is usually possible to figure out what the problem is and how to fix it. It may be a simple usage or setup mistake or
 a real bug which a programmer would like to fix rather quickly. Although it is not always necessary to provide this
 For the best help, if you have a reproducible problem and can provide the following list of materials for analysis, it
 is usually possible to figure out what the problem is and how to fix it. It may be a simple usage or setup mistake or
 a real bug which a programmer would like to fix rather quickly. Although it is not always necessary to provide this


@@ -56,6 +57,7 @@ It is better to upload any files to a drop site as some of them can be quite lar
 
 \section{Crash Dumps for Analysis}%
 \label{cha:crash_dumps_analysis}
 
 \section{Crash Dumps for Analysis}%
 \label{cha:crash_dumps_analysis}

+\index{crash dumps}

 If you get a SEGV crash and can explain what steps you took, a \texttt{/tmp/cinelerra\_<pid> .dmp} file is
 very useful for analysis. You can also use Ctrl-c in the controlling window to force an INTR signal interrupt when
 you think the program is hung up. You can only perform one Ctrl-c as the second Ctrl-c quits out of the program. It
 If you get a SEGV crash and can explain what steps you took, a \texttt{/tmp/cinelerra\_<pid> .dmp} file is
 very useful for analysis. You can also use Ctrl-c in the controlling window to force an INTR signal interrupt when
 you think the program is hung up. You can only perform one Ctrl-c as the second Ctrl-c quits out of the program. It


@@ -92,6 +94,8 @@ probability that the dump will prove useful, but if the problem can be recreated
 
 \section{When things go wrong}%
 \label{cha:when_things_go_wrong}
 
 \section{When things go wrong}%
 \label{cha:when_things_go_wrong}

+\index{problem FAQ}
+

 Sometimes things go wrong and there are some ways to continue your work without much trouble. Below is a list of items
 to try before abandoning your session.
 
 Sometimes things go wrong and there are some ways to continue your work without much trouble. Below is a list of items
 to try before abandoning your session.
 


@@ -134,10 +138,10 @@ On the \textit{File} pulldown, there is a \textit{Dumps} option with a submenu o
 the text results will be shown in that window.
 
 \begin{itemize}[nosep]
 the text results will be shown in that window.
 
 \begin{itemize}[nosep]

-\item \textit{Dump EDL} will display your current EDL state on the screen in the window from where you started Cin. This can be useful to see information concerning a specific edit or a file path.
-\item \textit{Dump Plugins} will show the names of the currently loaded plugins.
-\item \textit{Dump Assets} displays the media assets that you have loaded and various pertinent details on each, such as samplerate, width, and height.
-\item \textit{Dump Undo }will dump the last 32 edits on the undo stack exactly as kept, which can be useful if you are looking to see how far back in the undo to go to get to a specific spot.
+\item \textit{Dump EDL} \index{EDL dump} will display your current EDL state on the screen in the window from where you started Cin. This can be useful to see information concerning a specific edit or a file path.
+\item \textit{Dump Plugins} \index{plugins!dumps} will show the names of the currently loaded plugins.
+\item \textit{Dump Assets} \index{asset!dump} displays the media assets that you have loaded and various pertinent details on each, such as samplerate, width, and height.
+\item \textit{Dump Undo} \index{undo dump} will dump the last 32 edits on the undo stack exactly as kept, which can be useful if you are looking to see how far back in the undo to go to get to a specific spot.

 \end{itemize}
 
 \textbf{Common Problems}
 \end{itemize}
 
 \textbf{Common Problems}


@@ -224,6 +228,7 @@ In the mask window, check the box \textit{Disable OpenGL masking} to use softwar
 
 \section{Menu Bar Shell Commands}%
 \label{menu_bar_shell_commands}
 
 \section{Menu Bar Shell Commands}%
 \label{menu_bar_shell_commands}

+\index{shell commands}

 
 In order to provide some types of help, the Menu Bar Shell Commands are available for customization purposes (figure~\ref{fig:trouble-img001}).
 
 
 In order to provide some types of help, the Menu Bar Shell Commands are available for customization purposes (figure~\ref{fig:trouble-img001}).
 


@@ -309,6 +314,7 @@ There are some Help features currently included in the Shell Cmds menu. Those av
 
 \section{\CGG{} Command Line -h}%
 \label{cha:cinelerra_command_line_-h}
 
 \section{\CGG{} Command Line -h}%
 \label{cha:cinelerra_command_line_-h}

+\index{command line}

 
 To see the command line parameters available to use with \CGG{}, key in:
 
 
 To see the command line parameters available to use with \CGG{}, key in:
 

diff --git a/parts/Windows.tex b/parts/Windows.tex
index ea32d57f56a1a999fd57c9bb512c8ede5623ddde..d20465bf60e0e5e9797257ab02daf10a15b007c3 100644 (file)
--- a/parts/Windows.tex
+++ b/parts/Windows.tex
@@ -421,7 +421,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}
 \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.
 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.


@@ -1558,7 +1558,7 @@ Using the right mouse click to bring up a menu in the folder area \index{folders
 
 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.  
 
 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}
 
 
 \begin{description}


@@ -1584,7 +1584,7 @@ For Clips \index{clip!RMB options}, \emph{Nest} and \emph{UnNest} as described e
 
 \subsection{Info Asset Details}%
 \label{sub:info_asset_details}
 
 \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.
 
 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.