sphinx-doc/sphinx

allow to specify translation context

Open

#8,251 opened on Sep 28, 2020

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Python (1,985 forks)batch import
help wantedinternals:internationalisationtype:enhancement

Repository metrics

Stars
 (5,625 stars)
PR merge metrics
 (Avg merge 10d 11h) (11 merged PRs in 30d)

Description

Is your feature request related to a problem? Please describe. Sometimes you need to have separate translations for the same source strings.

Describe the solution you'd like This is accomplished by translation contexts, eg

#: src/gui/widgets/preferences.c:858
msgctxt "guilabel"
msgid "Plugins"
msgstr "プラグイン"

Here, the string "Plugins" is for the translation context "guilabel". There might be another string "Plugins" for another translation context, where the translation will be different.

There should be a way to optionally specify translation contexts, either, per-string, or per-document, or for the whole project that sphinx is translating.

Describe alternatives you've considered N/A

Additional context See Contexts in gettext manual: https://www.gnu.org/software/gettext/manual/html_node/Contexts.html

Contributor guide

Research direction
Investigate how Sphinx currently extracts translatable strings and how gettext contexts can be integrated into the .pot file generation and translation workflow.
Tech stack
python
Domain
documentationinternationalization
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Pythongettext
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60