Skip to content

Commit

Permalink
Update manual to emphasize importance of checking/editing alt text
Browse files Browse the repository at this point in the history
  • Loading branch information
sbreitbart-NOAA committed Jan 22, 2025
1 parent 59be9e1 commit 9682059
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions vignettes/manual.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,15 @@ This manual is a work in progress. In the meantime, please read the function doc

## Updating alternative text and captions

When a plotting function (e.g., `plot_biomass()`, `table_indices()`, `exp_all_figs_tables()`) is run, placeholders within the plot's associated alternative text and captions are replaced with key quantities (see the [`asar` package's Accessibility vignette](https://nmfs-ost.github.io/asar/articles/accessibility_guide.html) and/or the [`satf::write_captions()` function](https://github.com/nmfs-ost/satf/blob/master/R/write_captions.R) for more details). As stated in the Accessibility vignette, *you should always check that these alternative texts and captions have been assembled correctly.*
When a plotting function (e.g., `plot_biomass()`, `table_indices()`, `exp_all_figs_tables()`) is run, placeholders within the plot's associated alternative text and captions are replaced with key quantities (see the [`asar` package's Accessibility vignette](https://nmfs-ost.github.io/asar/articles/accessibility_guide.html) and/or the [`satf::write_captions()` function](https://github.com/nmfs-ost/satf/blob/master/R/write_captions.R) for more details).

There are multiple reasons why you may want to edit these. For instance, maybe you entered an incorrect value for the units when running `plot_biomass()`. Maybe you need to add some extra information to the alternative text accurately describe the plot. In any case, here's what to do if you want to alter the alternative text and/or captions in `satf`, depending on what you wish to change:
As stated in the [Accessibility vignette's "Your to-do list" section](https://nmfs-ost.github.io/asar/articles/accessibility_guide.html#your-to-do-list), **you should always:**

**1. Check that these alternative texts and captions have been assembled correctly.**

**2. Write the final component of each figure’s alt text.**

Here's how to alter the alternative text and/or captions in `satf`, depending on what you wish to change:

### I want to add or remove text

Expand Down

0 comments on commit 9682059

Please sign in to comment.