Document team boxes #3176
Document team boxes #3176
Conversation
We need to duplicate the code for the BASEURL separator, and python3 doesn't have an easy way to do this simpler.
This would give us more space in the team manual
The space is now available.
doc/manual/team.rst
Outdated
|
|
||
| - all attachments such as 'testing tools' to problems, | ||
| - view the submission and acceptance ratio during the contest as an indicator of the difficulty of a problem, | ||
| - get the problem statement and clarifications on those statements |
There was a problem hiding this comment.
Either add a comma at the end here or remove it from the first two lines.
There was a problem hiding this comment.
I went with the extra comma.
| .. figure:: team-problemset.png | ||
| :width: 80% | ||
|
|
||
| The problem set webpage. |
There was a problem hiding this comment.
| The problem set webpage. | |
| The problemset webpage. |
There was a problem hiding this comment.
I looked that one up and it seems that 'problem set' is the correct form and 'problemset' is something which is informally accepted. I'm fine with both though.
There was a problem hiding this comment.
The UI uses problemset it seems so that's why I'm suggesting it.
| Use the |problemseturlteam| page to get: | ||
|
|
||
| - all attachments such as 'testing tools' to problems, | ||
| - view the submission and acceptance ratio during the contest as an indicator of the difficulty of a problem, |
There was a problem hiding this comment.
I like the brevity of this explanation, but I'm not sure if we might want to include a hint that more information is available when hovering the indicators.
There was a problem hiding this comment.
Feel free to propose an alternative text.
Co-authored-by: Jaap Eldering <eldering@users.noreply.github.com>
| .. |DOMjudge| replace:: DOMjudge | ||
| .. |baseurlteam| replace:: https://example.com/domjudge/team | ||
| .. |problemseturlteam| replace:: https://example.com/domjudge/team/problems |
There was a problem hiding this comment.
Do we need to mention the URL? It's in the menu, nobody should need to enter more than the base URL anyway.
| .. |PROCLIMIT| replace:: 64 | ||
|
|
||
| """ % (baseurl_separator, baseurl_separator) | ||
| """ % tuple(['/' if '@BASEURL@'[-1]!='/' else '']*2) |
There was a problem hiding this comment.
Not sure what this is used for, and the commit doesn't explain it
doc/manual/team.rst
Outdated
| requests and replies is done through the web interface at | ||
| |baseurlteam|. | ||
|
|
||
| Use the |problemseturlteam| page to get: |
There was a problem hiding this comment.
Leave the URL out here (as mentioned on the other commit)
| Use the |problemseturlteam| page to get: | ||
|
|
||
| - all attachments such as 'testing tools' to problems, | ||
| - view the submission and acceptance ratio during the contest as an indicator of the difficulty of a problem, |
There was a problem hiding this comment.
What about something like this?
- view indicators for problem difficulty (submission and acceptance rates) across contest intervals (hover over the boxes for exact numbers),
|
|
||
| Web interface | ||
| ````````````` | ||
| The problems can be found at |problemseturlteam|. |
| Web interface | ||
| ````````````` | ||
| The problems can be found at |problemseturlteam|. | ||
| The setup of every contest is different so the judges may provide the problemset in hardcopy |
There was a problem hiding this comment.
I suggest the following phrasing:
Judges may distribute the digital versions of the problems either individually per or as full problemset through DOMjudge.
If the judges issue a clarification for a problem, it will be sent out and displayed in the corresponding problem card.
The judges may provide additional files for a problem, such as extra inputs, testing tools, or other relevant attachments.
You can use the problemset page to help decide which problem to solve next. DOMjudge shows the live contest progress, including the number of successful and failed submissions for each problem.
Use the info from the problemset page and the scoreboard to gauge problem difficulty. A good rule of thumb is: Problems solved often and early in the contest are likely easier. Problems solved infrequently or only later in the contest are typically more difficult.
| :language: csharp | ||
| :caption: *A solution in C#* | ||
|
|
||
| .. literalinclude:: ../examples/example.pas |
There was a problem hiding this comment.
Perhaps just comment it out, so it can be easily re-used? Also consider commenting out all other non-default ICPC languages.
There was a problem hiding this comment.
I would suggest using a screenshot without jury access, so that there is no "--> Jury" and perhaps also without Print functionality.
5 participants
This was mentioned by @meisterT in another PR, so this is a start of documenting the
/problemspage. I removed thepascalexample as it forces us to another page and I suspect it's never needed (not sure how many tries it will save in a year).The resulting PDF:
domjudge-team-manual.pdf