The Org-Coursepack provides a template for developing and managing teaching materials using Org mode, a major mode in GNU Emacs.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Assets
Courses
Topics
sphinx
.travis.yml
CONTRIBUTING.md
LICENSE
README.org
export-org-coursepack.el
paper.bib
paper.md
tests.el

README.org

Org-Coursepack

https://jose.theoj.org/papers/10.21105/jose.00034/status.svg https://travis-ci.com/joonro/Org-Coursepack.svg?branch=master

The Org-Coursepack provides a template for developing and managing teaching materials using Org mode, a major mode in GNU Emacs.

Please see the quickstart guide for basic usage of Org-Coursepack with screenshots.

The template (see Courses/Template) is designed to be self-explanatory, as the documentation for it (see Courses/Org-Coursepack) consists of an example course developed with this template. See the HTML version of the documentation.

See paper.md for the detailed summary for the template.

Dependencies

Using Org-Coursepack requires Emacs for creating course content and LaTeX for exporting handouts. Follow the installation instructions below.

Emacs

See the official Download & installation page to learn how to install Emacs.

Emacs init file

The Org-Coursepack includes an example Emacs init file (located at /Assets/.emacs.d/init.el which has necessary settings for its basic usage (e.g., package installations and export options). You can place the file (init.el) into the .emacs.d directory under your HOME folder (~/.emacs.d/init.el). See Where do I put my init file? of the Emacs documentation for more details. (Note that, for Emacs to be able to locate the init file in Windows, you must to add an environmental variable named HOME, with the variable value set to your user profile directory (e.g., C:\Users\UserName). See How do I set or change the PATH system variable? to learn how to add environmental variables in Windows.)

Those already using Emacs would likely have an init file with their own custom settings. They can copy and paste necessary codes from the example init file (e.g., lines starting from ;; * Org-Coursepack settings) to their own init file.

Note that the init file is set up to detect and install any necessary packages (htmlize, org-plus-contrib, and ox-reveal) that are missing. This might lengthen the startup time when the user runs Emacs for the first time.

LaTeX

You can install TeX Live (for GNU/Linux and Windows) or MacTeX (for macOS).

Installation of Org-Coursepack

Org-Coursepack can be installed by cloning the repo ($ git clone https://github.com/joonro/Org-Coursepack.git) or by downloading and unzipping the ZIP archive. The Org-Coursepack is a self-contained package and thus will work regardless of where it is installed; hence, users can freely choose the location of the installation.

Usage

We created the full documentation in the form of a short course. You can read the HTML version of the documentation or take a look at exported PDF files.

Example Courses

The Org-Coursepack includes two example courses created with Org-Coursepack: Introduction to Regression Analysis with Excel and Introduction to Regression Analysis with Python. These example courses showcase the modular usage of the template, as they focus on how to reduce redundancy in creating overalapping course materials.

The two courses share plenty of materials in statistical topics, but one course applies these topics using Excel while the other uses Python. Demonstrating how to efficiently construct course materials with the Org-Coursepack, the courses share materials on statistical topics via topic Org files and selectively include materials related to Python and Excel from their own respective topic Org files where needed.

See the semester Org files, exported syllabus, and exported lecture files linked below.

Introduction to Regression Analysis with Excel

Introduction to Regression Analysis with Python

Authors

Changelog

v1.1.0

  • Add two example courses, Introduction to Regression Analysis with Excel and Introduction to Regression Analysis with Python