Merge pull request #82 from epicentre-msf/81-improve-template

revise template for completemness

docs/explore.html

@@ -217,7 +217,7 @@ <h1 class="title">Explore</h1>
 
 <div class="quarto-listing quarto-listing-container-grid" id="listing-listing">
 <div class="list grid quarto-listing-cols-3">
-<div class="g-col-1" data-index="0" data-categories="Q29yZSUyQ1IlMjBCYXNpY3MlMkNEYXRhJTIwVHlwZXM=" data-listing-date-sort="1736281708000" data-listing-file-modified-sort="1736281708115" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="24" data-listing-word-count-sort="4736">
+<div class="g-col-1" data-index="0" data-categories="Q29yZSUyQ1IlMjBCYXNpY3MlMkNEYXRhJTIwVHlwZXM=" data-listing-date-sort="1736525626000" data-listing-file-modified-sort="1736525626186" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="24" data-listing-word-count-sort="4736">
 <a href="./sessions_core/01_introduction.html" class="quarto-grid-link">
 <div class="quarto-grid-item card h-100 card-left">
 <p class="card-img-top"><img src="img/core/01_introduction/01_rstudio_interface_en.png" style="height: 150px;"  class="thumbnail-image card-img"/></p>
@@ -244,14 +244,14 @@ <h5 class="no-anchor card-title listing-title">
 
 </div>
 <div class="listing-date">
-Jan 7, 2025
+Jan 10, 2025
 </div>
 </div>
 </div>
 </div>
 </a>
 </div>
-<div class="g-col-1" data-index="1" data-categories="Q29yZQ==" data-listing-date-sort="1736275587000" data-listing-file-modified-sort="1736275587678" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="3" data-listing-word-count-sort="437">
+<div class="g-col-1" data-index="1" data-categories="Q29yZQ==" data-listing-date-sort="1736773000000" data-listing-file-modified-sort="1736773000792" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="3" data-listing-word-count-sort="543">
 <a href="./sessions_core/template.html" class="quarto-grid-link">
 <div class="quarto-grid-item card h-100 card-left">
 <p class="card-img-top">
@@ -274,7 +274,7 @@ <h5 class="no-anchor card-title listing-title">
 
 </div>
 <div class="listing-date">
-Jan 7, 2025
+Jan 13, 2025
 </div>
 </div>
 </div>

docs/pathway.html

@@ -218,7 +218,7 @@ <h1 class="title">Pathway</h1>
 
 <div class="quarto-listing quarto-listing-container-default" id="listing-articles-links">
 <div class="list quarto-listing-default">
-<div class="quarto-post image-right" data-index="0" data-categories="Q29yZSUyQ1IlMjBCYXNpY3MlMkNEYXRhJTIwVHlwZXM=" data-listing-date-sort="1736281708000" data-listing-file-modified-sort="1736281708115" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="24" data-listing-word-count-sort="4736">
+<div class="quarto-post image-right" data-index="0" data-categories="Q29yZSUyQ1IlMjBCYXNpY3MlMkNEYXRhJTIwVHlwZXM=" data-listing-date-sort="1736525626000" data-listing-file-modified-sort="1736525626186" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="24" data-listing-word-count-sort="4736">
 <div class="thumbnail">
 <p><a href="./sessions_core/01_introduction.html" class="no-external"></a></p><a href="./sessions_core/01_introduction.html" class="no-external">
 <p class="card-img-top"><img src="img/core/01_introduction/01_rstudio_interface_en.png"  class="thumbnail-image card-img"/></p>
@@ -238,7 +238,7 @@ <h3 class="no-anchor listing-title">
 <div class="metadata">
 <a href="./sessions_core/01_introduction.html" class="no-external">
 <div class="listing-date">
-Jan 7, 2025
+Jan 10, 2025
 </div>
 </a>
 </div>

docs/search.json

@@ -11,7 +11,7 @@
     "href": "pathway.html",
     "title": "Pathway",
     "section": "",
-    "text": "These sessions can be followed in order to get a baseline level in R. The series assumes no prior experience in R and is suitable for beginners.\nLooking for more? Want more flexibility? Consider browsing the full session catalog.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nIntroduction to R\n\n\n\n\n\nYour first steps in R. Learn your way around Rstudio, and meet some common R objects.\n\n\n\n\n\nJan 7, 2025\n\n\n\n\n\n\nNo matching items"
+    "text": "These sessions can be followed in order to get a baseline level in R. The series assumes no prior experience in R and is suitable for beginners.\nLooking for more? Want more flexibility? Consider browsing the full session catalog.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nIntroduction to R\n\n\n\n\n\nYour first steps in R. Learn your way around Rstudio, and meet some common R objects.\n\n\n\n\n\nJan 10, 2025\n\n\n\n\n\n\nNo matching items"
   },
   {
     "objectID": "about.html#hey-there",
@@ -126,32 +126,39 @@
     "text": "Setup\n\nDescription of something participants need to setup, primarily used at the beginning of a section but can also be used for tasks like setting up an Rproject file, folder structure, etc."
   },
   {
-    "objectID": "sessions_core/template.html#main-section",
-    "href": "sessions_core/template.html#main-section",
+    "objectID": "sessions_core/template.html#main-section-1",
+    "href": "sessions_core/template.html#main-section-1",
     "title": "Session Title",
-    "section": "Main Section",
-    "text": "Main Section\nYour main section can (and probably should) be boken down into subsections.\n\nSubsection 1\n\n\nSubsection 2"
+    "section": "Main Section 1",
+    "text": "Main Section 1\nYour main section(s) can (and probably should) be boken down into subsections.\n\nSubsection 1\n\n\nSubsection 2"
   },
   {
-    "objectID": "sessions_core/template.html#markdown-reminders",
-    "href": "sessions_core/template.html#markdown-reminders",
+    "objectID": "sessions_core/template.html#done",
+    "href": "sessions_core/template.html#done",
     "title": "Session Title",
-    "section": "Markdown Reminders",
-    "text": "Markdown Reminders\nThe rest of this document is a reminder on qmd syntax and a basic style guide. Enjoy.\n\nText Formatting\n\nItalic and Bold will turn out like this\nBlock quotes will look like this:\n\n\nThis is a blockquote made using >\n\n\nTooltips can be done using spans (please do not use asides or footnotes)\n\n\n\nCode\nInline coding will turn out like this\nCode blocks will appear like this:\n\n# comment\nprint('hello world')\n\nWarning: For these tutorials, code blocks are not evaluated by default. If you want to evaluate them, you must indicate it specifically.\n\n# comment\nprint('hello back!')\n\n[1] \"hello back!\"\n\ntest <- function(x) {\n  if (x > 1) {\n    return(x)\n  } else {\n    print('nothing to see here')\n  }\n}\n\nNote. We are no longer using solution blocks, instead a single code file will be available at the end of each session contiaining code that runs through all the exercises.\n\n\nCallouts\nIMPORTANT: please do not use callouts not explicitly defined here; they have not been included in the css and therefore will not render well in the final document.\n\n\n\n\n\n\nNote\n\n\n\nThis is a callout using {.callout-note}\n\n\n\n\n\n\n\n\nTip\n\n\n\nComment about a genral tip / trick or best practice.\n\n\n\n\n\n\n\n\nImportant\n\n\n\nWarning / comment on something really important.\n\n\n\n\nAction Boxes\nThese are used for things participants are expected to actually do, ie: exercises. They are split into three categories.\n\nDescription of something participants need to setup, primarily used at the beginning of a section but can also be used for tasks like setting up an Rproject file, folder structure, etc.\n\n\nDescription of something participants should observe, investigate, etc.\n\n\nDescription of a coding exercise that participants are expected to complete.\n\n\n\nTabsets\n\nOneTwoThree\n\n\nContent that will show under the first tab\n\n\nContent that will show under the second tab\n\n\nContent that will show under the third tab\n\n\n\n\n\nImages\nYou can insert images by referring to their relative path using markdown syntax or HTML. Note that the markdown syntax does not allow you to modify image size. In either case, make sure to add alt text for accessibility.\nMarkdown style syntax:\n\n\n\nexample image alt text\n\n\nHTML style syntax (with specification of desired size):"
+    "section": "Done!",
+    "text": "Done!\nThis last header let’s students know that they are done with the main material for the day. It should also include a link to the solutions (hosted on github)."
   },
   {
-    "objectID": "sessions_core/template.html#linking-to-other-pages",
-    "href": "sessions_core/template.html#linking-to-other-pages",
+    "objectID": "sessions_core/template.html#going-further",
+    "href": "sessions_core/template.html#going-further",
     "title": "Session Title",
-    "section": "Linking to Other Pages",
-    "text": "Linking to Other Pages\nEasy, use relative paths within a standard href, ie: link to home page."
+    "section": "Going Further",
+    "text": "Going Further\nAfter your main content is done you should have a section called called “Going Further” for students who finish the main content early. It should include: 1. A mention of one or two satellite sessions that would be relevant extensions of the current material 2. A section with “extra exercise questions” (these don’t need to use the “action blocks” (see below) and can just be a number list as shown below.\n\nExtra Exercises\n\nDo this.\nThen do that."
+  },
+  {
+    "objectID": "sessions_core/template.html#markdown-reminders",
+    "href": "sessions_core/template.html#markdown-reminders",
+    "title": "Session Title",
+    "section": "Markdown Reminders",
+    "text": "Markdown Reminders\nThe rest of this document is a reminder on qmd syntax and a basic style guide. Enjoy.\n\nText Formatting\n\nItalic and Bold will turn out like this\nBlock quotes will look like this:\n\n\nThis is a blockquote made using >\n\n\nTooltips can be done using spans (please do not use asides or footnotes)\n\n\n\nCode\nInline coding will turn out like this\nCode blocks will appear like this:\n\n# comment\nprint('hello world')\n\nWarning: For these tutorials, code blocks are not evaluated by default. If you want to evaluate them, you must indicate it specifically.\n\n# comment\nprint('hello back!')\n\n[1] \"hello back!\"\n\ntest <- function(x) {\n  if (x > 1) {\n    return(x)\n  } else {\n    print('nothing to see here')\n  }\n}\n\nNote. We are no longer using solution blocks, instead a single code file will be available at the end of each session contiaining code that runs through all the exercises.\n\n\nCallouts\nIMPORTANT: please do not use callouts not explicitly defined here; they have not been included in the css and therefore will not render well in the final document.\n\n\n\n\n\n\nNote\n\n\n\nThis is a callout using {.callout-note}\n\n\n\n\n\n\n\n\nTip\n\n\n\nComment about a genral tip / trick or best practice.\n\n\n\n\n\n\n\n\nImportant\n\n\n\nWarning / comment on something really important.\n\n\n\n\nAction Boxes\nThese are used for things participants are expected to actually do, ie: exercises. They are split into three categories.\n\nDescription of something participants need to setup, primarily used at the beginning of a section but can also be used for tasks like setting up an Rproject file, folder structure, etc.\n\n\nDescription of something participants should observe, investigate, etc.\n\n\nDescription of a coding exercise that participants are expected to complete.\n\n\n\nTabsets\n\nOneTwoThree\n\n\nContent that will show under the first tab\n\n\nContent that will show under the second tab\n\n\nContent that will show under the third tab\n\n\n\n\n\nImages\nYou can insert images by referring to their relative path using markdown syntax or HTML. Note that the markdown syntax does not allow you to modify image size. In either case, make sure to add alt text for accessibility.\nMarkdown style syntax:\n\n\n\nexample image alt text\n\n\nHTML style syntax (with specification of desired size):\n\n\n\nLinking to Other Pages\nEasy, use relative paths within a standard href, ie: link to home page."
   },
   {
     "objectID": "explore.html",
     "href": "explore.html",
     "title": "Explore",
     "section": "",
-    "text": "Choose your own adventure by browsing all available sessions.\n\n\n\n\n\n\n\n\n\n\n\n\nIntroduction to R\n\n\n\nCore\n\n\nR Basics\n\n\nData Types\n\n\n\nYour first steps in R. Learn your way around Rstudio, and meet some common R objects.\n\n\n\n\n\n\nJan 7, 2025\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nSession Title\n\n\n\nCore\n\n\n\nShort description (appears on cards in pathway / explore pages)\n\n\n\n\n\n\nJan 7, 2025\n\n\n\n\n\n\n\n\nNo matching items"
+    "text": "Choose your own adventure by browsing all available sessions.\n\n\n\n\n\n\n\n\n\n\n\n\nIntroduction to R\n\n\n\nCore\n\n\nR Basics\n\n\nData Types\n\n\n\nYour first steps in R. Learn your way around Rstudio, and meet some common R objects.\n\n\n\n\n\n\nJan 10, 2025\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nSession Title\n\n\n\nCore\n\n\n\nShort description (appears on cards in pathway / explore pages)\n\n\n\n\n\n\nJan 13, 2025\n\n\n\n\n\n\n\n\nNo matching items"
   },
   {
     "objectID": "index.html",

docs/sessions_core/01_introduction.html

@@ -6,7 +6,7 @@
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 
-<meta name="dcterms.date" content="2025-01-07">
+<meta name="dcterms.date" content="2025-01-10">
 <meta name="description" content="Your first steps in R. Learn your way around Rstudio, and meet some common R objects.">
 
 <title>Introduction to R – {repicentre}</title>
@@ -218,7 +218,7 @@ <h1 class="title">Introduction to R</h1>
     <div>
     <div class="quarto-title-meta-heading">Published</div>
     <div class="quarto-title-meta-contents">
-      <p class="date">January 7, 2025</p>
+      <p class="date">January 10, 2025</p>
     </div>
   </div>
 

docs/sessions_core/template.html

@@ -6,7 +6,7 @@
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 
-<meta name="dcterms.date" content="2025-01-07">
+<meta name="dcterms.date" content="2025-01-13">
 <meta name="description" content="Short description (appears on cards in pathway / explore pages)">
 
 <title>Session Title – {repicentre}</title>
@@ -162,11 +162,16 @@ <h2 id="toc-title">On this page</h2>
   <ul>
   <li><a href="#objectives" id="toc-objectives" class="nav-link active" data-scroll-target="#objectives">Objectives</a></li>
   <li><a href="#setup" id="toc-setup" class="nav-link" data-scroll-target="#setup">Setup</a></li>
-  <li><a href="#main-section" id="toc-main-section" class="nav-link" data-scroll-target="#main-section">Main Section</a>
+  <li><a href="#main-section-1" id="toc-main-section-1" class="nav-link" data-scroll-target="#main-section-1">Main Section 1</a>
   <ul class="collapse">
   <li><a href="#subsection-1" id="toc-subsection-1" class="nav-link" data-scroll-target="#subsection-1">Subsection 1</a></li>
   <li><a href="#subsection-2" id="toc-subsection-2" class="nav-link" data-scroll-target="#subsection-2">Subsection 2</a></li>
   </ul></li>
+  <li><a href="#done" id="toc-done" class="nav-link" data-scroll-target="#done">Done!</a></li>
+  <li><a href="#going-further" id="toc-going-further" class="nav-link" data-scroll-target="#going-further">Going Further</a>
+  <ul class="collapse">
+  <li><a href="#extra-exercises" id="toc-extra-exercises" class="nav-link" data-scroll-target="#extra-exercises">Extra Exercises</a></li>
+  </ul></li>
   <li><a href="#markdown-reminders" id="toc-markdown-reminders" class="nav-link" data-scroll-target="#markdown-reminders">Markdown Reminders</a>
   <ul class="collapse">
   <li><a href="#text-formatting" id="toc-text-formatting" class="nav-link" data-scroll-target="#text-formatting">Text Formatting</a></li>
@@ -175,8 +180,8 @@ <h2 id="toc-title">On this page</h2>
   <li><a href="#action-boxes" id="toc-action-boxes" class="nav-link" data-scroll-target="#action-boxes">Action Boxes</a></li>
   <li><a href="#tabsets" id="toc-tabsets" class="nav-link" data-scroll-target="#tabsets">Tabsets</a></li>
   <li><a href="#images" id="toc-images" class="nav-link" data-scroll-target="#images">Images</a></li>
-  </ul></li>
   <li><a href="#linking-to-other-pages" id="toc-linking-to-other-pages" class="nav-link" data-scroll-target="#linking-to-other-pages">Linking to Other Pages</a></li>
+  </ul></li>
   </ul>
 </nav>
     </div>
@@ -204,7 +209,7 @@ <h1 class="title">Session Title</h1>
     <div>
     <div class="quarto-title-meta-heading">Published</div>
     <div class="quarto-title-meta-contents">
-      <p class="date">January 7, 2025</p>
+      <p class="date">January 13, 2025</p>
     </div>
   </div>
 
@@ -229,16 +234,34 @@ <h2 class="anchored" data-anchor-id="setup">Setup</h2>
 <p>Description of something participants need to setup, primarily used at the beginning of a section but can also be used for tasks like setting up an <code>Rproject</code> file, folder structure, etc.</p>
 </div>
 </section>
-<section id="main-section" class="level2">
-<h2 class="anchored" data-anchor-id="main-section">Main Section</h2>
-<p>Your main section can (and probably should) be boken down into subsections.</p>
+<section id="main-section-1" class="level2">
+<h2 class="anchored" data-anchor-id="main-section-1">Main Section 1</h2>
+<p>Your main section(s) can (and probably should) be boken down into subsections.</p>
 <section id="subsection-1" class="level3">
 <h3 class="anchored" data-anchor-id="subsection-1">Subsection 1</h3>
 </section>
 <section id="subsection-2" class="level3">
 <h3 class="anchored" data-anchor-id="subsection-2">Subsection 2</h3>
 </section>
 </section>
+<section id="done" class="level2">
+<h2 class="anchored" data-anchor-id="done">Done!</h2>
+<p>This last header let’s students know that they are done with the main material for the day. It should also include a link to the solutions (hosted on github).</p>
+</section>
+<section id="going-further" class="level2">
+<h2 class="anchored" data-anchor-id="going-further">Going Further</h2>
+<p>After your main content is done you should have a section called called “Going Further” for students who finish the main content early. It should include: 1. A mention of one or two satellite sessions that would be relevant extensions of the current material 2. A section with “extra exercise questions” (these don’t need to use the “action blocks” (see below) and can just be a number list as shown below.</p>
+<section id="extra-exercises" class="level3">
+<h3 class="anchored" data-anchor-id="extra-exercises">Extra Exercises</h3>
+<ol type="1">
+<li>Do this.</li>
+<li>Then do that.</li>
+</ol>
+<hr>
+<hr>
+<hr>
+</section>
+</section>
 <section id="markdown-reminders" class="level2">
 <h2 class="anchored" data-anchor-id="markdown-reminders">Markdown Reminders</h2>
 <p>The rest of this document is a reminder on qmd syntax and a basic style guide. Enjoy.</p>
@@ -366,12 +389,12 @@ <h3 class="anchored" data-anchor-id="images">Images</h3>
 <p>HTML style syntax (with specification of desired size):</p>
 <p><img src="../img/under_construction.svg" alt="example image alt (html)" width="200"></p>
 </section>
-</section>
-<section id="linking-to-other-pages" class="level2">
-<h2 class="anchored" data-anchor-id="linking-to-other-pages">Linking to Other Pages</h2>
+<section id="linking-to-other-pages" class="level3">
+<h3 class="anchored" data-anchor-id="linking-to-other-pages">Linking to Other Pages</h3>
 <p>Easy, use relative paths within a standard href, ie: <a href="../index.html">link to home page</a>.</p>
 
 
+</section>
 </section>
 
 </main> <!-- /main -->