Skip to content
Open
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions doc/examples/example.cs
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
using System;

public class Hello
{
public static void Main(string[] args)
{
public class Hello {
public static void Main(string[] args) {
int nTests = int.Parse(Console.ReadLine());

for (int i = 0; i < nTests; i++) {
Expand Down
1 change: 0 additions & 1 deletion doc/examples/example.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@
for i in range(n):
name = sys.stdin.readline().rstrip('\n')
print('Hello %s!' % (name))

1 change: 1 addition & 0 deletions doc/manual/substitutions.dist.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
.. |DOMjudge| replace:: DOMjudge
.. |baseurlteam| replace:: https://example.com/domjudge/team
.. |problemseturlteam| replace:: https://example.com/domjudge/team/problems
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to mention the URL? It's in the menu, nobody should need to enter more than the base URL anyway.

.. |SOURCESIZE| replace:: 256
.. |COMPILETIME| replace:: 30
Expand Down
5 changes: 4 additions & 1 deletion doc/manual/substitutions.py.in
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# @configure_input@

baseurl_separator = '/' if '@BASEURL@'[-1]!='/' else ''

rst_prolog = """
.. |DOMjudge| replace:: @PACKAGE_NAME@

.. |phpversion| replace:: @PHPVERSION@
.. |baseurlteam| replace:: @BASEURL@%steam
.. |problemseturlteam| replace:: @BASEURL@%steam/problems

.. |SOURCESIZE| replace:: 256
.. |COMPILETIME| replace:: 30
.. |PROCLIMIT| replace:: 64

""" % ('/' if '@BASEURL@'[-1]!='/' else '')
""" % tuple(['/' if '@BASEURL@'[-1]!='/' else '']*2)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what this is used for, and the commit doesn't explain it

Binary file added doc/manual/team-problemset.png
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest using a screenshot without jury access, so that there is no "--> Jury" and perhaps also without Print functionality.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 35 additions & 14 deletions doc/manual/team.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ become of importance when you run into problems.
.. admonition:: Summary

The web interface of DOMjudge can be found at
|baseurlteam|. See the two figures on the next page for
|baseurlteam|. See the three figures on the next pages for
an impression.

Solutions have to read all input from 'standard in' and write all
Expand Down Expand Up @@ -54,6 +54,13 @@ become of importance when you run into problems.
requests and replies is done through the web interface at
|baseurlteam|.

Use the |problemseturlteam| page to get:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leave the URL out here (as mentioned on the other commit)


- 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,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to propose an alternative text.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about something like this?

- view indicators for problem difficulty (submission and acceptance rates) across contest intervals (hover over the boxes for exact numbers),

- get the problem statement and clarifications on those statements
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Either add a comma at the end here or remove it from the first two lines.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went with the extra comma.

- see the time & memory limits.


.. raw:: pdf

Expand All @@ -76,6 +83,11 @@ Overview of the interface

The scoreboard webpage.

.. figure:: team-problemset.png
:width: 80%

The problem set webpage.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The problem set webpage.
The problemset webpage.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The UI uses problemset it seems so that's why I'm suggesting it.


.. raw:: pdf

PageBreak
Expand Down Expand Up @@ -128,6 +140,15 @@ an error message otherwise.

Web interface
`````````````
The problems can be found at |problemseturlteam|.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line can be removed.

The setup of every contest is different so the judges may provide the problemset in hardcopy
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

or provide the single problem PDFs here and an optional online full problem set.
Sometimes a clarification about a problem is send, you can view those coupled with the statement with the problem.
The judges may provide additional attachments like extra input files, testing/helpful tools or anything relevant to the problem.
You can use this page to pick the next problem to solve, DOMjudge shows the progress of the contest with the amount of
successful and failed submissions, you can use those to find the next problem to solve with as rule of thumb that problems
which are solved often in the beginning are most likely simpler and problems which are solved later in the contest are
deemed harder to grasp.

Solutions can be submitted from the web interface at |baseurlteam|.
Click the green *Submit* button at the menu bar on every page.
Expand Down Expand Up @@ -297,7 +318,7 @@ This will be documented in the problem description.
Restrictions
````````````

Submissions are run in a sandbox to prevent abuse, keep the jury system
Submissions are run in a sandbox to prevent abuse, keep the judging system
stable and give everyone clear and equal environments. There
are some restrictions to which all submissions are subjected:

Expand Down Expand Up @@ -371,14 +392,14 @@ follow.
What follows is a number of possible solutions to this problem
for different programming languages.

.. literalinclude:: ../examples/example.py
:language: python
:caption: *A solution in Python*

.. literalinclude:: ../examples/example.c
:language: c
:caption: *A solution in C*

.. raw:: latex

\clearpage

.. literalinclude:: ../examples/example.cc
:language: cpp
:caption: *A solution in C++*
Expand All @@ -387,22 +408,22 @@ for different programming languages.
:language: java
:caption: *A solution in Java*

.. raw:: pdf

PageBreak

.. raw:: latex

\clearpage

.. literalinclude:: ../examples/example.kt
:language: kotlin
:caption: *A solution in Kotlin*

.. literalinclude:: ../examples/example.py
:language: python
:caption: *A solution in Python*

.. literalinclude:: ../examples/example.cs
:language: csharp
:caption: *A solution in C#*

.. literalinclude:: ../examples/example.pas
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps just comment it out, so it can be easily re-used? Also consider commenting out all other non-default ICPC languages.

:language: pas
:caption: *A solution in Pascal*

.. literalinclude:: ../examples/example.hs
:language: hs
:caption: *A solution in Haskell*
Expand Down
Loading