Help file suggestion

[Quin]

Hi,
Would it be possible to turn the ANSI/ASCII tables in the CHM help file into actual proper HTML tables? i.e. <table>...</table>. Currently with the way they're laid out, they're out-of-order and it's nearly impossible for a screen reader user like myself to utilize them.
Also, I found a tiny typo in the help, I think it's probably just worth putting it here: In the PoFMT command line options, there's an extra r before the description of /o:

/O
rSpecifies the name of the output file.

Thanks!

[John Z]

Hi Quin,

Could you be more specific?  If you access the help file clicking on ANSI or ASCII tables then choose view source it shows <table ..<tr>.<td..</td>...</tr>... </table> so it conforms, as it must, to the .chm format and is 'proper html'.  It is displayed in the most common orientation found for this type of table.

Perhaps using the source you can change it, then it can be tested to be compatible with .chm (I can help with the testing).  If tests ok it could then be sent to Pelle to see if he could include it as a replacement or additional page with that format.

My guess is you want 0 - 63 across the top with 8 horizontal rows (2 rows each group)

John Z

[Pelle]

I have fixed the typo. Thanks!

[Quin]

Hi Quin,

Could you be more specific?  If you access the help file clicking on ANSI or ASCII tables then choose view source it shows <table ..<tr>.<td..</td>...</tr>... </table> so it conforms, as it must, to the .chm format and is 'proper html'.  It is displayed in the most common orientation found for this type of table.

Perhaps using the source you can change it, then it can be tested to be compatible with .chm (I can help with the testing).  If tests ok it could then be sent to Pelle to see if he could include it as a replacement or additional page with that format.

My guess is you want 0 - 63 across the top with 8 horizontal rows (2 rows each group)

John Z

Hi,
Sorry for not being more specific. You're right that it is indeed an HTML table. However, there is no <thead> tag, so screen readers are entirely missing what the columns are, and as such don't actually render it as a table.

[Quin]

I have fixed the typo. Thanks!

Awesome, thanks Pelle! I found another one too, in the Translation phases section of the C language documentation, proceeds has an extra e in it, and is written as "The translation proceedes".

[John Z]

Hi Quin,

However, there is no <thead> tag, so screen readers are entirely missing what the columns are, and as such don't actually render it as a table.

Can your screen reader successfully read the attached file?  If so I'll try it in a .chm file.
If it works I'll modify the other table and submit to Pelle for consideration.
It needs testing as I am not well versed in HTML  but have done many .chm help files.

John Z

[Pelle]

Awesome, thanks Pelle! I found another one too, in the Translation phases section of the C language documentation, proceeds has an extra e in it, and is written as "The translation proceedes".

English is not my native language, and there are currently three e in that word, but I guess what you say is that "The translation proceedes in the following ..." should really be "The translation proceeds in the following ...". Correct?

[John Z]

It is actually a tricky case.  'proceeds' in English actually means 'funds received' from a transaction. 

In this case it is (improperly) trying to imply or mean 'continues', or 'goes on', most might understand the intent.

The correct (imo) sentence should be:
"The translation will proceed in the following ...".
or to remove any ambiguity
"The translation continues in the following ...".

John Z

[Pelle]

OK, thanks. I will proceed then with "The translation continues ..." 

[Quin]

Hi Quin,

However, there is no <thead> tag, so screen readers are entirely missing what the columns are, and as such don't actually render it as a table.

Can your screen reader successfully read the attached file?  If so I'll try it in a .chm file.
If it works I'll modify the other table and submit to Pelle for consideration.
It needs testing as I am not well versed in HTML  but have done many .chm help files.

John Z

Hi,
Yes, this reads great! Something like this for the tables in the help file would be fantastic!

[Quin]

OK, thanks. I will proceed then with "The translation continues ..." 

Sounds perfect to me!

[Quin]

Hi,
This suggestion about the tables extends to far more than just the Ascii table. I see tables that aren't properly screen reader navigable in the integer constants and PoInst format of script files sections just at a quick glance. I'm assuming it's pretty much all <table> elements in the HTML.
Thanks!

[Robert]

Hi,
This suggestion about the tables extends to far more than just the Ascii table. I see tables that aren't properly screen reader navigable in the integer constants and PoInst format of script files sections just at a quick glance. I'm assuming it's pretty much all <table> elements in the HTML.
Thanks!

Hi Quin:

Yes, the problem is in the <td> ... </td> instead of <th> ... </th> tags used for the header row in each of the tables. Instead of, for example,

Code Select Expand

  <tr>
    <td class="h">Option</td>
    <td class="h">Description</td>
  </tr>
the following should be used

Code Select Expand

  <tr>
    <th class="h">Option</th>
    <th class="h">Description</th>
  </tr>

A good reference for these specific accessibility concerns is this link:
https://www.w3.org/WAI/tutorials/tables/one-header/
part of the Web Accessibility Initiative of W3C, website at
https://www.w3.org/WAI/

Here is a link to a page that describes how a screen reader navigates a table.
https://tink.uk/how-screen-readers-navigate-data-tables/

[Quin]

Hi,
This suggestion about the tables extends to far more than just the Ascii table. I see tables that aren't properly screen reader navigable in the integer constants and PoInst format of script files sections just at a quick glance. I'm assuming it's pretty much all <table> elements in the HTML.
Thanks!

Hi Quin:

Yes, the problem is in the <td> ... </td> instead of <th> ... </th> tags used for the header row in each of the tables. Instead of, for example,

Code Select Expand

  <tr>
    <td class="h">Option</td>
    <td class="h">Description</td>
  </tr>
the following should be used

Code Select Expand

  <tr>
    <th class="h">Option</th>
    <th class="h">Description</th>
  </tr>

A good reference for these specific accessibility concerns is this link:
https://www.w3.org/WAI/tutorials/tables/one-header/
part of the Web Accessibility Initiative of W3C, website at
https://www.w3.org/WAI/

Here is a link to a page that describes how a screen reader navigates a table.
https://tink.uk/how-screen-readers-navigate-data-tables/

You're awesome Robert, you somehow have more resources for this than I, the actual blind developer!

[Quin]

Hey Pelle,
Found a couple other small typos for you:
This is from the root of the Pomake docs. I think the word should be supports, with an s at the end. Original:

The IDE only support a subset of the POMAKE syntax, for example no preprocessor directives.

New:

The IDE only supports a subset of the POMAKE syntax, for example no preprocessor directives.

In the project files reference section of the PoMake documentation, "than" is written as "that" in this sentence.

A long line may span more that one physical line in the file by immediately preceding the newline character with a backslash (like a C source file).

Should be:

A long line may span more than one physical line in the file by immediately preceding the newline character with a backslash (like a C source file).

Finally, in the PoCert documentation, certificate is missing an e at the end in this sentence. Original:

Useful in combination with POSIGN, for example to create a certificat for testing.

New:

Useful in combination with POSIGN, for example to create a certificate for testing.

Thanks!