CSES

The Course Schedule Exchange Schema

English | 中文简体

Introduction

CSES is a universal course schedule exchange schema that can be used for exchanging schedules between different software. It is designed to be simple and easy to use, and can be easily converted to other formats such as ClassIsland format. We provide CSES-Editor to help you create and edit schedules and export to CSES format.

Features

• Simple: CSES is designed to be simple and easy to use.
• Universal: CSES is a universal format that can be easily converted to other formats.
• Easy to use: CSES is easy to use and can be easily understood by humans.

Grammer rules

File

The extention name of CSES file can only be .yml or .yaml. And you should encode it in UTF-8.

Define version

version: 1

Define subjects

subjects:
  - name: Math
    simplified_name: M # Optional, Better for Chinese subject name
    teacher: Mr. A # Optional
    room: 101 # Optional

Define schedules

schedules:
  - name: Monday
    enable_day: 1 # Day, range 1-7
    weeks: all # Enable on all weeks. You can fill [ "all" | "odd" | "even" ] in it. Each for all weeks, odd weeks and even weeks.
    classes:
      - subject: Math # Subject name. Be attention not the simplified name.
        start_time: "08:00:00" # The time when class begins. Format: "HH:MM:SS"
        end_time: "09:00;00" # The time when class dismiss. Format: "HH:MM:SS"

Schema

File Name: xxx.yml/xxx.yaml Codec: UTF-8

version: 1
subjects:
  - name: Math
    simplified_name: M # Optional, Better for Chinese subject name
    teacher: Mr. A # Optional
    room: 101 # Optional
  - name: English
    simplified_name: E
    teacher: Mr. B
    room: 102
  - name: Physics
    simplified_name: P
    teacher: Mr. C
    room: 103
  - name: Chemistry
    simplified_name: C
    teacher: Mr. D
    room: 104

schedules:
  - name: Monday
    enable_day: 1
    weeks: all
    classes:
      - subject: Math
        start_time: "08:00:00"
        end_time: "09:00:00"
      - subject: English
        start_time: "09:00:00"
        end_time: "10:00:00"
  - name: Tuesday-Odd
    enable_day: 2
    weeks: odd
    classes:
      - subject: Physics
        start_time: "08:00:00"
        end_time: "09:00:00"
      - subject: English
        start_time: "09:00:00"
        end_time: "10:00:00"
  - name: Tuesday-Even
    enable_day: 2
    weeks: even
    classes:
      - subject: Chemistry
        start_time: "08:00:00"
        end_time: "09:00:00"
      - subject: English
        start_time: "09:00:00"
        end_time: "10:00:00"

License

MIT