Updated to correctly reflect Georgy's code fixes and enhancements for ContextHelp

diff --git a/parts/AuxilaryPrograms.tex b/parts/AuxilaryPrograms.tex
index 00a4e6b12261a6204fbb987c3d4b4722d42bbde7..a090c7c8b0a6901584c11b45fb391922696fe50b 100644 (file)
--- a/parts/AuxilaryPrograms.tex
+++ b/parts/AuxilaryPrograms.tex
@@ -116,6 +116,7 @@ The following extensions of files in \CGG{}'s \texttt{.bcast5} directory are exp
        \item [.toc] toc is \textit{table of contents} file for MPEG video files (a type of index)
        \item [Cinelerra\_plugins] a list of the currently loaded plugins available in your \CGG{} session
        \item [Cinelerra{}\_rc] the user's preferences and settings are saved in this file to be used on startup.  This file can be carefully edited to change startup values for certain parameters, but if you inadvertently set up something incorrectly, you may end up crashing the program.
+       \item [ContextManual.pl] the user's configurable version of the Perl script which drives the Context Help feature 
        \item [ladspa\_plugins{\dots}] list of currently loaded ladspa plugins for each version of \CGG{} being used
        \item [layout\#...\_rc] user-defined window layout setup with the layout name as part of the file name
        \item [.xml] used for various backups or for the current settings of plugins that you have used

diff --git a/parts/Developer.tex b/parts/Developer.tex
index f8939cc6dcd1575c7d883b4e64e92c2ecddfc9c8..74947f68d593d2c0059a7026d83f4cd0d2769b7a 100644 (file)
--- a/parts/Developer.tex
+++ b/parts/Developer.tex
@@ -980,3 +980,12 @@ For now, \CGG{} context help is not localized at all. There is no complete \CGG{
 More about ContextManual.pl file?
 
 The bin/doc/ContextManual.pl script can be configured further. Look in the script text. You can define your preferable web browser, or redefine it to 'echo' for debug purposes. There are also some predefined HTML pages for Contents and Index, and several explicitly rewritten keyphrases. 
+
+After the first invocation of context help the system-wide script, bin/doc/ContextManual.pl, copies itself into
+the user's config directory, \$HOME/.bcast5. If the user needs to modify ContextManual.pl, it should be done
+on that copy from .bcast5 rather than the system-wide one. On all subsequent context help requests this
+(possibly modified) .bcast5 version of the script will be called.  If later the \CGG{} package gets
+upgraded containing a newer, not 100\% compatible version of ContextManual.pl script, and/or not compatible
+structure of the HTML manual itself, the new system-wide version of the script will be copied into .bcast5
+again to ensure context help functionality. The older version of the script will be backed up (with the .bak
+suffix) as a reference of the modifications done by the user.

diff --git a/parts/Editing.tex b/parts/Editing.tex
index 62c64281bdc9e7c709b67136f043e6fed4fdbd7b..71edce60772050099ee5ca9c75eca3b4e12598b8 100644 (file)
--- a/parts/Editing.tex
+++ b/parts/Editing.tex
@@ -1810,9 +1810,7 @@ cat "/sys/kernel/debug/hid/0003:0B33.0030.0006/events"  # press keys to see the
 The following is the default setting for the ShuttlePROv2 and
 ShuttleXpress (table~\ref{tab:shuttleprov2} and
 table~\ref{tab:xpress}).  This page can be quickly requested from \CGG{} by
-pressing both the left and right Alt keys on the keyboard followed by pressing
-any button on the Shuttle. To cancel this mode, press any single modifier key
-(\texttt{Alt, \texttt{Ctrl}} or Shift) once.
+simultaeneously pressing the \texttt{Alt} key on the keyboard and any button on the Shuttle.
 
 \renewcommand{\arraystretch}{1.15}
 \begin{table}[ht]

diff --git a/parts/Trouble.tex b/parts/Trouble.tex
index cdda98c8baa037a45690146f831b3e7ddd40d40d..44cd1467ce43755679befeab2181e9f25c7bd526 100644 (file)
--- a/parts/Trouble.tex
+++ b/parts/Trouble.tex
@@ -39,7 +39,7 @@ There are several possibilities to request the help page for a particular plugin
 \label{sub:context_help_contour_shuttle}
 \index{context help!contour shuttle}
 
-Contour Shuttle has no \texttt{Alt/h}. Nevertheless, its help page can be requested by simultaneously pressing both \texttt{Alt} keys (left and right) on the keyboard followed by pressing any button on the Contour Shuttle. Here, pressing both Alt keys is necessary due to the way X11 tracks the status of modifiers. To cancel this mode, press any single modifier key (\texttt{Alt, \texttt{Ctrl}} or Shift) once.  Note that the manual Shuttle Configuration will be the default one, rather than the one that you may have redefined.
+Contour Shuttle has no \texttt{Alt/h}. Nevertheless, its help page can be requested by simultaneously pressing the \texttt{Alt} key on the keyboard and any button on the Contour Shuttle.  Note that the default Shuttle Configuration will be shown, rather than the one that you may have redefined.
 
 \subsection{Alternative web browser configuration}%
 \label{sub:alt_browser}