<br><br>On Sunday, May 16, 2021, Phyllis Smith via Cin <<a href="mailto:cin@lists.cinelerra-gg.org">cin@lists.cinelerra-gg.org</a>> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div dir="ltr"><div class="gmail_default" style="font-size:small"><br></div></div><div style="font-size:small" class="gmail_default">Updated the Manual in GIT to include Georgy's documentation.  Andrea did the</div><div style="font-size:small" class="gmail_default"> formatting and if he gets time to check the formatting of the small parts that I added,</div><div style="font-size:small" class="gmail_default"> that would be appreciated as he is a lot better at that and making it consistent.</div><div style="font-size:small" class="gmail_default">------------------------------<wbr>---------------------------<br></div><div style="font-size:small" class="gmail_default">Split the main Context Help section that Andrea formatted into 2 parts -- the</div><div style="font-size:small" class="gmail_default">user part is in the Trouble.tex file and the programmer portion is in the</div><div style="font-size:small" class="gmail_default">Developer.tex file.<br></div><div class="gmail_quote"><div> <br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
1) Einther in Chapters_Overview.html, or in CINELERRA_GG_Overview.html -<br>
some short sentence like: "Furthemore, CGG provides the Context Help<br>
facility. A relevant section of CGG manual can be quickly recalled in a web<br>
browser window by pointing with mouse on the GUI item of interest and<br>
pressing the hotkey Alt/h, see Chapter 18 for more info".<br></blockquote><div><span class="gmail_default" style="font-size:small">Some wording like this was put in 2 places in the Introduction.tex file -</span></div><div><span class="gmail_default" style="font-size:small">closer to the beginning in case users don't read very far and under the short</span></div><div><span class="gmail_default" style="font-size:small">description of Chapter 18.<br></span></div><div><span class="gmail_default" style="font-size:small"><br></span></div><div><span class="gmail_default" style="font-size:small">Also added as a "Standard Feature" in Introduction.tex.  BUT, is it really</span></div><div><span class="gmail_default" style="font-size:small">"standard"? or should it be "Innovative New Feature"?  <b>Do other NLE's <br></b></span></div><div><span class="gmail_default" style="font-size:small"><b>have easily available Help from the program? </b> I have never looked at</span></div><div><span class="gmail_default" style="font-size:small">any others.<br></span></div><div></div></div></div></blockquote><div><br></div><div>i think it was innovative in early 1990s) </div><div>at least in many qt3/kde3 programs it was possible to click on small '?' labeled button at window titlebar and move cursor over element in GUI  and get some kind of 'help in the bubble'. and of course there was help-AS-HTML in GIMP,  but my latest selfmade builds doesn't show it, sadly.. (i probably need to learn where to put those help files there for offline/internetless views) </div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div class="gmail_quote"><div></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
2) Perhaps in View_Listen.html (or in some other subsection of<br>
CINELERRA_GG_Quick_Start_Gu.<wbr>html) - something like: "If you need more<br>
detailed information on a button or other particular GUI element than is<br>
contained in tooltips, press Alt/h hotkey and you get the HTML page in web<br>
browser with the documentation of the element being currently under mouse".<br></blockquote><div><span class="gmail_default" style="font-size:small">Similar wording put in 2 places in the Quickstart.tex file.</span> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
3) In How_see_short_Description_P.<wbr>html - about the 4 possibilities of<br>
getting documentation on a plugin in the form of Context Help.<br></blockquote><div><span class="gmail_default" style="font-size:small">Added to the Plugins.tex file.</span> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
4) In Shuttle_key_default_arrange.<wbr>html - "This page can be quickly requested<br>
from CGG by pressing both Alt keys (left and right) on keyboard followed by<br>
pressing any button on the Shuttle".<br></blockquote><div><span class="gmail_default" style="font-size:small">Added to the Editing.tex file.</span> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
5) Perhaps some tip(s) about Context Help could be added to the list for the<br>
'Tip of the day' window.<br></blockquote><div><span class="gmail_default" style="font-size:small">This was checked into the source code GIT yesterday.  BUT the tips are 'rolling' <br></span></div><div><span class="gmail_default" style="font-size:small">so it will only show up the first time and then again when it wraps around.  The</span></div><div><span class="gmail_default" style="font-size:small">user can always use the arrow keys to see a previous tip though.</span></div><div><span class="gmail_default" style="font-size:small"></span> <br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
6) Some phrase about Context Help facility might be added to the list of<br>
documentation sources on the web page<br>
<a href="https://www.cinelerra-gg.org/downloads/#documentation" rel="noreferrer" target="_blank">https://www.cinelerra-gg.org/<wbr>downloads/#documentation</a></blockquote><div><span class="gmail_default" style="font-size:small">I have not done this yet because I am not sure where I want it to go and I fumble</span></div><div><span class="gmail_default" style="font-size:small">a lot when using WordPress.</span> <br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
Another addition for the Context Help documentation, for completeness, I<br>
have added as note to BT568 in reply to user fary54: how to configure some<br>
selected browsers to get Context Help pages displayed in same browser tab<br>
rather than in new tabs for each new Alt/h request, I cite this:<br></blockquote><div><span class="gmail_default" style="font-size:small">This is in Trouble.tex (basically as cited).</span></div><div><span class="gmail_default" style="font-size:small"><br></span></div><div><span class="gmail_default" style="font-size:small">Other additions:<br></span></div><div><span class="gmail_default" style="font-size:small">-----------------------<br></span></div><div><span class="gmail_default" style="font-size:small">1) in the Shortcuts.tex file I mentioned the "hotkey Alt/h" in the</span></div><div><span class="gmail_default" style="font-size:small"> verbage because in reality it is a shortcut to get to the manual page.</span> <br></div><div><div style="font-size:small" class="gmail_default">2) in Developer.tex file, I added "what about localization", "why using</div><div style="font-size:small" class="gmail_default">local html files, and small details about "Context_Help.pl".</div><div style="font-size:small" class="gmail_default"><br></div><div style="font-size:small" class="gmail_default">I plan to proofread again tomorrow what I checked in because I kept</div><div style="font-size:small" class="gmail_default">making editing mistakes in vi.      ...Phyllis<br></div></div></div></div></blockquote><div><br></div><div><br></div><div>hehe... i think you can use EDITOR enviroment variable for controlling what kind of editor git use for commit message editing (found this out because here vi was not installed) </div><div><br></div><div>in my case:</div><div>export</div><div>[skip a lot] </div><div>declare -x EDITOR="mcedit"</div><div>[skip more] </div><div><br></div><div>Thanks a megaton for this work on documentation! </div>