Add note on embedded titles

ScotGovAnalysis · May 16, 2023 · 6d99f9d · 6d99f9d
1 parent 6ab5e33
commit 6d99f9d
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -123,6 +123,8 @@ gapminder |>
   )
 ```
 
+**Note on use of titles, subtitles and captions** <br>
+Titles, subtitles and captions have been embedded in these example charts for demonstration purposes. However, for accessibility reasons, it is usually preferable to provide titles in the body of the page rather than embedded within the image of the plot. More information is available in the [accessibility article](https://datasciencescotland.github.io/sgplot/articles/accessibility.html#other-accessibility-considerations).
 
 ## Licence
 

diff --git a/README.md b/README.md
@@ -129,6 +129,14 @@ gapminder |>
 
 <img src="man/figures/README-ex2-1.svg" alt="A bar chart with white background, light grey horizontal grid lines dark blue bars."  />
 
+**Note on use of titles, subtitles and captions** <br> Titles, subtitles
+and captions have been embedded in these example charts for
+demonstration purposes. However, for accessibility reasons, it is
+usually preferable to provide titles in the body of the page rather than
+embedded within the image of the plot. More information is available in
+the [accessibility
+article](https://datasciencescotland.github.io/sgplot/articles/accessibility.html#other-accessibility-considerations).
+
 ## Licence
 
 Unless stated otherwise, the codebase is released under [the MIT