i18n for fixed problem description strings

[thorehusfeldt]

Problemtools allows problem descriptions in multiple languages, but the fixed headlines are hard-coded in English like this:

problemtools/problemtools/templates/latex/problemset.cls

Line 222 in 063b68a

\newcommand{\sampleinputname}{Sample Input}

It would be nice if those few headlines were localised, based on the two-letter language code of the problem description file.

One way I can think of doing that, implemented on https://github.com/thorehusfeldt/problemtools/tree/feat/i18n is to provide localisations in a yaml file in the template directory /problemtools/templates/latex/strings.yaml

.en:
    sampleinputname: Sample Input
    sampleoutputname: Sample Output
    sampleinteractname: Sample Interaction
    sampleinteractreadname: Read
    sampleinteractwritename: Write
.sv:
    sampleinputname: Exempel på indata
    sampleoutputname: Exempel på utdata
    sampleinteractname: Exempel på interaktion
    sampleinteractreadname: Läs
    sampleinteractwritename: Skriv

Then /problemtools/templates/latex/template.tex gets a few new placeholders:

\renewcommand{\sampleinputname}{%(sampleinputname)s}
\renewcommand{\sampleoutputname}{%(sampleoutputname)s}
\renewcommand{\sampleinteractname}{%(sampleinteractname)s}
\renewcommand{\sampleinteractreadname}{%(sampleinteractreadname)s}
\renewcommand{\sampleinteractwritename}{%(sampleinteractwritename)s}

and the templating mechanism in problemtools/template.py takes care of replacing strings into self.language, falling back on English.

   if self.language in self.strings:
            strings = self.strings[self.language]
        else:
            strings = self.strings['.en']
            print('Unable to find string translations into {}, using English instead'.format(self.language))
        for s in strings:
            data[s] = strings[s]

Other approaches exist, such as using templates in problemset.cls. Or using babel. But the above works, and is quite light-weight.

[simonlindholm]

Yes please! We've felt a need for this, and tried to do something like it for BOI 2018: https://github.com/nordicolympiad/baltic-olympiad-2018/tree/master/templates. Some phrases could be reused from there.

(That used latex includes though, which made the problems non-freestanding and Kattis people unhappy. Which we should have solved by copying the files into every problem folder, but that would have been a bit annoying for us, as well as making updates harder, and we were too stressed to do it.)

[thorehusfeldt]

I see. What I’ve done so far is only to streamline the result of problem2pdf, which means localising exactly the 5 strings defined in problemset.cls, such as \sampleinputname, so this changes Sample Input 1 into Sämple Inpyt 1. If my understanding is correct, then the HTML pages are built via plasTex from pdf, so the HTML inherits those.

Many of the other strings you mention seems to “live” somewhere else (constraints, memorylimit), and I’m unsure what to override. To be honest, I don’t even know if the HTML page that ends up on a Kattis instance is produced by problemtools/problem2html , or if Kattis has its own version.

(The localisation that really triggers my OCD is what one should do about language-specific conventions for decimal numbers: “Förklaring för exempel 1: Den sammanlagda sträckningen är 14,233345”.)

[simonlindholm]

Ah, yeah, the additional strings are probably a separate discussion from this (though they would be very useful). Time limit/memory limit were from when we created freestanding pdfs of the problems, those strings wouldn't appear on the web.

Kattis does use problem2html, and yes, the strings work with HTML as well.

[thorehusfeldt]

I can submit a pull request from my branch any time, but maybe it’s premature.

It works with the problems that I’ve tried it on, including the warmups from the Swedish olympics.

I’ve tested with explicit selection form the command line, presence of various problem.xx.tex, single problem.sv.tex, without command line flags, etc. Seems to work, and degrade somewhat gracefully if it can’t find the proper files, but I may be naive about which environments it would be run in.

[gkreitz]

This is a very good feature request.

I'm working on the problemset.cls file a bit at the moment, and I think I see a way to work this in there. I like your translations to Swedish, and we've reached out to get translation in Icelandic. If anyone wants to contribute translations, feel free to add them here (the strings which need translation are still the same as in the description of this issue).

It's unfortunate that the linked BOI repository with translations seems to predate interactive samples, so a couple of strings we need are missing from the translations there.

[Tagl]

Icelandic would be

.is:
    sampleinputname: Sýniinntak
    sampleoutputname: Sýniúttak
    sampleinteractname: Sýnisamskipti
    sampleinteractreadname: Lestur
    sampleinteractwritename: Skrif

[gkreitz]

I've added a PR now. The format isn't quite as easy to write as a yaml blob, but it's now implemented directly in problemset.cls. Doing translations for a language looks like:

% Swedish
\newcommand{\@translation@sv@sampleinputname}{Exempel på indata}
\newcommand{\@translation@sv@sampleoutputname}{Exempel på utdata}
\newcommand{\@translation@sv@sampleinteractname}{Exempel på interaktion}
\newcommand{\@translation@sv@sampleinteractreadname}{Läs}
\newcommand{\@translation@sv@sampleinteractwritename}{Skriv}