From 868d1c22fb974ca3515eebe9ef0ec86671ae774c Mon Sep 17 00:00:00 2001 From: cubercsl <2014cais01@gmail.com> Date: Sat, 3 Aug 2024 14:19:44 +0800 Subject: [PATCH] docs: specify externalid and shortname is optional Document that external ID and shortname are optional key in domjudge-problem.ini metadata file. This was implemented in e316344c6faa2317e951e39985cab0f371d96358 but is not documented. Closes #2633. Signed-off-by: cubercsl <2014cais01@gmail.com> --- doc/manual/problem-format.rst | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/doc/manual/problem-format.rst b/doc/manual/problem-format.rst index e9f6cbc300..f256d53e79 100644 --- a/doc/manual/problem-format.rst +++ b/doc/manual/problem-format.rst @@ -44,14 +44,16 @@ interface): - ``special_compare`` - executable id of a special compare script - ``points`` - number of points for this problem (defaults to 1) - ``color`` - CSS color specification for this problem - -The basename of the ZIP-file will be used as the problem short name (e.g. "A"). -All keys are optional. If they are present, the respective value will be -overwritten; if not present, then the value will not be changed or a default -chosen when creating a new problem. Test data files are added to set of test -cases already present. Thus, one can easily add test cases to a configured -problem by uploading a zip file that contains only testcase files. Any jury -solutions present will be automatically submitted when ``allow_submit`` is -``1`` and there's a team associated with the uploading user. + - ``externalid`` - the external id of the problem + - ``short-name`` - the short name of the problem + +The basename of the ZIP-file will be used as the problem external id and short +name (e.g. "A"). All keys are optional. If they are present, the respective +value will be overwritten; if not present, then the value will not be changed +or a default chosen when creating a new problem. Test data files are added to +set of test cases already present. Thus, one can easily add test cases to a +configured problem by uploading a zip file that contains only testcase files. +Any jury solutions present will be automatically submitted when ``allow_submit`` +is ``1`` and there's a team associated with the uploading user. .. _ICPC problem package specification: https://icpc.io/problem-package-format/spec/problem_package_format