Skip to content

Give the visual editor screenshots real alt text #2195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cwickham merged 2 commits into from
Sep 23, 2026
+7 −7
Merged

Give the visual editor screenshots real alt text #2195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70e89d1
Give the visual editor screenshots real alt text
cwickham Sep 22, 2026
50df3aa
Fix the alt text for the Zotero group library screenshot
cwickham Sep 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/tools/_code-oss-visual-editor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Options enable configuration of appearance (font size, content width, etc.), mar

Zotero references will also show up automatically in visual editor completions:

<img src="/docs/visual-editor/images/visual-editing-citation-completions.png" width="426" fig-alt="Someone has typed &apos;@&apos; in the Visual Editor. In light gray to the right of the &apos;@&apos; is a magnifying glass followed by the text &apos;or DOI&apos;. Underneath this is a pop-up menu showing available citations. Each citation has a title of the form &apos;@citation&apos; in black, the title of the cited material in gray underneath it, an icon to the left, and the reference to the right in gray. Some of the icons have a small red &apos;Z&apos; on the bottom right corner, indicating that the corresponding reference comes from a Zotero library."/>
![](/docs/visual-editor/images/visual-editing-citation-completions.png){width="426" fig-alt="Someone has typed '@' in the Visual Editor. In light gray to the right of the '@' is a magnifying glass followed by the text 'or DOI'. Underneath this is a pop-up menu showing available citations. Each citation has a title of the form '@citation' in black, the title of the cited material in gray underneath it, an icon to the left, and the reference to the right in gray. Some of the icons have a small red 'Z' on the bottom right corner, indicating that the corresponding reference comes from a Zotero library."}

Items from Zotero will appear alongside items from your bibliography with a small "Z" logo juxtaposed over them. If you insert a citation from Zotero that isn't already in your bibliography then it will be automatically added to the bibliography.

Expand Down
6 changes: 3 additions & 3 deletions docs/visual-editor/options.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ If you are at the beginning of a line (as displayed above) you can also enter pl

You can customize visual editing options within **R Markdown -> Visual** (note that the visual editor was originally created for use with R Markdown so its options are located there --- these options are also applicable to usage with Quarto):

<img src="images/visual-editing-options.png" class="illustration" width="585" fig-alt="The global options window in RStudio. It is currently displaying the Visual subsection of the R Markdown section."/>
![](images/visual-editing-options.png){.illustration width="585" fig-alt="The global options window in RStudio. It is currently displaying the Visual subsection of the R Markdown section."}

| Option | Description |
|-----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand All @@ -84,7 +84,7 @@ You can customize visual editing options within **R Markdown -> Visual** (note t

You can customize visual editor citation options within **R Markdown -> Citations**:

<img src="images/visual-editing-options-citations.png" class="illustration" width="585" fig-alt="The global options window in RStudio. It is currently displaying the Citation subsection of the R Markdown section."/>
![](images/visual-editing-options-citations.png){.illustration width="585" fig-alt="The global options window in RStudio. It is currently displaying the Citation subsection of the R Markdown section."}

| Option | Description |
|--------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand All @@ -97,7 +97,7 @@ You can customize visual editor citation options within **R Markdown -> Citation

Global options that affect the way markdown is written can also be customized on a per-project basis. You can do this using the **R Markdown** pane of the **Project Options** dialog:

<img src="images/visual-editing-project-options.png" class="illustration" width="541" fig-alt="The Project Options dialog in RStudio. It is currently displaying the R Markdown section."/>
![](images/visual-editing-project-options.png){.illustration width="541" fig-alt="The Project Options dialog in RStudio. It is currently displaying the R Markdown section."}

By default projects inherit the current global settings for markdown writing and Zotero libraries.

Expand Down
6 changes: 3 additions & 3 deletions docs/visual-editor/technical.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ Note that for PubMed queries you can use the full supported query syntax. For ex

Zotero references will also show up automatically in completions:

<img src="images/visual-editing-citation-completions.png" width="426" fig-alt="Someone has typed &apos;@&apos; in the Visual Editor. In light gray to the right of the &apos;@&apos; is a magnifying glass followed by the text &apos;or DOI&apos;. Underneath this is a pop-up menu showing available citations. Each citation has a title of the form &apos;@citation&apos; in black, the title of the cited material in gray underneath it, an icon to the left, and the reference to the right in gray. Some of the icons have a small red &apos;Z&apos; on the bottom right corner, indicating that the corresponding reference comes from a Zotero library."/>
![](images/visual-editing-citation-completions.png){width="426" fig-alt="Someone has typed '@' in the Visual Editor. In light gray to the right of the '@' is a magnifying glass followed by the text 'or DOI'. Underneath this is a pop-up menu showing available citations. Each citation has a title of the form '@citation' in black, the title of the cited material in gray underneath it, an icon to the left, and the reference to the right in gray. Some of the icons have a small red 'Z' on the bottom right corner, indicating that the corresponding reference comes from a Zotero library."}

Items from Zotero will appear alongside items from your bibliography with a small "Z" logo juxtaposed over them. If you insert a citation from Zotero that isn't already in your bibliography then it will be automatically added to the bibliography.

Expand All @@ -244,7 +244,7 @@ If you are running both RStudio and Zotero on your desktop, then no additional c

For example, here we specify a project-level option to use the *Reproducible Research Series (Year 1)* group library:

<img src="images/visual-editing-citation-zotero-group.png" class="illustration" width="543" fig-alt="The Project Options pane in RStudio. The R Markdown section is selected. Under the &apos;Visual Mode: Zotero&apos; options, there is an option labeled &apos;Use libraries&apos; followed by a drop down menu with the value &apos;Selected Libraries&apos; currently selected. Underneath this is a white box different library options and buttons to select them. The &apos;My Library&apos; option is unselected and the &apos;Reproducible Research Series (Year 1) option is selected."/>
![](images/visual-editing-citation-zotero-group.png){.illustration width="543" fig-alt="The Project Options pane in RStudio. The R Markdown section is selected. Under the 'Visual Mode: Zotero' options, there is an option labeled 'Use libraries' followed by a drop down menu with the value 'Selected Libraries' currently selected. Underneath this is a white box that lists the libraries, each with a checkbox. The 'My Library' option is unselected and the 'Reproducible Research Series (Year 1)' option is selected."}

You can also specify one or more libraries within YAML. For example:

Expand Down Expand Up @@ -288,7 +288,7 @@ Be sure to **record your key** after generating it (i.e. copy it to the clipboar

Finally, go to the **R Markdown -\> Citations** preferences to connect Zotero to RStudio using your key:

<img src="images/visual-editing-citations-zotero-options.png" class="illustration" width="585" fig-alt="The global options menu in R Studio. The Citations subsection of the R Markdown section is selected, and there is a value pasted into the &apos;Zotero Web API Key&apos; box."/>
![](images/visual-editing-citations-zotero-options.png){.illustration width="585" fig-alt="The global options menu in R Studio. The Citations subsection of the R Markdown section is selected, and there is a value pasted into the 'Zotero Web API Key' box."}

Set the Zotero Library option to "Web", then paste in your Zotero Web API Key. You can use **Verify Key...** button to confirm that your Zotero API key is working correctly.

Expand Down
Loading