Difference between revisions of "Contest.yaml"
From PC2wiki
m (→Example: fixed example) |
m (→See Also: add link descriptions) |
||
| (36 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ==Overview== | |
| + | A '''contest.yaml''' file contains information used to specify a contest configuration to PC<sup>2</sup>. Contest.yaml files are written in [https://en.wikipedia.org/wiki/YAML YAML] and can be loaded into PC<sup>2</sup> either by using the [[Load_Contest_Configuration#Using_the_pc2_server | --load]] option (when starting a PC<sup>2</sup> Server) or by selecting the '''Import contest.yaml''' button on the [[Import CCS Tab]] of the PC<sup>2</sup> Admin '''Configure Contest''' screen. | ||
| + | |||
| + | A contest.yaml file consists of lines containing either colon-separated key:value pairs, or a list of items (called "mappings") starting with a dash. Whitespace (but not allowing tab characters) are used to indicate nested structure. | ||
==Contents of contest.yaml== | ==Contents of contest.yaml== | ||
| − | For the current [[CCS]] specification for a contest.yaml see [https://clics.ecs.baylor.edu/index.php/Contest_Control_System#contest.yaml | + | For the current [[CLICS]] [[CCS]] specification for a contest.yaml file see [https://clics.ecs.baylor.edu/index.php/Contest_Control_System#contest.yaml CLICS contest.yaml] |
{|border="1" cellpadding="1" | {|border="1" cellpadding="1" | ||
| Line 18: | Line 21: | ||
| duration || Duration as h:mm:ss (length of contest, in contest time) | | duration || Duration as h:mm:ss (length of contest, in contest time) | ||
|- | |- | ||
| − | | scoreboard-freeze || Time when scoreboard will be [[Scoreboard Freeze|frozen]] | + | | scoreboard-freeze-length || Time before end of contest when scoreboard will be [[Scoreboard Freeze|frozen]] form HH:MM:SS |
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| − | |||
| − | |||
| − | |||
|} | |} | ||
| Line 35: | Line 31: | ||
# Created: 2011-09-18 18:05:40 PDT | # Created: 2011-09-18 18:05:40 PDT | ||
| − | name: | + | name: Sample Contest |
| − | short-name: | + | short-name: SampCon |
elapsed: 0:00:00 | elapsed: 0:00:00 | ||
remaining: 5:00:00 | remaining: 5:00:00 | ||
running: false | running: false | ||
| − | scoreboard-freeze | + | # Freeze at 1 hour before the end of the contest |
| − | + | scoreboard-freeze-length: 1:00:00 | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==PC² specific keys and values== | ==PC² specific keys and values== | ||
| Line 68: | Line 43: | ||
The article [[CCS Enhancements]] describes these entries in more detail. | The article [[CCS Enhancements]] describes these entries in more detail. | ||
| − | + | Use [[system.pc2.yaml]] for custom pc2 settings. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Creating contest.yaml== | ==Creating contest.yaml== | ||
| Line 143: | Line 58: | ||
==See Also== | ==See Also== | ||
| − | * [[ | + | * [[Problem Format]] - Problem data and other files location description |
| − | * [[problem.yaml]] | + | * [[problem.yaml]] - problem specific settings |
| + | * [[problemset.yaml]] - problem definitions | ||
| + | * [[system.yaml]] - language and other settings | ||
| + | * [[system.pc2.yaml]] - pc2-specific settings | ||
| + | * [[CCS_Enhancements| CCS Enhancements]] | ||
| + | * [[Export Tab]] | ||
| + | * [https://clics.ecs.baylor.edu/index.php/Contest_Control_System ICPC CCS] | ||
| − | [[Category: | + | [[Category:CLICS]] |
[[Category:Version 9.3]] | [[Category:Version 9.3]] | ||
| − | |||
[[Category:Import and Export]] | [[Category:Import and Export]] | ||
Latest revision as of 10:32, 30 June 2017
Contents
Overview
A contest.yaml file contains information used to specify a contest configuration to PC2. Contest.yaml files are written in YAML and can be loaded into PC2 either by using the --load option (when starting a PC2 Server) or by selecting the Import contest.yaml button on the Import CCS Tab of the PC2 Admin Configure Contest screen.
A contest.yaml file consists of lines containing either colon-separated key:value pairs, or a list of items (called "mappings") starting with a dash. Whitespace (but not allowing tab characters) are used to indicate nested structure.
Contents of contest.yaml
For the current CLICS CCS specification for a contest.yaml file see CLICS contest.yaml
| Key | Description |
|---|---|
| name | Name of contest |
| short-name | Short name of contest |
| start-time | Date and time in ISO 8601 format (wall-clock time that the contest starts) |
| duration | Duration as h:mm:ss (length of contest, in contest time) |
| scoreboard-freeze-length | Time before end of contest when scoreboard will be frozen form HH:MM:SS |
Example
# Contest Configuration, version 1.0 # PC^2 Version: Version 9.3 20110918 (Sunday, September 18th 2011 23:51 UTC) Java ver 1.6.0_20 build 2345 Windows XP 5.1 (x86) # Created: 2011-09-18 18:05:40 PDT name: Sample Contest short-name: SampCon elapsed: 0:00:00 remaining: 5:00:00 running: false # Freeze at 1 hour before the end of the contest scoreboard-freeze-length: 1:00:00
PC² specific keys and values
The article CCS Enhancements describes these entries in more detail.
Use system.pc2.yaml for custom pc2 settings.
Creating contest.yaml
A contest.yaml, problem.yaml and data files can be saved using either:
- the Export Contest YAML feature
- or use the Export Contest XML Report
Loading contest.yaml
Use the Admin Import CCS tab, Import contest.yaml button.
See Also
- Problem Format - Problem data and other files location description
- problem.yaml - problem specific settings
- problemset.yaml - problem definitions
- system.yaml - language and other settings
- system.pc2.yaml - pc2-specific settings
- CCS Enhancements
- Export Tab
- ICPC CCS
