coursegen 0.8.3 → 0.9.1

data/tech_debt.md

@@ -6,5 +6,10 @@
 * Make the way mocks are built in specs more consitent
 * A way to have a nested section which is not an 'event' based section
 * Clean up the placement of the .js files for the search stuff. It's a bit messy
+* Add more tests
 
 ### Features
+
+* generate pdf
+* more elaborate sample course in cg itself
+* document the different macros

data/templates/Rules

@@ -20,10 +20,6 @@ compile '/content/scripts/**/*' do
   nil
 end
 
-compile "/content/tipuesearch/tipuesearch_content.js.erb" do
-  filter :erb
-end
-
 compile '/**/*.ical.erb' do
   filter :erb
 end
@@ -38,6 +34,16 @@ compile '/**/*.{md,ical}.erb' do
   end
 end
 
+compile '/**/*.md.erb', rep: :slides do
+  if item[:status] != "hidden"
+    filter :erb
+    layout '/slides.*'
+    write item.identifier.without_ext + '/slides.html'
+  else
+    nil
+  end
+end
+
 compile '/**/*' do
   if item.binary? || item[:status] == "hidden"
     nil
@@ -48,31 +54,20 @@ route '/bootstrap/**/*' do
   @item.identifier.to_s
 end
 
-route '/tipuesearch/**/*' do
-  @item.identifier.to_s
-end
-
-route "/content/tipuesearch/tipuesearch_content.*" do
-  '/tipuesearch/tipuesearch_content.js'
-end
-
-# Output the search page
-route '/tipuesearch/search.md.erb' do
-  '/tipuesearch/search/index.html'
-end
-
 # Select which .md.erb becomes the home page of the site
 route HOME_PAGE do
   '/index.html'
 end
 
+route HOME_PAGE, rep: :slides do
+  '/slides.html'
+end
+
 route '/**/*' do
   if item[:extension].nil?
     raise RuntimeError, "Missing required extension: \".#{item.identifier}\""
   elsif item.binary?
     item.identifier.to_s
-  elsif item.identifier == "/searchtipuesearch_content/"
-    item.identifier.chop + '.' + item[:extension] rescue fail "in route * in Rules"
   elsif item[:status] == "hidden"
     nil
   elsif item[:type] == "subsection"

data/templates/cg_config.rb

@@ -1,30 +1,114 @@
+# frozen_string_literal: true
+
+# Coursegen configuration file.
+#
+# Note that in order to read the configuration file, this file must be at the
+# root of the course directory.
 require 'coursegen'
 
-# Copyright string
-COPYRIGHT_STRING = "Copyright (2013-2019) R. Pito Salas, pitosalas@gmail.com"
+# AUTHOR
+AUTHOR_NAME = 'yourname'
+AUTHOR_EMAIL = 'yourname'
+COPYRIGHT_STRING = "Copyright (2013-#{Time.now.year}) #{AUTHOR_NAME}, #{AUTHOR_EMAIL}"
+
+# Bucket Deployment of the course
+AWS_BUCKET = "yourbucketname"
+
+# COURSE
+COURSE_SHORT_NAME = 'cool'
+COURSE_LONG_NAME = 'Cool Course'
+COURSE_ABBREV = 'CC'
 
-# Course short name
-COURSE_SHORT_NAME = "Sample Course"
-COURSE_LONG_NAME = "Sample Coursegen Course"
-COURSE_ABBREV = "SC"
+# Lectures_schedule defines the schedule of lectures.
+#
+# This is primarily used to 1) figure out the time and date of each class,
+# and 2) figure out the ordering of classes on the sidebar.
 
 LECTURES_SCHEDULE_CONFIG = ScheduleDef.new(
-  first_day: "jan-17-2017",
-  weekdays: [:tuesday, :wednesday, :thursday],
-  start_times: ["15:30", "14:00", "15:30"],
-  end_times: ["16:50", "16:00", "16:50"],
-  number: 39,
+  first_day: "jul-20-2020",
+  weekdays: [:monday,],
+  start_times: ["15:30", "15:30"],
+  end_times: ["16:50", "16:50"],
+  number: 28,
+  skips: [],
   start_time: "15:30",
-  end_time: "16:50",
-  skips: ["feb-9-2017", "feb-21-2017", "feb-22-2017", "feb-23-2017", "apr-11-2017", "apr-12-2017", "apr-13-2017", "apr-18-2017", "apr-19-2017"])
+  end_time: "16:50"
+)
 
-# Sections in the right hand margin of the page
+# Section_config defines the structure of the course.
+#
+# Each section is defined by
+#   title     name of the section
+#   selector  directory of the section (under /content)
+#   type      type of the section (:section or :lecture)
+#   schedule  schedule of the lecture (only needed for :lecture)
+#
+# Additionally, you can choose to hide the section on the sidebar by setting
+# hidden: true.
 SECTION_CONFIG = [
-  SectionDef.new("Intro", "intro", type: :section),
-  SectionDef.new("Lectures", "lectures", type: :lecture, schedule: LECTURES_SCHEDULE_CONFIG),
-  SectionDef.new("Extras", "extras", hidden: true, type: :section)
-]
-# Options are:
-# bullet_style: css style for each bullet
-STYLING_CONFIG = {bullet_style: "\"font-size: 60%; width: 10px; color: grey\""}
+  SectionDef.new("Intro", "intro", type: :section, collapsed: false, bullet: :star),
+  SectionDef.new("Lectures", "lectures",
+                 type: :lecture, schedule: LECTURES_SCHEDULE_CONFIG, bullet: :dash),
+  SectionDef.new("Homework", "homework", hidden: true, type: :section),
+].freeze
+
+# SITE
+#
+# The URL of the deployed site.
+# Please include any http or https prefix.
+SITE_URL = "http://coolcourse.s3-website-us-east-1.amazonaws.com"
+
+# Home_page sets the home page of the site.
+# This is usually /content/index.md.erb.
+#
+# Note: the .erb suffix is required when setting the HOME_PAGE path.
+HOME_PAGE = "/content/intro/welcome.md.erb"
+
+# Menulinks defines the links on the navigation bar.
+# They are formatted as "Name" - "URL" pair.
+#
+# Examples:
+#   %w[HOME /content/index.md]
+#   %w[TOC /content/course_toc.md]
+MENULINKS = [%w[lectures /content/intro/welcome.md/]].freeze
+
+# Helpful_box provides a feedback box on the sidebar.
+#
+# DO NOT USE. This is currently not functional.
 HELPFUL_BOX = false
+
+# STYLING
+#
+# Options:
+#   bullet_style: css style for each bullet
+STYLING_CONFIG = {
+  bullet_style: '"font-size: 60%; width: 10px; color: grey"'
+}.freeze
+
+# SEARCH
+#
+# Coursegen uses DocSearch by Algolia (https://docsearch.algolia.com/) to
+# provide site-wide full-text search functionality.
+#
+# In order for search to function, you need to replace with your own
+# search API key, and name of your index from Algolia.
+# For details, please refer to https://github.com/pitosalas/coursegen/blob/master/README.md.
+SEARCH_CONFIG = {
+  api_key: '855a55e631c6523e8201162e6d9c1e9c',
+  index_name: 'coolcourse',
+  # APP_ID is only used if you are running DocSearch on your own.
+  app_id: '',
+  debug: false
+}.freeze
+
+# SLIDES
+SLIDES_CONFIG = {
+  # Ignore_selectors ignore certain html elements from rendering in the slides.
+  ignore_selectors: ['li ul'],
+
+  # Reveal.js specific options
+  # See: https://revealjs.com/config/
+  revealjs_opts: {
+    transition: 'slide'
+  }
+}.freeze

data/templates/content/bootstrap/css/custom.css

@@ -1,33 +1,27 @@
 @import url("prettyquote.css");
 @import url("full-width-pics.css");
 @import url(//fonts.googleapis.com/css?family=Telex);
+@import url("postit.css");
+@import url("toasty.css");
+
+html {
+  font-size: 0.9rem;
+}
+body {
+  padding-bottom: 40px;
+}
 
 .themefg {
-  color: rgb(64,56,207);
+  color: rgb(64, 56, 207);
 }
 
 .themebg {
-  background-color: rgb(64,56,207);
+  background-color: rgb(64, 56, 207);
 }
 .nav-menus {
   height: 0px;
 }
-
-.navbar-inverse .navbar-nav > li > a {
-  padding-top: 4px;
-  padding-bottom: 0px;
-  color: white;
-}
-
-.navbar-inverse .navbar-nav > li > a:hover {
-  font-weight: bold;
-}
-
-a {
- color: rgb(64,56,207);
-}
-
-.navbar a.navbar-title {
+.masthead a {
   font-family: telex;
   float: left;
   margin-top: 20px;
@@ -54,19 +48,19 @@ a {
 }
 
 .navbar {
-	min-height: 35px;
-	margin-bottom: 1px;
+  min-height: 35px;
+  margin-bottom: 1px;
 }
 
 .navbar a:hover {
-	color: white;
+  color: white;
   text-decoration: none;
 }
 
-.navbar .input-group-sm input{
-	height: 22px;
-	width: 150px;
-	margin-top: 4px;
+.navbar .input-group-sm input {
+  height: 22px;
+  width: 150px;
+  margin-top: 4px;
 }
 
 .header-main {
@@ -77,176 +71,118 @@ a {
   padding-left: 45px;
 }
 
-h1, h2, h3, h4, h5{
-	font-family: telex;
-	color: rgb(64,56,207);
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+  font-family: telex;
+  color: rgb(64, 56, 207);
 }
 
-h3 {
+h1 {
   padding-top: 20px;
-  /* padding-bottom: 10px; */
+  font-size: 1.5rem;
+}
+
+h2 {
+  margin-top: 20px;
+  border-top: rgb(64, 56, 207) solid 2px;
+  padding-top: 5px;
+  font-size: 1.30rem;
 }
 
-/* h3.body-header {
-  margin-left: -15px;
-  margin-top: -10px;
-  margin-right: -15px;
-  margin-bottom: -22px;
-} */
+h3 {
+  font-size: 1.1rem;
+}
+
+h3.subheader {
+  /* border-bottom: rgb(64, 56, 207) solid 2px; */
+  padding-bottom: 5px;
+  margin-bottom: 10px;
+
+}
 
 h4 {
-	margin-top: 20px;
-  border-top: rgb(64,56,207) solid 3px;
-	padding-top: 5px;
+  font-size: 1.0rem;
+  margin-left: 18px;
 }
 
+/* Table use only */
 h5 {
-	margin-top: 15px;
-  font-weight: bold;
+  margin-top: 15px;
+  font-size: 0.8rem;
   font-variant: small-caps;
 }
 
-body {
-	padding-top: 40px;
-	padding-bottom: 40px;
+footer {
+  padding-top: 20px;
 }
 
-footer {
-	padding-top: 20px;
+.sidebar {
+  background-color: rgb(247, 241, 213);
+  margin-top: 20px;
 }
 
-.right-nav ul {
-	list-style: none;
-	padding-left: 12px;
-	margin-top: 3px
+.sidebar ul {
+  list-style: none;
+  padding-left: 12px;
+  margin-top: 3px;
 }
 
-.right-nav label.level2 {
-	margin-bottom: 0px;
+.sidebar label.level2 {
+  margin-bottom: 0px;
 }
 
-.right-nav a {
-	font-size: 85%;
+.sidebar a {
+  font-size: 85%;
 }
 
-.right-nav label.level1 {
-	text-transform: uppercase;
-	color: grey;
-	margin-top: 10px;
-	margin-bottom: 3px;
+.sidebar label.level1 {
+  text-transform: uppercase;
+  color: grey;
+  margin-top: 10px;
+  margin-bottom: 3px;
 }
 
-.right-nav label.level2 {
-	font-weight: normal;
+.sidebar label.level2 {
+  font-weight: normal;
 }
 
 .CodeRay .line-numbers {
-	margin-right: 15px;
+  margin-right: 15px;
 }
 
 .tree .bold a {
-	font-weight: bold;
+  font-weight: bold;
 }
 
 .tree .red a {
-	color: red;
+  color: red;
 }
 .tree .italic a {
-	font-style: italic;
+  font-style: italic;
 }
 
 .glyphicon-small {
-    font-size: 10px;
+  font-size: 10px;
 }
 
-/* Search Page */
-
 .h01 {
-     color: red;
-     font-weight: bold;
-}
-
-#tipue_search_results_count {
-	font-size: 14px;
-	color: red;
-	font-family: telex;
-}
-
-.tipue_search_content_title {
-	color: purple;
-	font-size: 16px;
-	margin-top: 15px;
-	margin-left: 10px;
-    text-rendering: optimizelegibility;
-	font-family: telex;
-}
-
-.tipue_search_content_text {
-	font-size: 14px;
-	margin-left: 30px;
-}
-
-div.tipue_search_content_loc a {
-	font-size: 14px;
-	margin-left: 20px;
-	display: none;
-}
-
-#tipue_search_foot
-{
-     margin: 51px 0 21px 0;
-}
-#tipue_search_foot_boxes
-{
-	padding: 0;
-	margin: 0;
-     font: 12px/1 'Open Sans', sans-serif;
-}
-#tipue_search_foot_boxes li
-{
-	list-style: none;
-	margin: 0;
-	padding: 0;
-	display: inline;
-}
-#tipue_search_foot_boxes li a
-{
-	padding: 9px 15px 10px 15px;
-     background-color: #f1f1f1;
-     border: 1px solid #dcdcdc;
-     border-radius: 1px;
-	color: #333;
-	margin-right: 7px;
-	text-decoration: none;
-	text-align: center;
-}
-#tipue_search_foot_boxes li.current
-{
-	padding: 9px 15px 10px 15px;
-     background: #fff;
-     border: 1px solid #dcdcdc;
-     border-radius: 1px;
-	color: #333;
-	margin-right: 7px;
-	text-align: center;
-}
-#tipue_search_foot_boxes li a:hover
-{
-	border: 1px solid #ccc;
-	background-color: #f3f3f3;
-}
-
-.helpful
-{
+  color: red;
+  font-weight: bold;
+}
+
+.helpful {
   visibility: hidden;
 }
 
 @media (max-width: 980px) {
-
-	/* Enable use of floated navbar text */
-	.navbar-text.pull-right {
-	  float: none;
-	  padding-left: 5px;
-	  padding-right: 5px;
-	}
+  /* Enable use of floated navbar text */
+  .navbar-text.pull-right {
+    float: none;
+    padding-left: 5px;
+    padding-right: 5px;
+  }
 }