Some small typos and errors I found in the BCX docs

[Quin]

... Meanwhile, on the Pelles forums, I'm told Pelle is done with my suggestions after the table headers provided by another forum member looked ugly to him. Completely his prerogative, of course, PellesC is his baby and he is free to choose how his docs look, ...

In defense of Pelle, and speaking from personal experience, being interested in coding does not dispose one to an interest in technical writing (documentation).  25 years ago, I was the chief, cook, and bottle washer for the infant BCX project.  I wrote the first codes, revision log, help files, and setup and administered the first websites and forums.  Plus, I had a full time job, a career, and a family to support.  Soon after, I started incorporating codes from BCX users, maintained the revision log, and watched BCX mature.  Oh yeah, and testing -- lots of testing.  All those things required a lot of time and effort.  Until one walks in the shoes of others ... 

I was never more grateful than when Robert volunteered to take over the maintenance of BCX Help.  To this day, we all benefit from Robert's generosity.  The fact that Robert has, and continues to provide updates that benefit sight impaired BCX users is an extremely rare gift indeed.

I fully agree, and my intention wasn't to speak negatively about Pelle as a project maintainer, or anything of the sort. I was simply highlighting that Robert's incredible dedication and skill are rare to come by, and that's why BCX has my favorite help file out of any product
As a documentation maintainer for a large C++ project NVGT, I know the pain.

[MrBcx]

... Meanwhile, on the Pelles forums, I'm told Pelle is done with my suggestions after the table headers provided by another forum member looked ugly to him. Completely his prerogative, of course, PellesC is his baby and he is free to choose how his docs look, ...

In defense of Pelle, and speaking from personal experience, being interested in coding does not dispose one to an interest in technical writing (documentation).  25 years ago, I was the chief, cook, and bottle washer for the infant BCX project.  I wrote the first codes, revision log, help files, and setup and administered the first websites and forums.  Plus, I had a full time job, a career, and a family to support.  Soon after, I started incorporating codes from BCX users, maintained the revision log, and watched BCX mature.  Oh yeah, and testing -- lots of testing.  All those things required a lot of time and effort.  Until one walks in the shoes of others ... 

I was never more grateful than when Robert volunteered to take over the maintenance of BCX Help.  To this day, we all benefit from Robert's generosity.  The fact that Robert has, and continues to provide updates that benefit sight impaired BCX users is an extremely rare gift indeed.

[Quin]

Hi Robert,
This is absolutely beautiful, and it reads perfectly! Thanks for all your work!

Also I meant what I said about you being the best documentation maintainer for any project I've found, regardless of the problem and how unsolvable it seems you forge ahead. Meanwhile, on the Pelles forums, I'm told Pelle is done with my suggestions after the table headers provided by another forum member looked ugly to him. Completely his prerogative, of course, PellesC is his baby and he is free to choose how his docs look, but there is nowhere near the level of dedication you recoding these buttons or any number of the other things you've done to make the docs better show.

[Robert]

Hi Robert,
Now, I hear "button    graphic    Copy to Clipboard".
So, I think you just need to do the same thing you did to get rid of the "graphic" when they were links, and we'll be golden!
Thanks for all your work, you're my favorite documentation maintainer for any project by far.

Hi Quin:

When you have time, I would appreciate your opinion on the copy to clipboard buttons in the attached .zip of the BCX Help file.

The image link has been moved from the HTML copy to clipboard buttons tags to the transparent-button class section of the bcx.css component.

An aria-label="Copy To Clipboard" has been added to the clipboard buttons tags.

I expect that when you navigate to a copy to clipboard button, that your screen reader will say "button Copy to Cipboard".

When the enter key is pressed with the focus on a copy to clipboard button,
the example text is highlighted,
a message box pops up with
1. a title of "Message from webpage",
2. a message stating "Text copied to clipboard"
and
3. an OK button holding the focus.

Pressing the Enter key dismisses the message box and highlighting is removed from the text being copied.

The copied text is on the clipboard for you to do as you wish.

Thank you for your compliments. I am pleased that my work has made your learning experience with BCX less difficult.

[Quin]

Hi Robert,
Now, I hear "button    graphic    Copy to Clipboard".
So, I think you just need to do the same thing you did to get rid of the "graphic" when they were links, and we'll be golden!
Thanks for all your work, you're my favorite documentation maintainer for any project by far.

[Robert]

Robert,
Understood. It's not a big deal, just a pedantic thing and it only saying button would be semantically correct, but this is good how it is. I can navigate by button and go between code copy buttons, like I'd expect.
Thanks!

Hi Quin:
I have recoded the copy buttons and would appreciate you checking them out. Attached is zipped BCX Documentation file.
Thanks.

[Quin]

Robert,
Understood. It's not a big deal, just a pedantic thing and it only saying button would be semantically correct, but this is good how it is. I can navigate by button and go between code copy buttons, like I'd expect.
Thanks!

[Robert]

Hi Robert,
This is at least better, now it gets read as

link    button    Copy to Clipboard

If this is as good as we can get it I'll except that, but removing the "link" announcement if possible would be appreciated.
Thanks

Hi Quin:

Removing the link would be difficult because the link connects the button image to the Javascript that copies the text to the clipboard. I've been looking for alternative coding solutions but so far no luck.

[Quin]

Hi Robert,
This is at least better, now it gets read as

link    button    Copy to Clipboard

If this is as good as we can get it I'll except that, but removing the "link" announcement if possible would be appreciated.
Thanks

[Robert]

Hey Robert,
This is a fairly small nitpick, and for that reason I understand if it wouldn't be possible, but could you make the copy to clipboard control have an aria-role of button? Currently it reads as "visited  link    graphic    Copy to Clipboard", which works, but "button Copy to Clipboard" is much clearer.
Thanks!

Hi Quin:
In the attached .zip, the BCXHelp.chm "Copy to Clipboard" <img> tags have an added ARIA "role=button" attribute.

Let me know if it works. The development of .chm files by Microsoft was stopped before you were born so a lot of new stuff, like semantic tags, doesn't work because HTML 5 is required.

If it doesn't work, then we go back to the drawing board. 

[Quin]

Hey Robert,
This is a fairly small nitpick, and for that reason I understand if it wouldn't be possible, but could you make the copy to clipboard control have an aria-role of button? Currently it reads as "visited  link    graphic    Copy to Clipboard", which works, but "button Copy to Clipboard" is much clearer.
Thanks!

[Robert]

Robert,
It's the H2 under the h1 that says "SSubclassing Windows Controls". Select the text and copy it, you'll see the missing space:

CALLBACKFUNCTION ... END FUNCTION procedure
Purpose:

Hi Quin:

Nope. I have a real space.

Code Select Expand

CALLBACK FUNCTION ... END FUNCTION procedure
Purpose:

Checked source in a Hex editor and the real space is hexadecimal 20.

BCX Help on the BCXBASICCoders website is also a real space.

Here's the HTML code for that h2 line

Code Select Expand

<h2><span class="ob">CALLBACK</span> <span class="d">FUNCTION</span> ... <span class="d">END FUNCTION</span> procedure</h2>

In Example 3, there is a sentence in which the HTML code of "CALLBACK" is split from "FUNCTION" by a CRLF instead of a space. Here is the sentence in HTML code

Code Select Expand

The <a class="x" href="functionsubs.htm#callback"><span class="ob">CALLBACK</span></a>
<a class="x" href="functionsubs.htm#func"><span class="d">FUNCTION</span></a>
restricts typing to only numbers into the control and also allows the TAB key to tab out of it.

Other than that I can not imagine what is causing the behavior on your system.

[Quin]

Robert,
It's the H2 under the h1 that says "SSubclassing Windows Controls". Select the text and copy it, you'll see the missing space:

CALLBACKFUNCTION ... END FUNCTION procedure
Purpose:

[Robert]

Hi Robert,
In the documentation for subclassing Windows controls, the heading that gives the syntax for CALLBACK FUNCTION ... END FUNCTION is missing a real space between the keywords CALLBACK and FUNCTION. This got fixed in a lot of places in the BCX docs, but it still exists here.
Additionally, the example C translation is missing the closing }. It should be:

Code Select Expand

LRESULT CALLBACK CBFuncName(HWND hWnd, UINT Msg, WPARAM wParam, LPARAM lParam)
{
 [Statements];

 return DefWindowProc(hWnd, Msg, wParam, lParam); // CallBackFlag
}
Thanks!

Hi Quin:

I can not locate, anywhere, the unreal space between the keywords CALLBACK and FUNCTION.

I have corrected the missing brace in the C Code translation.

Thanks.

[Quin]

Hi Robert,
In the documentation for subclassing Windows controls, the heading that gives the syntax for CALLBACK FUNCTION ... END FUNCTION is missing a real space between the keywords CALLBACK and FUNCTION. This got fixed in a lot of places in the BCX docs, but it still exists here.
Additionally, the example C translation is missing the closing }. It should be:

Code Select Expand

LRESULT CALLBACK CBFuncName(HWND hWnd, UINT Msg, WPARAM wParam, LPARAM lParam)
{
 [Statements];

 return DefWindowProc(hWnd, Msg, wParam, lParam); // CallBackFlag
}
Thanks!