Workbench Component Guide
-Last updated on 2024-11-05 | +
Last updated on 2024-11-12 | Edit this page
@@ -409,6 +409,19 @@diff --git a/404.html b/404.html index df28013a..b9be599d 100644 --- a/404.html +++ b/404.html @@ -390,7 +390,7 @@
A: part of the precipitate
You can add a line with at least three colons and a
solution
tag.
Yes! It is a valid fenced div for the following reasons:
To get a roughly 1:5:1 ratio, you can use two separators for the short columns and ten separators for the wide column:
@@ -2063,7 +2063,7 @@Think about which files actually exist before the lesson is built.
@@ -2076,7 +2076,7 @@The answer is 3:
[internal links](../episodes/episodes.Rmd#internal-links)
@@ -2353,7 +2353,7 @@
What you should notice is that the only file updated when you re-render the lesson is the file you changed @@ -2541,7 +2541,7 @@
The episodes appear in the same order as the configuration file and the timings have rearranged themselves to reflect that.
@@ -2718,7 +2718,7 @@cff-version: 1.2.0
title: Introduction to The Carpentries Workbench
@@ -2801,7 +2801,7 @@ Plain text CITATION file
Example plain text CITATION file
-
+
Please cite this lesson as:
@@ -2944,7 +2944,7 @@ R
Output
-
+
OUTPUT
@@ -2971,7 +2971,7 @@ Challenge 2: how do you nest solutions within challeng
-
+
You can add a line with at least three colons and a
solution
tag.
@@ -3727,7 +3727,7 @@ Key Points
"creativeWorkStatus": "active",
"url": "https://carpentries.github.io/sandpaper-docs/aio.html",
"identifier": "https://carpentries.github.io/sandpaper-docs/aio.html",
- "dateCreated": "2024-11-05",
+ "dateCreated": "2024-11-12",
"dateModified": "2024-11-12",
"datePublished": "2024-11-12"
}
diff --git a/component-guide.html b/component-guide.html
index 7f108b4e..17c72b7d 100644
--- a/component-guide.html
+++ b/component-guide.html
@@ -324,7 +324,7 @@
Workbench Component Guide
- Last updated on 2024-11-05 |
+
Last updated on 2024-11-12 |
Edit this page
@@ -409,6 +409,19 @@ CALLOUT (callout
)
+
+
+
+
+
+CAUTION (caution
)
+
+CAUTION callouts are created with the caution
tag and
+raise awareness of potential issues or problems that a learner might
+experience.
+
+
+
@@ -455,7 +468,7 @@
HINT (hint)
-
+
HINT accordions are created with the hint
tag and nested
within challenge
callouts. These offer more context for the
@@ -471,7 +484,7 @@
SOLUTION (solution)
-
+
SOLUTION accordions are created with the solution
tag
and nested within challenge
callouts. These provide the
@@ -514,7 +527,7 @@
SPOILER (spoiler)
-
+
SPOILER callouts are created with the spoiler
tag and
are a way to provide additional details/content that can be expanded and
@@ -683,8 +696,8 @@
"creativeWorkStatus": "active",
"url": "https://carpentries.github.io/sandpaper-docs/component-guide.html",
"identifier": "https://carpentries.github.io/sandpaper-docs/component-guide.html",
- "dateCreated": "2024-11-05",
- "dateModified": "2024-11-05",
+ "dateCreated": "2024-11-12",
+ "dateModified": "2024-11-12",
"datePublished": "2024-11-12"
}
diff --git a/deployment.html b/deployment.html
index b5f729d1..9bf0f0f3 100644
--- a/deployment.html
+++ b/deployment.html
@@ -528,7 +528,7 @@ Key Points
"creativeWorkStatus": "active",
"url": "https://carpentries.github.io/sandpaper-docs/deployment.html",
"identifier": "https://carpentries.github.io/sandpaper-docs/deployment.html",
- "dateCreated": "2024-11-05",
+ "dateCreated": "2024-11-12",
"dateModified": "2024-11-05",
"datePublished": "2024-11-12"
}
diff --git a/editing.html b/editing.html
index d7585613..eee9617c 100644
--- a/editing.html
+++ b/editing.html
@@ -455,7 +455,7 @@ Preview the Lesson
-
+
What you should notice is that the only file updated when you
re-render the lesson is the file you changed
@@ -628,7 +628,7 @@
Configuring Episode Order
-
+
The episodes appear in the same order as the configuration file and
the timings have rearranged themselves to reflect that.
@@ -773,7 +773,7 @@ Creating a CFF for a lesson
Example CFF for this lesson
-
+
cff-version: 1.2.0
title: Introduction to The Carpentries Workbench
@@ -855,7 +855,7 @@ Plain text CITATION file
Example plain text CITATION file
-
+
Please cite this lesson as:
@@ -946,7 +946,7 @@ Key Points
"creativeWorkStatus": "active",
"url": "https://carpentries.github.io/sandpaper-docs/editing.html",
"identifier": "https://carpentries.github.io/sandpaper-docs/editing.html",
- "dateCreated": "2024-11-05",
+ "dateCreated": "2024-11-12",
"dateModified": "2024-11-05",
"datePublished": "2024-11-12"
}
diff --git a/episodes.html b/episodes.html
index fdc14990..3146cbee 100644
--- a/episodes.html
+++ b/episodes.html
@@ -938,7 +938,7 @@ Chemistry Joke
-
+
A: part of the precipitate
@@ -969,7 +969,7 @@ R
Output
-
+
OUTPUT
@@ -996,7 +996,7 @@ Challenge 2: how do you nest solutions within challeng
-
+
You can add a line with at least three colons and a
solution
tag.
@@ -1028,7 +1028,7 @@ MARKDOWN
Show me the solution
-
+
Yes! It is a valid fenced div for the following reasons:
- The opening fence has ≥3 colons
@@ -1081,7 +1081,7 @@ MARKDOWN
What Else Might We Use A Spoiler For?
-
+
- including a collapsed version of a very long block of output/a large
image from a code block, which the learner can expand if they want to
@@ -1338,7 +1338,7 @@
MARKDOWN
Show me the solution
-
+
To get a roughly 1:5:1 ratio, you can use two separators for the
short columns and ten separators for the wide column:
@@ -1497,7 +1497,7 @@ But It Works!
-
+
Think about which files actually exist before the lesson is
built.
@@ -1510,7 +1510,7 @@ Give me a hint
-
+
The answer is 3:
[internal links](../episodes/episodes.Rmd#internal-links)
@@ -1715,7 +1715,7 @@
Key Points
"creativeWorkStatus": "active",
"url": "https://carpentries.github.io/sandpaper-docs/episodes.html",
"identifier": "https://carpentries.github.io/sandpaper-docs/episodes.html",
- "dateCreated": "2024-11-05",
+ "dateCreated": "2024-11-12",
"dateModified": "2024-11-05",
"datePublished": "2024-11-12"
}
diff --git a/example.html b/example.html
index 65d4ce5e..88f62ca3 100644
--- a/example.html
+++ b/example.html
@@ -438,7 +438,7 @@ R
Output
-
+
OUTPUT
@@ -465,7 +465,7 @@ Challenge 2: how do you nest solutions within challeng
-
+
You can add a line with at least three colons and a
solution
tag.
@@ -607,7 +607,7 @@ Key Points
"creativeWorkStatus": "active",
"url": "https://carpentries.github.io/sandpaper-docs/example.html",
"identifier": "https://carpentries.github.io/sandpaper-docs/example.html",
- "dateCreated": "2024-11-05",
+ "dateCreated": "2024-11-12",
"dateModified": "2024-11-05",
"datePublished": "2024-11-12"
}
diff --git a/github-pat.html b/github-pat.html
index 065fb457..d17f3c94 100644
--- a/github-pat.html
+++ b/github-pat.html
@@ -554,7 +554,7 @@ OUTPUT<
"creativeWorkStatus": "active",
"url": "https://carpentries.github.io/sandpaper-docs/github-pat.html",
"identifier": "https://carpentries.github.io/sandpaper-docs/github-pat.html",
- "dateCreated": "2024-11-05",
+ "dateCreated": "2024-11-12",
"dateModified": "2024-11-05",
"datePublished": "2024-11-12"
}
diff --git a/images.html b/images.html
index 76b31b0b..f790c53b 100644
--- a/images.html
+++ b/images.html
@@ -541,7 +541,7 @@ Figure 9
"creativeWorkStatus": "active",
"url": "https://carpentries.github.io/sandpaper-docs/images.html",
"identifier": "https://carpentries.github.io/sandpaper-docs/images.html",
- "dateCreated": "2024-11-05",
+ "dateCreated": "2024-11-12",
"dateModified": "2024-11-12",
"datePublished": "2024-11-12"
}
diff --git a/index.html b/index.html
index cf97d2ca..93b96dbc 100644
--- a/index.html
+++ b/index.html
@@ -1235,7 +1235,7 @@ Is GitHub’s Documentation Confusing?
"creativeWorkStatus": "active",
"url": "https://carpentries.github.io/sandpaper-docs/index.html",
"identifier": "https://carpentries.github.io/sandpaper-docs/index.html",
- "dateCreated": "2024-11-05",
+ "dateCreated": "2024-11-12",
"dateModified": "2024-11-12",
"datePublished": "2024-11-12"
}
diff --git a/instructor-notes.html b/instructor-notes.html
index 9685fce4..fd8ce272 100644
--- a/instructor-notes.html
+++ b/instructor-notes.html
@@ -435,7 +435,7 @@ Instructor Notes
"creativeWorkStatus": "active",
"url": "https://carpentries.github.io/sandpaper-docs/instructor-notes.html",
"identifier": "https://carpentries.github.io/sandpaper-docs/instructor-notes.html",
- "dateCreated": "2024-11-05",
+ "dateCreated": "2024-11-12",
"dateModified": "2024-11-12",
"datePublished": "2024-11-12"
}
diff --git a/instructor/404.html b/instructor/404.html
index 4c85cb7f..77dbb4a6 100644
--- a/instructor/404.html
+++ b/instructor/404.html
@@ -390,7 +390,7 @@ Page not found
"creativeWorkStatus": "active",
"url": "https://carpentries.github.io/sandpaper-docs/instructor/404.html",
"identifier": "https://carpentries.github.io/sandpaper-docs/instructor/404.html",
- "dateCreated": "2024-11-05",
+ "dateCreated": "2024-11-12",
"dateModified": "2024-11-12",
"datePublished": "2024-11-12"
}
diff --git a/instructor/CODE_OF_CONDUCT.html b/instructor/CODE_OF_CONDUCT.html
index 758df4c3..a1082178 100644
--- a/instructor/CODE_OF_CONDUCT.html
+++ b/instructor/CODE_OF_CONDUCT.html
@@ -404,7 +404,7 @@ Contributor Code of Conduct
"creativeWorkStatus": "active",
"url": "https://carpentries.github.io/sandpaper-docs/instructor/CODE_OF_CONDUCT.html",
"identifier": "https://carpentries.github.io/sandpaper-docs/instructor/CODE_OF_CONDUCT.html",
- "dateCreated": "2024-11-05",
+ "dateCreated": "2024-11-12",
"dateModified": "2024-11-05",
"datePublished": "2024-11-12"
}
diff --git a/instructor/LICENSE.html b/instructor/LICENSE.html
index 1a3ed07c..f6dde71a 100644
--- a/instructor/LICENSE.html
+++ b/instructor/LICENSE.html
@@ -452,7 +452,7 @@ Licenses
"creativeWorkStatus": "active",
"url": "https://carpentries.github.io/sandpaper-docs/instructor/LICENSE.html",
"identifier": "https://carpentries.github.io/sandpaper-docs/instructor/LICENSE.html",
- "dateCreated": "2024-11-05",
+ "dateCreated": "2024-11-12",
"dateModified": "2024-11-05",
"datePublished": "2024-11-12"
}
diff --git a/instructor/aio.html b/instructor/aio.html
index c65956cd..112d42ff 100644
--- a/instructor/aio.html
+++ b/instructor/aio.html
@@ -1355,7 +1355,7 @@ MARKDOWN
Instructor Note
-
+
This is an instructor note. It contains information that can be
useful for instructors to know such as
@@ -1420,7 +1420,7 @@ Chemistry Joke
-
+
A: part of the precipitate
@@ -1451,7 +1451,7 @@ R
Output
-
+
OUTPUT
@@ -1478,7 +1478,7 @@ Challenge 2: how do you nest solutions within challeng
-
+
You can add a line with at least three colons and a
solution
tag.
@@ -1510,7 +1510,7 @@ MARKDOWN
Show me the solution
-
+
Yes! It is a valid fenced div for the following reasons:
@@ -1567,7 +1567,7 @@ MARKDOWN
What Else Might We Use A Spoiler For?
-
+
- including a collapsed version of a very long block of output/a large
@@ -1899,7 +1899,7 @@
MARKDOWN
Show me the solution
-
+
To get a roughly 1:5:1 ratio, you can use two separators for the
short columns and ten separators for the wide column:
@@ -2097,7 +2097,7 @@ But It Works!
-
+
Think about which files actually exist before the lesson is
built.
@@ -2110,7 +2110,7 @@ Give me a hint
-
+
The answer is 3:
[internal links](../episodes/episodes.Rmd#internal-links)
@@ -2388,7 +2388,7 @@
Preview the Lesson
-
+
What you should notice is that the only file updated when you
re-render the lesson is the file you changed
@@ -2576,7 +2576,7 @@
Configuring Episode Order
-
+
The episodes appear in the same order as the configuration file and
the timings have rearranged themselves to reflect that.
@@ -2753,7 +2753,7 @@ Creating a CFF for a lesson
Example CFF for this lesson
-
+
cff-version: 1.2.0
title: Introduction to The Carpentries Workbench
@@ -2836,7 +2836,7 @@ Plain text CITATION file
Example plain text CITATION file
-
+
Please cite this lesson as:
@@ -2936,7 +2936,7 @@ Objectives
-
+
Inline instructor notes can help inform instructors of timing
challenges associated with the lessons. They appear in the “Instructor
@@ -2994,7 +2994,7 @@
R
Output
-
+
OUTPUT
@@ -3021,7 +3021,7 @@ Challenge 2: how do you nest solutions within challeng
-
+
You can add a line with at least three colons and a
solution
tag.
@@ -3780,7 +3780,7 @@ Key Points
"creativeWorkStatus": "active",
"url": "https://carpentries.github.io/sandpaper-docs/instructor/aio.html",
"identifier": "https://carpentries.github.io/sandpaper-docs/instructor/aio.html",
- "dateCreated": "2024-11-05",
+ "dateCreated": "2024-11-12",
"dateModified": "2024-11-12",
"datePublished": "2024-11-12"
}
diff --git a/instructor/component-guide.html b/instructor/component-guide.html
index f9afbeb6..edddb1f5 100644
--- a/instructor/component-guide.html
+++ b/instructor/component-guide.html
@@ -324,7 +324,7 @@
Workbench Component Guide
- Last updated on 2024-11-05 |
+
Last updated on 2024-11-12 |
Edit this page
@@ -403,7 +403,7 @@
INSTRUCTOR NOTE (instructor)
-
+
Instructor notes are created with the instructor
tag
@@ -425,6 +425,19 @@ CALLOUT (callout
)
+
+
+
+
+
+CAUTION (caution
)
+
+CAUTION callouts are created with the caution
tag and
+raise awareness of potential issues or problems that a learner might
+experience.
+
+
+
@@ -471,7 +484,7 @@
HINT (hint)
-
+
HINT accordions are created with the hint
tag and nested
within challenge
callouts. These offer more context for the
@@ -487,7 +500,7 @@
SOLUTION (solution)
-
+
SOLUTION accordions are created with the solution
tag
and nested within challenge
callouts. These provide the
@@ -530,7 +543,7 @@
SPOILER (spoiler)
-
+
SPOILER callouts are created with the spoiler
tag and
are a way to provide additional details/content that can be expanded and
@@ -699,8 +712,8 @@
"creativeWorkStatus": "active",
"url": "https://carpentries.github.io/sandpaper-docs/instructor/component-guide.html",
"identifier": "https://carpentries.github.io/sandpaper-docs/instructor/component-guide.html",
- "dateCreated": "2024-11-05",
- "dateModified": "2024-11-05",
+ "dateCreated": "2024-11-12",
+ "dateModified": "2024-11-12",
"datePublished": "2024-11-12"
}
diff --git a/instructor/deployment.html b/instructor/deployment.html
index 77935a83..1f7fb9e5 100644
--- a/instructor/deployment.html
+++ b/instructor/deployment.html
@@ -530,7 +530,7 @@ Key Points
"creativeWorkStatus": "active",
"url": "https://carpentries.github.io/sandpaper-docs/instructor/deployment.html",
"identifier": "https://carpentries.github.io/sandpaper-docs/instructor/deployment.html",
- "dateCreated": "2024-11-05",
+ "dateCreated": "2024-11-12",
"dateModified": "2024-11-05",
"datePublished": "2024-11-12"
}
diff --git a/instructor/editing.html b/instructor/editing.html
index db109a2b..a470b478 100644
--- a/instructor/editing.html
+++ b/instructor/editing.html
@@ -457,7 +457,7 @@ Preview the Lesson
-
+
What you should notice is that the only file updated when you
re-render the lesson is the file you changed
@@ -630,7 +630,7 @@
Configuring Episode Order
-
+
The episodes appear in the same order as the configuration file and
the timings have rearranged themselves to reflect that.
@@ -775,7 +775,7 @@ Creating a CFF for a lesson
Example CFF for this lesson
-
+
cff-version: 1.2.0
title: Introduction to The Carpentries Workbench
@@ -857,7 +857,7 @@ Plain text CITATION file
Example plain text CITATION file
-
+
Please cite this lesson as:
@@ -948,7 +948,7 @@