Updated README

nigel.stanger / Handbook

Browse code Updated README master
1 parent e00d73a commit 2afc8f6f2601b5a4531b627f5dde07be93fcb5a2 Nigel Stanger authored on 3 Feb 2021

Patch

Showing 1 changed file

Ignore Space Show notes View calendar/README.md
# Rolling over to a new year ## Initial setup Copy `teachingdates/config/config.yml` to `~/.config/generate_dates` and configure to suit. ## Teaching calendar dates (LaTeX) For example: ```bash python3 -m teachingdates --format latex --style calendar --teaching-period S1 > calendar_weeks.tex ``` or if you don’t want to type quite so much: ```bash python3 -m teachingdates -f l -s c -t S1 > calendar_weeks.tex ``` Move `calendar_weeks.tex` to somewhere sensible in your user `texmf` tree. ## Teaching calendar dates (XML) ```bash python3 -m teachingdates --format xml --teaching-period S1 > paper-calendar-dates.xml ``` Move `paper-calendar-dates.xml` into the `modules` directory of the XML framework. (Note: `--teaching-period` isn’t actually required, but the configuration code hasn’t yet been fixed to ignore it.) ## Lecture dates For example: ```bash python3 -m teachingdates --format latex --style lecture --paper INFO201 --teaching-period S1 > lecturedates.tex ``` or if you don’t want to type quite so much: ```bash python3 -m teachingdates -f l -s l -p INFO201 -t S1 > lecturedates.tex ``` Move `lecturedates.tex` to wherever it’s needed. Rolling over to a new year ========================== Teaching calendar dates (LaTeX) ------------------------------- 1. Set up teaching periods in `calendar_config.php`. 2. `make install` Teaching calendar dates (XML) ----------------------------- 1. Go to `$TEACHING_SHARED/Authoring/XML`. 2. Set up teaching periods in `generate_calendar_dates.php`. 3. `make`. This should be better integrated one day! Lecture dates ------------- 1. Set up teaching period dates, and paper class offsets in `lecturedates_config.php`. 2. For each paper, run `generate_lecturedates.php` and write the output to the appropriate `.tex` file.

Ignore Space Show notes View

calendar/README.md

# Rolling over to a new year

## Initial setup

Copy `teachingdates/config/config.yml` to `~/.config/generate_dates` and configure to suit.

## Teaching calendar dates (LaTeX)

For example:

```bash
python3 -m teachingdates --format latex --style calendar --teaching-period S1 > calendar_weeks.tex
```

or if you don’t want to type quite so much:

```bash
python3 -m teachingdates -f l -s c -t S1 > calendar_weeks.tex
```

Move `calendar_weeks.tex` to somewhere sensible in your user `texmf` tree.

## Teaching calendar dates (XML)

```bash
python3 -m teachingdates --format xml --teaching-period S1 > paper-calendar-dates.xml
```

Move `paper-calendar-dates.xml` into the `modules` directory of the XML framework.

(Note: `--teaching-period` isn’t actually required, but the configuration code hasn’t yet been fixed to ignore it.)

## Lecture dates

For example:

```bash
python3 -m teachingdates --format latex --style lecture --paper INFO201 --teaching-period S1 > lecturedates.tex
```

or if you don’t want to type quite so much:

```bash
python3 -m teachingdates -f l -s l -p INFO201 -t S1 > lecturedates.tex
```

Move `lecturedates.tex` to wherever it’s needed.

Show line notes below