Skip to content

Náboj translation checklist

Kvík edited this page Aug 10, 2022 · 7 revisions

Text

At the beginning off the process you should have access to the English translation of the problems, already copied in the directory of your language along with symbolic links to all images. Each problem resides in its own directory and has three files: problem.md, solution.md and answer.md. Optionally picture files might be present, most often in svg format.

Example

  • english
    • planets
      • problem.md
      • solution.md
      • answer.md
      • gravity.svg
  • hungarian
    • planets
      • problem.md (different content)
      • solution.md (different content)
      • answer.md (different content)
      • gravity.svg (symlink to ../../english/planets/gravity.svg)
  • polish
    • (same structure)
  • (more languages)

Images

Please ensure that all problems contain appropriate images (either deduce from context, or compare with the english version). Most of the time pictures are identical across all translations, in this case there only should be symlinks to the slovak version.

You need to include the ![](){} macro so that the correct image is included in the text. Again, this should already be there in the English translation provided to you, but please make sure this is actually the case. It is unfortunate if this is found during the competition. The macro should not be modified, except for its caption (only in solutions, images in problems do not have captions, the first [] pair should be empty).

Constants

There is a global YAML file containing all the constants needed for constant tables. This ensures different translations all use the same values. The names of the constants are stored in DeGeŠ's module file which is not accessible from Náboj git, so they have to be provided globally. Many constants are already there, but in case new constants are added in future volumes, you will need to provide translations directly to us.

Translation quality assurance tiers

Tier 1

Translate files offline. If done properly, this theoretically should be enough. If there is anything that is not completely clear to you, please consult. Things may be lost in translation sometimes though: either we might have introduced some errors into the English translation, or you erred independently. In any case, this is a big problem if it is not found before the competition.

You do not need to translate solution.md if your translation team does not wish to produce a booklet.

Tier 2

Translate and recalculate the problem as stated in your language. Make sure that the answer to the question in the problem statement is actually written in the answer file.

Tier 3

Cross-check: have someone read the translated problems and try to solve them independently. This helps us catch problems with translations (for instance, in volume 22 we inadvertently changed "radius" for "diameter" in English translation and this led to correct results not being accepted in languages that used English as reference).

Tier 4

Organize a full-fledged test, with mock teams comprising people who had not seen the problems beforehand (and of course, who are not going to compete). The Slovak team organizes at least one such test before translations are provided, so many bugs are caught at this stage (and sometimes even problems are swapped if proved too difficult or ugly), but given more eyes, more bugs are shallow.

Clone this wiki locally