Skip to content

Commit e1da492

Browse files
Render course
1 parent f89e349 commit e1da492

4 files changed

Lines changed: 50 additions & 20 deletions

File tree

docs/customize-style.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -631,7 +631,7 @@ <h3>Changing the favicon</h3>
631631
will be used.</p>
632632
<pre><code>---
633633
title: &quot;Course Name &quot;
634-
date: &quot;August, 2025&quot;
634+
date: &quot;October, 2025&quot;
635635
site: bookdown::bookdown_site
636636
documentclass: book
637637
bibliography: [book.bib, packages.bib]

docs/faqs.html

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -615,6 +615,40 @@ <h3><code>file is not in PNG format</code>: Google Slides permissions
615615
<hr />
616616
</div>
617617
<div
618+
id="you-observe-the-code-for-include_slide-or-img-src...-...-rather-than-the-google-slide-image."
619+
class="section level3">
620+
<h3>You observe the code for <code>include_slide()</code> or
621+
<code>&lt;img src="...", ... &gt;</code> rather than the Google Slide
622+
image.</h3>
623+
<p>Check the formatting of the code chunk, particularly paying attention
624+
to the <code>fig.alt</code> argument.</p>
625+
<p>Make sure there are:</p>
626+
<ul>
627+
<li>no line breaks</li>
628+
<li>only <strong>one type</strong> of quotation marks used in
629+
<code>fig.alt</code> (either all single or all double quotes)</li>
630+
</ul>
631+
<p>Examples:</p>
632+
<p><code>fig.alt = "This is an example sentence where I want to bring attention to "this specific phrase" and not the rest of it."</code></p>
633+
<p>or</p>
634+
<p><code>fig.alt = 'This is an example sentence where I want to bring attention to 'this specific phrase' and not the rest of it.'</code></p>
635+
<details>
636+
<summary>
637+
Click for more information
638+
</summary>
639+
<p>Options for correct formatting of quotation marks within the
640+
<code>fig.alt</code> text argument:</p>
641+
<pre><code> - Double quotation marks surrounding the whole argument with double quotation marks around any specific phrases within the argument
642+
- Single quotation marks surround the whole argument with single quotation marks around any specific phrases within the argument
643+
- Double quotation marks surrounding the whole argument with single quotation marks around any specific phrases within the argument (this will also work)</code></pre>
644+
Note: Single quotation marks surrounding the whole argument with double
645+
quotation marks around specific phrases within the argument will cause
646+
issues that may be not be as obvious at first. It will cause the images
647+
to not be properly rendered.
648+
</details>
649+
<hr />
650+
</div>
651+
<div
618652
id="process-completed-with-exit-code-1.-spell-checkurl-checkquiz-format-fail"
619653
class="section level3">
620654
<h3><code>Process completed with exit code 1.</code>: Spell check/url

docs/more_features.html

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -724,9 +724,9 @@ <h2>Borrowing Chapters</h2>
724724
use <code>cow::borrow_chapter()</code> from the <a
725725
href="https://jhudatascience.org/cow/index.html">jhudsl/cow</a> package.
726726
The <code>cow</code> package is already on the
727-
<code>jhudsl/course_template</code> Docker image so you do not need to
728-
install it if you are using the Docker image or if you are have GitHub
729-
Actions do all the rendering for you.</p>
727+
<code>jhudsl/base_ottr</code> Docker image so you do not need to install
728+
it if you are using the Docker image or if you are have GitHub Actions
729+
do all the rendering for you.</p>
730730
<p>To borrow a chapter from another course, create an <code>.Rmd</code>
731731
as you normally would, with a
732732
<code>ottrpal::set_knitr_image_path()</code> in a chunk at the beginning
@@ -758,18 +758,7 @@ <h3>Borrowing from a local file</h3>
758758
</div>
759759
<div id="borrowing-from-a-private-repository" class="section level3">
760760
<h3>Borrowing from a private repository</h3>
761-
<p>If you are borrowing from a course in a private repository, you will
762-
need to supply a <a
763-
href="https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token">GitHub
764-
personal access token</a> using a <code>git_pat</code> argument like
765-
this:</p>
766-
<p>Have your chunk arguments
767-
include:<code>{r, echo = FALSE, results='asis'}</code></p>
768-
<pre><code>cow::borrow_chapter(
769-
doc_path = &quot;02-chapter_of_course.Rmd&quot;,
770-
repo_name = &quot;jhudsl/Private_Repo&quot;,
771-
git_pat = &quot;12345&quot;
772-
)</code></pre>
761+
<p>Borrowing from a private repository is not supported.</p>
773762
</div>
774763
<div id="removing-an-h1-header" class="section level3">
775764
<h3>Removing an h1 header</h3>

docs/writing_content_courses.html

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1042,10 +1042,17 @@ <h3>Adding images and graphics in text</h3>
10421042
<p>Additionally, include notes (similar to the fig.alt text) for each
10431043
slide in the Google Slides presentation, describing the content and
10441044
images of the slide. This will enable accessibility for individuals with
1045-
visual impairments, as the notes can be converted into audio. Please
1046-
note that line breaks are not allowed within the fig.alt text. If there
1047-
are no line breaks, the text should appear in blue within the code
1048-
chunk.</p>
1045+
visual impairments, as the notes can be converted into audio.</p>
1046+
<p>Please note the following formatting requirements for the fig.alt
1047+
argument when using <code>include_slide()</code>:</p>
1048+
<ul>
1049+
<li>line breaks are not allowed within the fig.alt text. (If there are
1050+
no line breaks, the text should appear in blue within the code
1051+
chunk.)</li>
1052+
<li>If you need to put quotes around a phrase within the fig.alt text,
1053+
stick with the same type (single or double) as used around the full
1054+
fig.alt text.</li>
1055+
</ul>
10491056
<p>The code chunk option <code>echo=FALSE</code> ensures that the R code
10501057
is hidden from your course, while the code chunk option
10511058
<code>out.width = "100%"</code> is used to size the image. We generally

0 commit comments

Comments
 (0)