Conservancy/symposion_app
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add schedule docs

Browse source
This commit is contained in:
David Ray 2014-03-03 14:10:28 -05:00
parent b7ecf8984c
commit 18077539a9
2 changed files with 50 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/index.rst
View file

@ -19,6 +19,7 @@ Apps:
sponsorship sponsorship
speakers speakers
proposals proposals
schedule
Indices and tables Indices and tables

49
docs/schedule.rst Normal file
View file

@ -0,0 +1,49 @@
Schedule App
===========
The ``schedule`` app allows staff members to create the schedule for the
conference's presentations, breaks, lunches, etc.
The ```schedule``` app has a number of models that facilitate building the
structured schedule:
* Schedule: A high level container that maps to each Conference Section.
* Day: A Day associated with a Schedule.
* Room: A Room associated with a Schedule.
* Slot Kind: A type of Slot associated with a Schedule.
* Slot: A discreet time period for a Schedule.
* Slot Room: A mapping of a Room and Slot for a given Schedule.
* Presentation: A mapping of a Slot to an approved Proposal from the ```proposals``` app.
Schedule Builder Form
---------------------
It can be cumbersone to generate a schedule through the admin. With that in mind,
a generic schedule builder is available via a Schedule's edit view. For instance,
if a Conference site has a Talks Section and Schedule, the form would be
available for Staff at::
/schedule/talks/edit
The form consume a structured CSV file, from which it will build the schedule.
Sample CSV data is included below::
"date","time_start","time_end","kind"," room "
"12/12/2013","10:00 AM","11:00 AM","plenary","Room2"
"12/12/2013","10:00 AM","11:00 AM","plenary","Room1"
"12/12/2013","11:00 AM","12:00 PM","talk","Room1"
"12/12/2013","11:00 AM","12:00 PM","talk","Room2"
"12/12/2013","12:00 PM","12:45 PM","plenary","Room1"
"12/12/2013","12:00 PM","12:45 PM","plenary","Room2"
"12/13/2013","10:00 AM","11:00 AM","plenary","Room2"
"12/13/2013","10:00 AM","11:00 AM","plenary","Room1"
"12/13/2013","11:00 AM","12:00 PM","talk","Room1"
"12/13/2013","11:00 AM","12:00 PM","talk","Room2"
"12/13/2013","12:00 PM","12:45 PM","plenary","Room1"
"12/13/2013","12:00 PM","12:45 PM","plenary","Room2"
It is worth noting that this generates the **structure** of the schedule. It
does not create Presentation objects. This will need to be done manually.
One can also **delete** an existing schedule via the delete action. This is
irreversible (save for a database restore).