From 4ba34c5b7efbe54e7df617f78f6e61c85c2d263b Mon Sep 17 00:00:00 2001 From: Kate Isaac <41767733+kweav@users.noreply.github.com> Date: Wed, 17 Sep 2025 17:09:10 -0400 Subject: [PATCH 1/9] Update more_features.Rmd Updating some borrow_chapter info --- more_features.Rmd | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/more_features.Rmd b/more_features.Rmd index 847bcae..b092ab7 100644 --- a/more_features.Rmd +++ b/more_features.Rmd @@ -142,7 +142,7 @@ If you have two courses where the content and topics overlap, you may want to sh However, sharing material by copying and pasting can lead to maintenance issues, as updating one would require remembering to update the other as well! 😱 In OTTR, we try to minimize maintenance pains. To get around this, we use `cow::borrow_chapter()` from the [jhudsl/cow](https://jhudatascience.org/cow/index.html) package. -The `cow` package is already on the `jhudsl/course_template` Docker image so you do not need to install it if you are using the Docker image or if you are have GitHub Actions do all the rendering for you. +The `cow` package is already on the `jhudsl/base_ottr` Docker image so you do not need to install it if you are using the Docker image or if you are have GitHub Actions do all the rendering for you. To borrow a chapter from another course, create an `.Rmd` as you normally would, with a `ottrpal::set_knitr_image_path()` in a chunk at the beginning of the file and a [`H1` title](https://www.markdownguide.org/basic-syntax/). @@ -171,17 +171,7 @@ cow::borrow_chapter( ### Borrowing from a private repository -If you are borrowing from a course in a private repository, you will need to supply a [GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) using a `git_pat` argument like this: - -Have your chunk arguments include:`{r, echo = FALSE, results='asis'}` - -``` -cow::borrow_chapter( - doc_path = "02-chapter_of_course.Rmd", - repo_name = "jhudsl/Private_Repo", - git_pat = "12345" -) -``` +Borrowing from a private repository is not supported. ### Removing an h1 header From 6d899ec3b0e54d8506563a6f6c486a8aae428a3f Mon Sep 17 00:00:00 2001 From: Kate Isaac <41767733+kweav@users.noreply.github.com> Date: Wed, 17 Sep 2025 17:18:39 -0400 Subject: [PATCH 2/9] Update writing_content_courses.Rmd for include_slide updating the formatting requirements for include_slide --- writing_content_courses.Rmd | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/writing_content_courses.Rmd b/writing_content_courses.Rmd index bb0589c..0ac10bc 100644 --- a/writing_content_courses.Rmd +++ b/writing_content_courses.Rmd @@ -540,7 +540,12 @@ bar: ![](https://raw.githubusercontent.com/ottrproject/OTTR_Template/main/resources/screenshots/slide_url.png) -Additionally, include notes (similar to the fig.alt text) for each slide in the Google Slides presentation, describing the content and images of the slide. This will enable accessibility for individuals with visual impairments, as the notes can be converted into audio. Please note that line breaks are not allowed within the fig.alt text. If there are no line breaks, the text should appear in blue within the code chunk. +Additionally, include notes (similar to the fig.alt text) for each slide in the Google Slides presentation, describing the content and images of the slide. This will enable accessibility for individuals with visual impairments, as the notes can be converted into audio. + +Please note the following formatting requirements for the fig.alt argument when using `include_slide()`: + +* line breaks are not allowed within the fig.alt text. (If there are no line breaks, the text should appear in blue within the code chunk.) +* If you need to put quotes around a phrase within the fig.alt text, use single quotation marks for that particular phrase and use double quotation marks around the whole of the fig.alt text. The code chunk option `echo=FALSE` ensures that the R code is hidden from your course, while the code chunk option `out.width = "100%"` is used to size the image. We generally From 37840ffa10137a0bfd46f089fd2c4062323f7b03 Mon Sep 17 00:00:00 2001 From: Kate Isaac <41767733+kweav@users.noreply.github.com> Date: Wed, 17 Sep 2025 17:43:50 -0400 Subject: [PATCH 3/9] Update faqs.Rmd to include description of slides not rendering --- faqs.Rmd | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/faqs.Rmd b/faqs.Rmd index 3a64077..b3cfda0 100644 --- a/faqs.Rmd +++ b/faqs.Rmd @@ -46,6 +46,14 @@ Your Google Slides presentation you have tried to retrieve a slide from with `ot *** +### You observe the code for `include_slide()` or `` rather than the Google Slide image. + +Check the formatting of the code chunk, particularly paying attention to the `fig.alt` argument. Respectively for those issues, make sure there are no linebreaks and that you don't have double quotation marks surrounding a subphrase or word in the `fig.alt` text. + +The *correct way* to put quotation marks within the argument for fig.alt is `fig.alt = "This is an example sentence where I want to bring attention to 'this specific phrase' and not the rest of it."`. Using single quotation marks around the whole thing with double quotation marks inside *won't work* as shown in this example: `fig.alt = 'This is an example sentence where I want to bring attention to "this specific phrase" and not the rest of it.'` + +*** + ### `Process completed with exit code 1.`: Spell check/url check/quiz format fail: Underneath a section that says something like: `**Check spelling/url/quiz errors - fail if too many of them**` you may see something like: From 58a45978220e1bdb791d605f44fa282949ae2aaa Mon Sep 17 00:00:00 2001 From: Kate Isaac <41767733+kweav@users.noreply.github.com> Date: Thu, 25 Sep 2025 15:47:00 -0400 Subject: [PATCH 4/9] Update faqs.Rmd Co-authored-by: Carrie Wright <23014755+carriewright11@users.noreply.github.com> --- faqs.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/faqs.Rmd b/faqs.Rmd index b3cfda0..15f06d9 100644 --- a/faqs.Rmd +++ b/faqs.Rmd @@ -50,7 +50,7 @@ Your Google Slides presentation you have tried to retrieve a slide from with `ot Check the formatting of the code chunk, particularly paying attention to the `fig.alt` argument. Respectively for those issues, make sure there are no linebreaks and that you don't have double quotation marks surrounding a subphrase or word in the `fig.alt` text. -The *correct way* to put quotation marks within the argument for fig.alt is `fig.alt = "This is an example sentence where I want to bring attention to 'this specific phrase' and not the rest of it."`. Using single quotation marks around the whole thing with double quotation marks inside *won't work* as shown in this example: `fig.alt = 'This is an example sentence where I want to bring attention to "this specific phrase" and not the rest of it.'` +The *correct way* to put quotation marks within the argument for fig.alt is `fig.alt = "This is an example sentence where I want to bring attention to 'this specific phrase' and not the rest of it."`. Using single quotation marks around the whole argument with double quotation marks inside *won't work* as shown in this example: `fig.alt = 'This is an example sentence where I want to bring attention to "this specific phrase" and not the rest of it.'` *** From 9eff3388600b8724912c8a0b7884a368e03dacb2 Mon Sep 17 00:00:00 2001 From: Kate Isaac <41767733+kweav@users.noreply.github.com> Date: Thu, 25 Sep 2025 15:47:51 -0400 Subject: [PATCH 5/9] Update faqs.Rmd Co-authored-by: Carrie Wright <23014755+carriewright11@users.noreply.github.com> --- faqs.Rmd | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/faqs.Rmd b/faqs.Rmd index 15f06d9..8707437 100644 --- a/faqs.Rmd +++ b/faqs.Rmd @@ -48,7 +48,12 @@ Your Google Slides presentation you have tried to retrieve a slide from with `ot ### You observe the code for `include_slide()` or `` rather than the Google Slide image. -Check the formatting of the code chunk, particularly paying attention to the `fig.alt` argument. Respectively for those issues, make sure there are no linebreaks and that you don't have double quotation marks surrounding a subphrase or word in the `fig.alt` text. +Check the formatting of the code chunk, particularly paying attention to the `fig.alt` argument. + +Make sure there are: + +- no line breaks +- no double quotation marks surrounding a subphrase or word in the `fig.alt` text (instead use single quotes) The *correct way* to put quotation marks within the argument for fig.alt is `fig.alt = "This is an example sentence where I want to bring attention to 'this specific phrase' and not the rest of it."`. Using single quotation marks around the whole argument with double quotation marks inside *won't work* as shown in this example: `fig.alt = 'This is an example sentence where I want to bring attention to "this specific phrase" and not the rest of it.'` From a51b7479ebd3439bc26d617cff49ec67f6ad1a1b Mon Sep 17 00:00:00 2001 From: Carrie Wright <23014755+carriewright11@users.noreply.github.com> Date: Thu, 30 Oct 2025 13:29:13 -0400 Subject: [PATCH 6/9] Apply suggestion from @carriewright11 --- faqs.Rmd | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/faqs.Rmd b/faqs.Rmd index 8707437..5518554 100644 --- a/faqs.Rmd +++ b/faqs.Rmd @@ -53,7 +53,24 @@ Check the formatting of the code chunk, particularly paying attention to the `fi Make sure there are: - no line breaks -- no double quotation marks surrounding a subphrase or word in the `fig.alt` text (instead use single quotes) +- only **one type** of quotation marks used in `fig.alt` (either all single or all double quotes) + +Examples: + +`fig.alt = "This is an example sentence where I want to bring attention to "this specific phrase" and not the rest of it."` + +or + +`fig.alt = 'This is an example sentence where I want to bring attention to 'this specific phrase' and not the rest of it.'` + +
Click for more information +Options for correct formatting of quotation marks within the `fig.alt` text argument: + - Double quotation marks surrounding the whole argument with double quotation marks around any specific phrases within the argument + - Single quotation marks surround the whole argument with single quotation marks around any specific phrases within the argument + - Double quotation marks surrounding the whole argument with single quotation marks around any specific phrases within the argument (this will also work) + +Note: Single quotation marks surrounding the whole argument with double quotation marks around specific phrases within the argument will cause issues that may be not be as obvious at first. It will cause the images to not be properly rendered. +
The *correct way* to put quotation marks within the argument for fig.alt is `fig.alt = "This is an example sentence where I want to bring attention to 'this specific phrase' and not the rest of it."`. Using single quotation marks around the whole argument with double quotation marks inside *won't work* as shown in this example: `fig.alt = 'This is an example sentence where I want to bring attention to "this specific phrase" and not the rest of it.'` From 4418299f8d651ec3458aa3c52ab9598d48aebd48 Mon Sep 17 00:00:00 2001 From: Carrie Wright <23014755+carriewright11@users.noreply.github.com> Date: Thu, 30 Oct 2025 13:30:34 -0400 Subject: [PATCH 7/9] Apply suggestion from @carriewright11 --- faqs.Rmd | 1 - 1 file changed, 1 deletion(-) diff --git a/faqs.Rmd b/faqs.Rmd index 5518554..f887a34 100644 --- a/faqs.Rmd +++ b/faqs.Rmd @@ -72,7 +72,6 @@ Options for correct formatting of quotation marks within the `fig.alt` text argu Note: Single quotation marks surrounding the whole argument with double quotation marks around specific phrases within the argument will cause issues that may be not be as obvious at first. It will cause the images to not be properly rendered. -The *correct way* to put quotation marks within the argument for fig.alt is `fig.alt = "This is an example sentence where I want to bring attention to 'this specific phrase' and not the rest of it."`. Using single quotation marks around the whole argument with double quotation marks inside *won't work* as shown in this example: `fig.alt = 'This is an example sentence where I want to bring attention to "this specific phrase" and not the rest of it.'` *** From c53439098ca97b0e04a1c67d89c0d3d16518f55b Mon Sep 17 00:00:00 2001 From: Carrie Wright <23014755+carriewright11@users.noreply.github.com> Date: Thu, 30 Oct 2025 13:31:08 -0400 Subject: [PATCH 8/9] Apply suggestion from @carriewright11 --- faqs.Rmd | 1 + 1 file changed, 1 insertion(+) diff --git a/faqs.Rmd b/faqs.Rmd index f887a34..e56411d 100644 --- a/faqs.Rmd +++ b/faqs.Rmd @@ -65,6 +65,7 @@ or
Click for more information Options for correct formatting of quotation marks within the `fig.alt` text argument: + - Double quotation marks surrounding the whole argument with double quotation marks around any specific phrases within the argument - Single quotation marks surround the whole argument with single quotation marks around any specific phrases within the argument - Double quotation marks surrounding the whole argument with single quotation marks around any specific phrases within the argument (this will also work) From 2954dd3925e5b28b382072c114d11e05060408a1 Mon Sep 17 00:00:00 2001 From: Carrie Wright <23014755+carriewright11@users.noreply.github.com> Date: Thu, 30 Oct 2025 13:31:55 -0400 Subject: [PATCH 9/9] Apply suggestion from @carriewright11 --- writing_content_courses.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/writing_content_courses.Rmd b/writing_content_courses.Rmd index 0ac10bc..d6a0ee3 100644 --- a/writing_content_courses.Rmd +++ b/writing_content_courses.Rmd @@ -545,7 +545,7 @@ Additionally, include notes (similar to the fig.alt text) for each slide in the Please note the following formatting requirements for the fig.alt argument when using `include_slide()`: * line breaks are not allowed within the fig.alt text. (If there are no line breaks, the text should appear in blue within the code chunk.) -* If you need to put quotes around a phrase within the fig.alt text, use single quotation marks for that particular phrase and use double quotation marks around the whole of the fig.alt text. +* If you need to put quotes around a phrase within the fig.alt text, stick with the same type (single or double) as used around the full fig.alt text. The code chunk option `echo=FALSE` ensures that the R code is hidden from your course, while the code chunk option `out.width = "100%"` is used to size the image. We generally