diff --git a/faqs.Rmd b/faqs.Rmd index 3a64077..e56411d 100644 --- a/faqs.Rmd +++ b/faqs.Rmd @@ -44,6 +44,36 @@ _What does this mean?:_ Your Google Slides presentation you have tried to retrieve a slide from with `ottrpal::include_slide()` is not public. Your Google Slide document must be set to `Anyone with a link`. See [this article for more details.](https://support.wix.com/en/article/setting-permissions-for-google-drive-files-and-folders#:~:text=Settings%20Permissions%20for%20a%20Google,edit%20and%20comment%20as%20well.) The renders will fail if this is not set! See the [setting up images and graphics section](https://www.ottrproject.org/writing_content_courses.html#set-up-images) for more details. +*** + +### 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. + +Make sure there are: + +- no line breaks +- 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. +
+ + *** ### `Process completed with exit code 1.`: Spell check/url check/quiz format fail: 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 diff --git a/writing_content_courses.Rmd b/writing_content_courses.Rmd index bb0589c..d6a0ee3 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, 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