Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use jekyll to generate all in one instead of Javascript #438

Merged
merged 6 commits into from
Nov 8, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 15 additions & 40 deletions _includes/aio-script.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,25 @@
{% comment %}
As a maintainer, you don't need to edit this file.
If you notice that something doesn't work, please
If you notice that something doesn't work, please
maxim-belkin marked this conversation as resolved.
Show resolved Hide resolved
open an issue: https://github.com/carpentries/styles/issues/new
{% endcomment %}

{% include manual_episode_order.html %}

<script>
window.onload = function() {
var lesson_episodes = [
{% for lesson_episode in lesson_episodes %}
{% if site.episode_order %}
{% assign episode = site.episodes | where: "slug", lesson_episode | first %}
{% else %}
{% assign episode = lesson_episode %}
{% endif %}
"{{ episode.url}}"{% unless forloop.last %},{% endunless %}
{% endfor %}
];
var xmlHttp = []; /* Required since we are going to query every episode. */
for (i=0; i < lesson_episodes.length; i++) {
xmlHttp[i] = new XMLHttpRequest();
xmlHttp[i].episode = lesson_episodes[i]; /* To enable use this later. */
xmlHttp[i].onreadystatechange = function() {
if (this.readyState == 4 && this.status == 200) {
var article_here = document.getElementById(this.episode);
var parser = new DOMParser();
var htmlDoc = parser.parseFromString(this.responseText,"text/html");
var htmlDocArticle = htmlDoc.getElementsByTagName("article")[0];
article_here.innerHTML = htmlDocArticle.innerHTML;
}
}
var episode_url = "{{ relative_root_path }}" + lesson_episodes[i];
xmlHttp[i].open("GET", episode_url);
xmlHttp[i].send(null);
}
}
</script>
{% for lesson_episode in lesson_episodes %}

{% comment %} Create an anchor for every episode. {% endcomment %}
{% if site.episode_order %}
{% assign e = site.episodes | where: "slug", lesson_episode | first %}
{% else %}
{% assign e = lesson_episode %}
{% endif %}

{% for lesson_episode in lesson_episodes %}
{% if site.episode_order %}
{% assign episode = site.episodes | where: "slug", lesson_episode | first %}
{% else %}
{% assign episode = lesson_episode %}
{% endif %}
<article id="{{ episode.url }}"></article>
<h1 id="{{ e.title | slugify }}" class="maintitle">{{ e.title }}</h1>

{% include episode_overview.html teaching_time=e.teaching exercise_time=e.exercises episode_questions=e.questions episode_objectives=e.objectives %}

{{ e.content }}

{% include episode_keypoints.html episode_keypoints=e.keypoints %}
<hr/>
maxim-belkin marked this conversation as resolved.
Show resolved Hide resolved
{% endfor %}
9 changes: 8 additions & 1 deletion _includes/episode_keypoints.html
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
{% comment %}
Display key points for an episode.
{% endcomment %}

{% if page.keypoints == null %}
Copy link
Contributor

@maxim-belkin maxim-belkin Nov 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a tad confused here as "nothing" in Liquid is nil, not null. Also, we could check whether we have something in page.keypoints with {%- if page.keypoints -%} and avoid having to check == null completely. The only case wherepage.keypoints == nil is useful is when page.keypoints is an empty string, which evaluates to "true" in Liquid.

{% assign episode_keypoints = include.episode_keypoints %}
{% else %}
{% assign episode_keypoints = page.keypoints %}
{% endif %}

<blockquote class="keypoints">
<h2>Key Points</h2>
<ul>
{% for keypoint in page.keypoints %}
{% for keypoint in episode_keypoints %}
<li>{{ keypoint|markdownify }}</li>
{% endfor %}
</ul>
Expand Down
34 changes: 30 additions & 4 deletions _includes/episode_overview.html
Original file line number Diff line number Diff line change
@@ -1,19 +1,45 @@
{% comment %}
Display an episode's timings and learning objectives.
{% endcomment %}

{% if page.teaching == null %}
{% assign teaching_time = include.teaching_time %}
{% else %}
{% assign teaching_time = page.teaching %}
{% endif %}

{% if page.exercises == null %}
{% assign exercise_time = include.exercise_time %}
{% else %}
{% assign exercise_time = page.exercises %}
{% endif %}

{% if page.questions == null %}
{% assign episode_questions = include.episode_questions %}
{% else %}
{% assign episode_questions = page.questions %}
{% endif %}

{% if page.objectives == null %}
{% assign episode_objectives = include.episode_objectives %}
{% else %}
{% assign episode_objectives = page.objectives %}
{% endif %}


<blockquote class="objectives">
<h2>Overview</h2>

<div class="row">
<div class="col-md-3">
<strong>Teaching:</strong> {{ page.teaching }} min
<strong>Teaching:</strong> {{ teaching_time }} min
<br/>
<strong>Exercises:</strong> {{ page.exercises }} min
<strong>Exercises:</strong> {{ exercise_time }} min
</div>
<div class="col-md-9">
<strong>Questions</strong>
<ul>
{% for question in page.questions %}
{% for question in episode_questions %}
<li>{{ question|markdownify }}</li>
{% endfor %}
</ul>
Expand All @@ -26,7 +52,7 @@ <h2>Overview</h2>
<div class="col-md-9">
<strong>Objectives</strong>
<ul>
{% for objective in page.objectives %}
{% for objective in episode_objectives %}
<li>{{ objective|markdownify }}</li>
{% endfor %}
</ul>
Expand Down