From 0237e76a82932dea2862590f35459d16f17c306b Mon Sep 17 00:00:00 2001 From: mdisi2 <157818999+mdisi2@users.noreply.github.com> Date: Tue, 20 May 2025 11:24:33 -0500 Subject: [PATCH 1/5] Created Accessibility Standards --- manual/guides/Accessibility Standards | 80 +++++++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 manual/guides/Accessibility Standards diff --git a/manual/guides/Accessibility Standards b/manual/guides/Accessibility Standards new file mode 100644 index 00000000..291fba3c --- /dev/null +++ b/manual/guides/Accessibility Standards @@ -0,0 +1,80 @@ +--- +layout: manual +title: Accessibility Standards +subtitle: "Checklist for writing or creating figures." +permalink: /manual/guides/accessibility +--- + +# Accessibility Standards + +There are three key areas to consider while writing a document: + + - Color Blindness + - Font Choice + - Screen Reader Accessibility + - Figure Creation + +This guide will provide a checklist of what to look for while +writing as well as resources to help make your documents more +accesable. + +# Color Blindess + +Prior to picking a friendly color pallet, condsider using non-color means +to distinguish lines, such as linestyle or markers. Matplotlib already +has functions to do this within a plot for each data set. + +For specific color guidence, avoid combinations of red, green, brown, +and yellow for contrasting colors as most forms of colorblindness impact +the red and green cones in the eyes. Also avoid only using blues or purples +as contrasting colors. This is a usefull [tool](https://davidmathlogic.com/colorblind/#) +to check color blind friendliness in your pallets as well as creating good pallets +from scratch. + +# Font Choice + +Font choice relates to both the font itself as well as the contrast of the font +against the background. [WebAIM](https://webaim.org/resources/contrastchecker/) +is a tool to check if the contrast ratio meets the accesibility standards. Generally, +headings should have a contrast ratio of at least 3:1 and body text should be at least +4.5:1. If you forget, WebAIM will also tell you if the font passes. + +While choosing a font, consider these points + + - Sans Serif fonts are generally easier to read than Serif fonts + - Avoid thin, narrow fonts, or fonts with uneven heights between lowercase and capital letters + - Good font examples: Times New Roman, Arial, Verdana, Helvetica + +Additional information and tools for font accessibility are found at +[Section 508](https://www.section508.gov/develop/fonts-typography/), +[ADA Site Complience](https://adasitecompliance.com/accessible-fonts/), and +[UNC Greensboro’s Page on Fonts](https://accessibility.uncg.edu/make-content-accessible/design-elements/). + +# Screen Reader Accessibility + +Make sure to use common fonts that screen readers can recognize to make your documents +more friendly. Screen readers also often struggle with interpreting images that have no +metadata text. Alt text is relatively easy to add within Microsoft Word or HTML. Harvard +has some [suggested tools](https://accessibility.huit.harvard.edu/auto-tools-testing#free) +for checking webpage accessibility. + +However, in this group we generally use LaTeX and pdfs, and making these documents screen reader +friendly is generally much harder. Some suggested LaTex packages are accessibility, pdfcomment, +and axessibility - the latter being for equations. This [jounral](https://www.ams.org/journals/notices/202301/rnoti-p68.pdf) +and this [page](https://libguides.lib.msu.edu/c.php?g=995742&p=8207771) have more extensive advice. + +Overleaf also has an +[extensive page](https://www.overleaf.com/learn/latex/An_introduction_to_tagged_PDF_files%3A_internals_and_the_challenges_of_accessibility) +with additional advice dedicated to this topic. + +# Figure Creation + +Avoid the jet (rainbow) color scheme since it's not particularly accessible, and there are +better colormaps for conveying information. Think about what information you’re trying to +convey when choosing colors. Not all color palettes are created equal. Jet, for example, is not perceptually +uniform - i.e., colors near to each other look relatively similar, while colors far apart are distinct. + +With Matplotlib you can set the style of plots for a whole script with global parameters. + + + From 627506621a1ae3bb24e90fd39cb7d5a63cb0b472 Mon Sep 17 00:00:00 2001 From: mdisi2 <157818999+mdisi2@users.noreply.github.com> Date: Tue, 20 May 2025 11:25:39 -0500 Subject: [PATCH 2/5] Rename Accessibility Standards to accessibility_standards --- .../guides/{Accessibility Standards => accessibility_standards} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename manual/guides/{Accessibility Standards => accessibility_standards} (100%) diff --git a/manual/guides/Accessibility Standards b/manual/guides/accessibility_standards similarity index 100% rename from manual/guides/Accessibility Standards rename to manual/guides/accessibility_standards From 40f4ed0bbab6594a3f37afd9caaa9be9df003105 Mon Sep 17 00:00:00 2001 From: mdisi2 <157818999+mdisi2@users.noreply.github.com> Date: Tue, 20 May 2025 11:44:07 -0500 Subject: [PATCH 3/5] Update accessibility_standards --- manual/guides/accessibility_standards | 31 +++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/manual/guides/accessibility_standards b/manual/guides/accessibility_standards index 291fba3c..f3b7db4b 100644 --- a/manual/guides/accessibility_standards +++ b/manual/guides/accessibility_standards @@ -1,11 +1,11 @@ --- layout: manual title: Accessibility Standards -subtitle: "Checklist for writing or creating figures." +subtitle: "Guidelines for accessible writing and figure creation." permalink: /manual/guides/accessibility --- -# Accessibility Standards +## Accessibility Standards There are three key areas to consider while writing a document: @@ -18,7 +18,7 @@ This guide will provide a checklist of what to look for while writing as well as resources to help make your documents more accesable. -# Color Blindess +## 1. Color Blindess Prior to picking a friendly color pallet, condsider using non-color means to distinguish lines, such as linestyle or markers. Matplotlib already @@ -31,7 +31,7 @@ as contrasting colors. This is a usefull [tool](https://davidmathlogic.com/color to check color blind friendliness in your pallets as well as creating good pallets from scratch. -# Font Choice +## 2. Font Choice Font choice relates to both the font itself as well as the contrast of the font against the background. [WebAIM](https://webaim.org/resources/contrastchecker/) @@ -50,7 +50,7 @@ Additional information and tools for font accessibility are found at [ADA Site Complience](https://adasitecompliance.com/accessible-fonts/), and [UNC Greensboro’s Page on Fonts](https://accessibility.uncg.edu/make-content-accessible/design-elements/). -# Screen Reader Accessibility +## 3. Screen Reader Accessibility Make sure to use common fonts that screen readers can recognize to make your documents more friendly. Screen readers also often struggle with interpreting images that have no @@ -67,7 +67,7 @@ Overleaf also has an [extensive page](https://www.overleaf.com/learn/latex/An_introduction_to_tagged_PDF_files%3A_internals_and_the_challenges_of_accessibility) with additional advice dedicated to this topic. -# Figure Creation +## 4. Figure Creation Avoid the jet (rainbow) color scheme since it's not particularly accessible, and there are better colormaps for conveying information. Think about what information you’re trying to @@ -76,5 +76,24 @@ uniform - i.e., colors near to each other look relatively similar, while colors With Matplotlib you can set the style of plots for a whole script with global parameters. +```python +import matplotlib.pyplot as plt +plt.style.use(['dark_background','presentation']) +``` + +These global variables can be defined in a top-level file `*.mplstyle`. Matplotlib's +default style can be found [here](https://matplotlib.org/stable/users/explain/customizing.html#the-default-matplotlibrc-file) +while Nathan Ryan's better style file can be found [here](https://drive.google.com/file/d/1lV1IJgUo_V6rs7PCg5ccO6TK2ziaOM-_/view) + +5. Additional Reading + + - Zoey's Accsesbility [Slideshow](https://docs.google.com/presentation/d/e/2PACX-1vTQ6AyYOjNiIIyojh97CZJ7v9-FwkfurTOA9E0pxQ2e5bz1xfKxZP_K3P1RA8l81d6FgFhMPjLfdiBU/pub?start=false&loop=false&delayms=3000) + - Nathan's Plots [Guide](https://arfc.github.io/manual/guides/plots/) + - '[Simple Tools for Mastering Color in Scientific Figures](https://www.molecularecologist.com/2020/04/23/simple-tools-for-mastering-color-in-scientific-figures/)' + - '[Best Color Palettes for Scientific Figures and Data Visualizations](https://www.simplifiedsciencepublishing.com/resources/best-color-palettes-for-scientific-figures-and-data-visualizations)' + - '[How To Choose a Color Scheme for Your Scientific Figure](https://sites.northwestern.edu/researchcomputing/2022/05/20/how-to-choose-a-color-scheme-for-your-scientific-figure/)' + - '[Introduction to the Viridis Color Map](https://cran.r-project.org/web/packages/viridis/vignettes/intro-to-viridis.html)' + - '[Why you should use Viridis and not Jet (rainbow) as a colormap](https://www.domestic-engineering.com/drafts/viridis/viridis.html)' + From dcb93299249a88aad6620d534bb8c684b2c2c739 Mon Sep 17 00:00:00 2001 From: mdisi2 <157818999+mdisi2@users.noreply.github.com> Date: Tue, 20 May 2025 11:47:27 -0500 Subject: [PATCH 4/5] Update accessibility_standards --- manual/guides/accessibility_standards | 39 +++++++++++++-------------- 1 file changed, 18 insertions(+), 21 deletions(-) diff --git a/manual/guides/accessibility_standards b/manual/guides/accessibility_standards index f3b7db4b..f9f52d99 100644 --- a/manual/guides/accessibility_standards +++ b/manual/guides/accessibility_standards @@ -16,33 +16,33 @@ There are three key areas to consider while writing a document: This guide will provide a checklist of what to look for while writing as well as resources to help make your documents more -accesable. +accessible. -## 1. Color Blindess +## 1. Color Blindness -Prior to picking a friendly color pallet, condsider using non-color means +Before picking a friendly color palette, consider using non-color means to distinguish lines, such as linestyle or markers. Matplotlib already has functions to do this within a plot for each data set. -For specific color guidence, avoid combinations of red, green, brown, -and yellow for contrasting colors as most forms of colorblindness impact -the red and green cones in the eyes. Also avoid only using blues or purples -as contrasting colors. This is a usefull [tool](https://davidmathlogic.com/colorblind/#) -to check color blind friendliness in your pallets as well as creating good pallets +For specific color guidance, avoid combinations of red, green, brown, +and yellow for contrasting colors, as most forms of colorblindness impact +the red and green cones in the eyes. Also, avoid only using blues or purples +as contrasting colors. This is a useful [tool](https://davidmathlogic.com/colorblind/#) +to check color blind friendliness in your palate as well as creating good pallets from scratch. ## 2. Font Choice -Font choice relates to both the font itself as well as the contrast of the font +Font choice relates to both the font itself and the contrast of the font against the background. [WebAIM](https://webaim.org/resources/contrastchecker/) -is a tool to check if the contrast ratio meets the accesibility standards. Generally, -headings should have a contrast ratio of at least 3:1 and body text should be at least +is a tool to check if the contrast ratio meets the accessibility standards. Generally, +headings should have a contrast ratio of at least 3:1, and body text should be at least 4.5:1. If you forget, WebAIM will also tell you if the font passes. -While choosing a font, consider these points +While choosing a font - consider: - Sans Serif fonts are generally easier to read than Serif fonts - - Avoid thin, narrow fonts, or fonts with uneven heights between lowercase and capital letters + - Avoid thin fonts, narrow fonts, or fonts with uneven heights between lowercase and capital letters - Good font examples: Times New Roman, Arial, Verdana, Helvetica Additional information and tools for font accessibility are found at @@ -58,8 +58,8 @@ metadata text. Alt text is relatively easy to add within Microsoft Word or HTML. has some [suggested tools](https://accessibility.huit.harvard.edu/auto-tools-testing#free) for checking webpage accessibility. -However, in this group we generally use LaTeX and pdfs, and making these documents screen reader -friendly is generally much harder. Some suggested LaTex packages are accessibility, pdfcomment, +However, in this group we generally use LaTeX and PDFs, and making these documents screen +reader-friendly is generally much harder. Some suggested LaTeX packages are accessibility, pdfcomment, and axessibility - the latter being for equations. This [jounral](https://www.ams.org/journals/notices/202301/rnoti-p68.pdf) and this [page](https://libguides.lib.msu.edu/c.php?g=995742&p=8207771) have more extensive advice. @@ -70,11 +70,11 @@ with additional advice dedicated to this topic. ## 4. Figure Creation Avoid the jet (rainbow) color scheme since it's not particularly accessible, and there are -better colormaps for conveying information. Think about what information you’re trying to +better color maps for conveying information. Think about what information you’re trying to convey when choosing colors. Not all color palettes are created equal. Jet, for example, is not perceptually uniform - i.e., colors near to each other look relatively similar, while colors far apart are distinct. -With Matplotlib you can set the style of plots for a whole script with global parameters. +With Matplotlib, you can set the style of plots for a whole script with global parameters. ```python import matplotlib.pyplot as plt @@ -87,13 +87,10 @@ while Nathan Ryan's better style file can be found [here](https://drive.google.c 5. Additional Reading - - Zoey's Accsesbility [Slideshow](https://docs.google.com/presentation/d/e/2PACX-1vTQ6AyYOjNiIIyojh97CZJ7v9-FwkfurTOA9E0pxQ2e5bz1xfKxZP_K3P1RA8l81d6FgFhMPjLfdiBU/pub?start=false&loop=false&delayms=3000) + - Zoey's Accessibility [Slideshow](https://docs.google.com/presentation/d/e/2PACX-1vTQ6AyYOjNiIIyojh97CZJ7v9-FwkfurTOA9E0pxQ2e5bz1xfKxZP_K3P1RA8l81d6FgFhMPjLfdiBU/pub?start=false&loop=false&delayms=3000) - Nathan's Plots [Guide](https://arfc.github.io/manual/guides/plots/) - '[Simple Tools for Mastering Color in Scientific Figures](https://www.molecularecologist.com/2020/04/23/simple-tools-for-mastering-color-in-scientific-figures/)' - '[Best Color Palettes for Scientific Figures and Data Visualizations](https://www.simplifiedsciencepublishing.com/resources/best-color-palettes-for-scientific-figures-and-data-visualizations)' - '[How To Choose a Color Scheme for Your Scientific Figure](https://sites.northwestern.edu/researchcomputing/2022/05/20/how-to-choose-a-color-scheme-for-your-scientific-figure/)' - '[Introduction to the Viridis Color Map](https://cran.r-project.org/web/packages/viridis/vignettes/intro-to-viridis.html)' - '[Why you should use Viridis and not Jet (rainbow) as a colormap](https://www.domestic-engineering.com/drafts/viridis/viridis.html)' - - - From 57b021841f4c87f35525b2fd712b45340e4ca8b2 Mon Sep 17 00:00:00 2001 From: mdisi2 <157818999+mdisi2@users.noreply.github.com> Date: Tue, 20 May 2025 11:58:37 -0500 Subject: [PATCH 5/5] Update to accessibility_standards.md --- ...y_standards => accessibility_standards.md} | 33 +++++++++---------- 1 file changed, 15 insertions(+), 18 deletions(-) rename manual/guides/{accessibility_standards => accessibility_standards.md} (72%) diff --git a/manual/guides/accessibility_standards b/manual/guides/accessibility_standards.md similarity index 72% rename from manual/guides/accessibility_standards rename to manual/guides/accessibility_standards.md index f9f52d99..19a98335 100644 --- a/manual/guides/accessibility_standards +++ b/manual/guides/accessibility_standards.md @@ -7,27 +7,24 @@ permalink: /manual/guides/accessibility ## Accessibility Standards -There are three key areas to consider while writing a document: - - Color Blindness - Font Choice - Screen Reader Accessibility - Figure Creation -This guide will provide a checklist of what to look for while -writing as well as resources to help make your documents more -accessible. +This guide will provide a checklist as well as resources to +make your documents more accessible. ## 1. Color Blindness Before picking a friendly color palette, consider using non-color means -to distinguish lines, such as linestyle or markers. Matplotlib already -has functions to do this within a plot for each data set. +to distinguish lines or datasets, such as linestyle or markers. Matplotlib +already has functions to do this within a plot for each dataset. For specific color guidance, avoid combinations of red, green, brown, -and yellow for contrasting colors, as most forms of colorblindness impact -the red and green cones in the eyes. Also, avoid only using blues or purples -as contrasting colors. This is a useful [tool](https://davidmathlogic.com/colorblind/#) +and yellow for contrasting colors - as most forms of colorblindness impact +the red and green cones of the eyes. Also, avoid only using blues or purples +as contrasting colors. 'Coloring for Colorbliness' is a useful [tool](https://davidmathlogic.com/colorblind/#) to check color blind friendliness in your palate as well as creating good pallets from scratch. @@ -60,7 +57,7 @@ for checking webpage accessibility. However, in this group we generally use LaTeX and PDFs, and making these documents screen reader-friendly is generally much harder. Some suggested LaTeX packages are accessibility, pdfcomment, -and axessibility - the latter being for equations. This [jounral](https://www.ams.org/journals/notices/202301/rnoti-p68.pdf) +and axessibility - the latter being for equations. This [journal](https://www.ams.org/journals/notices/202301/rnoti-p68.pdf) and this [page](https://libguides.lib.msu.edu/c.php?g=995742&p=8207771) have more extensive advice. Overleaf also has an @@ -83,14 +80,14 @@ plt.style.use(['dark_background','presentation']) These global variables can be defined in a top-level file `*.mplstyle`. Matplotlib's default style can be found [here](https://matplotlib.org/stable/users/explain/customizing.html#the-default-matplotlibrc-file) -while Nathan Ryan's better style file can be found [here](https://drive.google.com/file/d/1lV1IJgUo_V6rs7PCg5ccO6TK2ziaOM-_/view) +while Nathan Ryan's better style file can be found [here](https://drive.google.com/file/d/1lV1IJgUo_V6rs7PCg5ccO6TK2ziaOM-_/view). -5. Additional Reading +## 5. Additional Reading - Zoey's Accessibility [Slideshow](https://docs.google.com/presentation/d/e/2PACX-1vTQ6AyYOjNiIIyojh97CZJ7v9-FwkfurTOA9E0pxQ2e5bz1xfKxZP_K3P1RA8l81d6FgFhMPjLfdiBU/pub?start=false&loop=false&delayms=3000) - Nathan's Plots [Guide](https://arfc.github.io/manual/guides/plots/) - - '[Simple Tools for Mastering Color in Scientific Figures](https://www.molecularecologist.com/2020/04/23/simple-tools-for-mastering-color-in-scientific-figures/)' - - '[Best Color Palettes for Scientific Figures and Data Visualizations](https://www.simplifiedsciencepublishing.com/resources/best-color-palettes-for-scientific-figures-and-data-visualizations)' - - '[How To Choose a Color Scheme for Your Scientific Figure](https://sites.northwestern.edu/researchcomputing/2022/05/20/how-to-choose-a-color-scheme-for-your-scientific-figure/)' - - '[Introduction to the Viridis Color Map](https://cran.r-project.org/web/packages/viridis/vignettes/intro-to-viridis.html)' - - '[Why you should use Viridis and not Jet (rainbow) as a colormap](https://www.domestic-engineering.com/drafts/viridis/viridis.html)' + - [Simple Tools for Mastering Color in Scientific Figures](https://www.molecularecologist.com/2020/04/23/simple-tools-for-mastering-color-in-scientific-figures/) + - [Best Color Palettes for Scientific Figures and Data Visualizations](https://www.simplifiedsciencepublishing.com/resources/best-color-palettes-for-scientific-figures-and-data-visualizations) + - [How To Choose a Color Scheme for Your Scientific Figure](https://sites.northwestern.edu/researchcomputing/2022/05/20/how-to-choose-a-color-scheme-for-your-scientific-figure/) + - [Introduction to the Viridis Color Map](https://cran.r-project.org/web/packages/viridis/vignettes/intro-to-viridis.html) + - [Why you should use Viridis and not Jet (rainbow) as a colormap](https://www.domestic-engineering.com/drafts/viridis/viridis.html)