Abhi-1U / texor-rjarticle

Converting ‘LaTeX’ ‘R Journal’ Articles into ‘RJ-web-articles’
0 stars 0 forks source link

JG: Algorithms should be handled in an accessible way #7

Open hturner opened 1 year ago

hturner commented 1 year ago

Comment from @ajrgodfrey:

"Algorithm as figures" section. This takes something accessible and makes it into something inaccessible. Ideally the text of the algorithm would be kept and presented in the figure for all users (in a similar way to the handling of code). A less optimal solution would be to present it as an image but extract the text and put that in the alt text. As a temporary workaround the alt text could read "algorithm embedded in a image" so a person using a screen reader would know what they are missing out on.

hturner commented 1 year ago

Related minor issue from @ajrgodfrey

"Algorithms as figures" section: figure is not synonymous with graphic as a figure can be multiple graphics, or text, or code. So change section header to "Handling the algorithm environment" (this is also more specific, i.e. that "algorithm" refers to the LaTeX algorithm environment here).

Abhi-1U commented 1 year ago

A little bit of clarification on Algorithms:

"Algorithm" with reference to texor package is strongly pointing towards the algorithm2e graphics format. Other text based elements like theorems, non "algorithm2e" algorithms, propositions etc are treated as plain text by the package (at-least in the conversions I have made).

Currently there are only 3-4 articles with algorithm2e graphics (up-to 2018-2) like RJ-2017-060, RJ-2017-052,RJ-2016-032 So i might add the algorithm text as alt text for these if that's helpful ?

Normal algorithms such as in RJ-2014-002 will not be in image format.

Thanks for highlighting, that section needs to be a bit specific.

hturner commented 1 year ago

Thanks for the clarification. In that case, adding the algorithm text as alt text would be a good solution I think.

ajrgodfrey commented 1 year ago

yes

From: Heather Turner @.> Sent: Saturday, September 9, 2023 5:28 AM To: Abhi-1U/texor-rjarticle @.> Cc: Jonathan Godfrey @.>; Mention @.> Subject: Re: [Abhi-1U/texor-rjarticle] JG: Algorithms should be handled in an accessible way (Issue #7)

Thanks for the clarification. In that case, adding the algorithm text as alt text would be a good solution I think.

- Reply to this email directly, view it on GitHubhttps://github.com/Abhi-1U/texor-rjarticle/issues/7#issuecomment-1712004298, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ADCZKGRX2NY4EFJVA5QUFBDXZNISJANCNFSM6AAAAAA4PBEEFQ. You are receiving this because you were mentioned.Message ID: @.**@.>>