lernid-classroom(5)

NAME
lernid-classroom - lernid-classroom configuration files

DESCRIPTION
This manual page explains the lernid-classroom configuraiton files. Each has an arbitrary name and uses the config file syntax. Each is located in /etc/lernid-classrooms.d

It is recommended to name each file after the classroom described.

The fields are described below.

SECTION NAME
The section name ("[some name]") beginning the file is the name of the classroom described.

FIELDS
Each field is followed by a colon, a space, and a value.

homepage
    The initial page that should be displayed by Lernid's web browser.

classroom
    The IRC room name of the classroom.

chat
    The IRC room name of the room for class discussion and questions.

icalurl
    The url of the calendar containing this classroom's sessions.

question_token
    The token that should be used in this classroom to mark questions of the session's instructor.

locale
    The locale for sessions for the classroom.

logstring
    The string used to create the url for accessing the classroom logs. The year, month and day of the month are inserted (in that order).

server
    IRC server containing the above classrooms.

question_token overrides the default value selected by the locale field. If neither is provided the default question_token is "QUESTION:"

FILES
vcal calendars contain classroom session names, times, and description items. The vcal calendar event description may contain the following fields:
Each field is followed by a colon, a space, and a value.

description
    The description of the session.

instructors
    The IRC nicknames of the instructor or instructors of the session.

helpers (optional)
    The IRC nicknames of those who may assist with the session and may help control it.

slides (optional)
    The url of a .pdf file containing the slides to be used. Each is a page of the pdf.

event (optional)
    The event of which this session is a part.

locale (optional)
    The locale for the session.

question_token (optional)
    The token that should be used in this classroom to mark questions of the session's instructor.

The session's locale and question_token values override those specified for the classroom as a whole, above, and again the question_token value overrides the value implied by the locale.

EXAMPLE
[#ubuntu-classroom -- In English]
homepage: https://wiki.ubuntu.com/Classroom
classroom: ubuntu-classroom
chat: ubuntu-classroom-chat
logstring: http://irclogs.ubuntu.com/%04d/%02d/%02d/%%23ubuntu-classroom.html
icalurl: http://www.google.com/calendar/ical/canonical.com_qg6t4s8i7mg8d4lgfu9f93qid4@group.calendar.google.com/public/basic.ics