course.yaml

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS-IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# FIXME: You can use this configuration file to customize Course Builder
# for a specific course. More information on YAML can be found at:
#
#     http://www.yaml.org/spec/1.2/spec.html#id2759963
#
# Note that the values in this file can contain arbitrary HTML.

############################
# General course information
############################

course:
  # A new line or a space separated list of email addresses of course
  # administrative users. Each email address must be placed between '[' and ']',
  # for example: '[test@example.com]'. Regular expressions are not supported,
  # exact match only.
  admin_user_emails: ''

  # General configuration: title, instructor and so on ---
  
  # Course title in main page
  title: 'COURSE TITLE'

  # Main page blurb. (The '|' at the beginning enables multi-line input.)
  blurb: |
    This course will trigger you to know more about the world of ...

  # Information about the instructor to display on the main page.
  instructor_details: 'Name Surname <br> Job position <br> Company name'

  # You can choose whether you want a video or an image on the main page.
  # If you specify both a video and an image link, then the video will take
  # priority. The image alt text allows the image to be understood by text-only
  # screen readers.
  main_video:
    #url: //www.youtube.com/embed/b27PBnyVtmU
  main_image:
    url: /assets/img/banner.png
    alt_text: 'Some nice robots'

  # Course start date.
  start_date: 'February 05, 2013'

  # TODO-FIX - dgerod: This is an ongoing feature.
  # Enable/disable references in course page.
  references_in_course: False

  # Calendar embedding URL ---
  
  # Enable/disable the calendar page
  # Set this value to False if you don't use calendar and to remove 
  # the Calendar link from the student navigation bar.
  calendar_on: True  
  
  # Google calendar embedded link
  calendar_embed_url: https://www.google.com/calendar/embed?showTitle=0&amp;showPrint=0&amp;showTz=0&amp;height=600&amp;wkst=2&amp;hl=en&amp;bgcolor=%23FFFFFF&amp;src=c2jvev72r3coiboc53j2k9b8vg%40group.calendar.google.com&amp;color=%23125A12&amp;ctz=Europe%2FMadrid

  # Forum page ----
  # For details, see: 
  #      http://code.google.com/p/course-builder/wiki/WebForums.

  # Enable/disable the forum page
  # Set this value to False if you don't use forum and/or to remove 
  # the Forum link from the student navigation bar.  
  forum_on: True

  # Select embedded forum or external one
  # If true the forum is open in an external page.
  use_external_forum: True
    
  # Forum URL. 
  # The forum is not embedded in forum page, it is open in external page
  #forum_url: //groups.google.com/group/My-Course
  forum_url: https://plus.google.com/u/0/communities/110493022769407924841

  # Forum embedding URL. 
  # This link is used to embed the forum in an iframe on the forum.html page.   
  #forum_embed_url: //groups.google.com/forum/embed/?place=forum/My-Course
  forum_embed_url: http://groups.google.com/forum/embed/?place=forum/course-builder-forum
  
  # Wiki ---
  
  # Enable/disable the wiki page
  # Set this value to False if you don't use wiki and/or to remove 
  # the Wiki link from the student navigation bar.
  wiki_on: True

  # Announcements ---
  
  # URL for the mailing list where students can register to receive course
  # announcements. For details, see
  #
  #     http://code.google.com/p/course-builder/wiki/CreateEmailList
  
  #announcement_list_url: //groups.google.com/group/My-Course-Announce

  # Locale for internationalization.
  locale: 'en_US'


####################################
# Information about your institution
####################################

institution:
  # Name of your institution
  name: 'Open Robotics University'

  # URL of your institution's webpage
  url: 'http://www.openroboticsuniversity.net/'

  # Link and alt text for the logo of the course or your institution
  logo:
    url: 'assets/img/logo.png'
    alt_text: Institution Logo


#########################################
# Base page template for all course pages
#########################################

base:
  # HTML to be included in all course pages. For example: if you want to
  # include any analytics code that covers all your course webpages, you can do
  # so here: see
  #
  #     https://code.google.com/p/course-builder/wiki/ReachAndEngagementMetrics.
  #
  # for details.
  before_head_tag_ends: '<!-- base.before_head_tag_ends -->'
  after_body_tag_begins: '<!-- base.after_body_tag_begins -->'
  after_navbar_begins: '<!-- base.after_navbar_begins -->'
  before_navbar_ends: '<!-- base.before_navbar_ends -->'
  after_top_content_ends: '<!-- base.after_top_content_ends -->'
  after_main_content_ends: '<!-- base.after_main_content_ends -->'
  before_body_tag_ends: '<!-- base.before_body_tag_ends -->'

  # Whether to show a G+ button on the header of all pages.
  show_gplus_button: True

  # Header phrase for the main navigation bar
  nav_header: 'Course name'

  # Link to your privacy policy and terms of service
  privacy_terms_url: 'PRIVACY_POLICY_AND_TERMS_OF_SERVICE'


########################
# Course preview page
########################

preview:
  # HTML to be included in the course preview page.
  after_top_content_ends: '<!-- preview.after_top_content_ends -->'
  after_main_content_ends: '<!-- preview.after_main_content_ends -->'


##########################
# Course registration form
##########################

reg_form:
  # Header text for the course registration form.
  header_text: |
    Welcome!  Please answer the following question, and you will be
    enrolled in the course.

  # HTML representing additional fields to include in the course
  # registration form, in addition to the student's name. These should
  # be wrapped in <li></li> tags.
  additional_registration_fields: '<!-- reg_form.additional_registration_fields -->'

  # Whether to allow new students to register for the course.
  can_register: True


##############################
# Assessment confirmation page
##############################

# HTML to be displayed on the test confirmation page (which is displayed when
# the student has completed an assessment). You can optionally add code here
# to load or generate a Certificate of Completion image. Note that the
# postcourse assessment texts include a '%s', which will be substituted with
# the student's actual score. ('%%' results in a single '%'.)
assessment_confirmations:
  postcourse_header: |
    Thank you for taking the post-course assessment. Your score is %s%%.
  postcourse_pass: |
    Based on your overall course score (which includes the mid-course and
    post-course assessments), you have passed the course. Congratulations!
  postcourse_fail: |
    Unfortunately, based on your overall course score (which includes the
    mid-course and post-course assessments), you did not receive a
    sufficiently high score to obtain a certificate of completion. We
    encourage you to review the lessons noted and to attempt the
    assessment again before it closes. Certificate or not, we hope you
    enjoyed taking the course and learned new skills!
  midcourse: |
    Thank you for taking the mid-course assessment. You may return and take
    this assessment again, or continue on to the next unit.
  precourse: |
    Thank you for taking the pre-assessment. Please begin the course with
    Unit 1.


########################
# Units and lessons page
########################

unit:
  # HTML to be included in the course unit/lesson pages.
  after_leftnav_begins: '<!-- unit.after_leftnav_begins -->'
  before_leftnav_ends: '<!-- unit.before_leftnav_ends -->'
  after_content_begins: '<!-- unit.after_content_begins -->'
  before_content_ends: '<!-- unit.before_content_ends -->'