Skip to content

Commit

Permalink
Document colleges.tsv columns in spec
Browse files Browse the repository at this point in the history
  • Loading branch information
hftf committed Aug 14, 2024
1 parent 5f3c302 commit 5822df2
Showing 1 changed file with 24 additions and 6 deletions.
30 changes: 24 additions & 6 deletions SPEC.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
This page documents the plain-text data files used to generate the calendar and map pages of this website.

## Circuit map

Information about the colleges on the circuit map is stored in `map/colleges.tsv`.

## Season calendar

The layout of the main calendar pages (which contains the large tables) is generated by the template `_layouts/year.html`. It contains some hard-coded values, but generally does not need to be changed.
Expand Down Expand Up @@ -42,6 +38,12 @@ Dates may be `TBD`. If `speculative` is non-empty, the value for `firstmirror` w

In general, blank values are used when reliable information does not yet exist. The value for `clear` can be a future date if it is strongly assumed, but should later be changed to match the actual date when the set became clear.

Mirrors should generally be ordered in the source file canonically by date (weekend) and then by region, with playtest mirrors first and HS mirrors at the end, unless there is a good reason to order them in another manner.

Mirror names (i.e. college or school names) should generally remain consistent with existing convention in this repository. A guiding principle for mirror names is to be short enough to not wrap onto two lines when displayed in the main table, but not be overly abbreviated.

## Regions

Information about the geographic regions is stored in `map/regions.js`. The two-letter region IDs are also defined by `_layouts/year.html`, but this duplication will eventually be removed.
For convenience, the regions are listed below:

Expand Down Expand Up @@ -71,6 +73,22 @@ CA | Canada
UK | UK
AS | Asia

Mirrors should generally be ordered in the source file canonically by date (weekend) and then by region, with playtest mirrors first and HS mirrors at the end, unless there is a good reason to order them in another manner.
## Circuit map

Mirror names (i.e. college or school names) should generally remain consistent with existing convention in this repository. A guiding principle for mirror names is to be short enough to not wrap onto two lines when displayed in the main table, but not be overly abbreviated.
Information about the colleges on the circuit map is stored in `map/colleges.tsv`.

It is a tab-separated values (TSV) file, so tab characters must be used as delimiters.
The columns are as follows:

Key | Description | Example
-|-|-
`region` | Region code | `1A`
`active` | Club activity status (2 = hosts, 1 = attends, 0 = inactive) | `1`
`city` | City | `Storrs`
`state` | State | `CT`
`country` | Country | `USA`
`lat` | Latitude | `41.807741`
`long` | Longitude | `-72.253981`
`college_abbr` | Abbreviated name (e.g. acronym) | `UConn`
`college` | Common name (must be unambiguous) | `Connecticut`
`college_long` | Full name | `University of Connecticut`

0 comments on commit 5822df2

Please sign in to comment.