Skip to content

Commit

Permalink
Add header for javascript code and update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
desilinguist committed Jun 19, 2019
1 parent f065ca5 commit 1972c9d
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
17 changes: 17 additions & 0 deletions assets/js/schedule.js
@@ -1,3 +1,20 @@
/**
* Copyright (c) 2019
*
* Code that powers the customized
* schedule generation for NAACL 2019
* website. Allows a user to expand/collapse
* parallel sessions, examine conflicting
* talks, choose the desired ones, and generate
* a PDF of their customized agenda.
*
* @summary Code for NAACL 2019 official website schedule.
* @author Nitin Madnani (nmadnani@ets.org)
*
* This code is licensed under the MIT license.
* https://opensource.org/licenses/MIT
*/

sessionInfoHash = {};
paperInfoHash = {};
chosenPapersHash = {};
Expand Down
8 changes: 7 additions & 1 deletion webagenda/README.md
Expand Up @@ -18,7 +18,7 @@ conda activate naacl2019

### Contents

There are two main files in this directory:
There are three main files that support the schedule on the website:

1. `generate.py` : This is the main driver script that generates the schedule markdown file for the repository. This script uses the classes defined in the `orderfile.py` module from the NAACL 2019 schedule repository that is integrated as a submodule in this repository under the `agenda` directory. It takes as input a single JSON configuration file that contains the following fields:

Expand All @@ -40,6 +40,12 @@ For more details on how this script works, please refer to the code and the comm

2. `frontmatter.md` : This markdown document contains the Jekyll frontmatter that needs to be appended on top of the HTML generated by `generate.py` to generate a valid markdown file that will be rendered properly by Jekyll. This file expected by `generate.py` to live in the same directory without being provided explicitly as input.

3. `assets/js/schedule.js` : This is the core JavaScript code that powers the official schedule page on the NAACL website. It allows a user to expand and collapse various sessions, shows them which papers conflict with each other as they hover on them, allows them to select the papers they are interested in, and, finally, generates a PDF with the user's customized schedule. The code uses the following JavaScript libraries:
- [jQuery](https://jquery.com)
- [jsPDF](https://parall.ax/products/jspdf) along with the amazingly useful [autotable plugin](https://github.com/simonbengtsson/jsPDF-AutoTable)
- [Altertify](https://alertifyjs.com)
- [fold-to-ascii](https://github.com/mplatt/fold-to-ascii)

### Generating the Schedule

The following command will generate the schedule markdown file at `_pages/program/schedule.md` for the website without the video and paper icons. This command should be run in the top level of the cloned repository:
Expand Down

0 comments on commit 1972c9d

Please sign in to comment.