0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Use multiple lines for help, and add translation notes

Browse source 
This removes all of the "do not translate part^string part" strings, replacing
them with more help in English and a place for translators to explain what the
untranslatable "all" means. For commands where the usage has notes about the
arguments, this embeds the \n in the strings passed to register_command; that
seems a reasonable balance between usability and effort to implement it.

Cherry-picking between 1.14 and 1.15: In 1.14.x, the "droid" command only has
options "on" and "off". The "full" option was only added in 1.15.
This commit is contained in:
Steve Cotton 2019-08-27 06:40:27 +02:00
parent d3d3c040f5
commit ba4f3a70b6
3 changed files with 25 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
changelog.md
View file

@ -6,6 +6,8 @@
### Language and i18n
* Updated translations: French, Portuguese (Brazil)
* Set up for translating the Wings of Victory campaign (PR#4265)
* Changed the :help command's output to split over multiple lines
* Added translatable explanations of :droid, :help and :idle's arguments
## Version 1.15.1
### Editor

19
src/map_command_handler.hpp
View file

@ -215,7 +215,10 @@ protected:
register_command("help", &map_command_handler<Worker>::help,
_("Available commands list and command-specific help. "
"Use \"help all\" to include currently unavailable commands."),
_("do not translate the 'all'^[all|<command>]"));
// TRANSLATORS: These are the arguments accepted by the "help" command,
// which are either "all" or the name of another command.
// As with the command's name, "all" is hardcoded, and shouldn't change in the translation.
_("[all|<command>]\n“all” = overview of all commands, <command> = name of a specific command (provides more detail)"));
}
//derived classes initialize the map overriding this function
virtual void init_map() = 0;
@ -323,15 +326,21 @@ protected:
ss << _(" No help available.");
}
else {
ss << " - " << c->help;
ss << " - " << c->help << "\n";
}
if (!c->usage.empty()) {
ss << " " << _("Usage:") << " " << cmd_prefix_ << cmd << " " << c->usage;
ss << _("Usage:") << " " << cmd_prefix_ << cmd << " " << c->usage << "\n";
}
const auto flags_description = get_command_flags_description(*c);
if (!flags_description.empty()) {
// This shares the objectives dialog's translation of "Notes:"
ss << _("Notes:") << " " << get_command_flags_description(*c) << "\n";
}
ss << get_command_flags_description(*c);
const std::vector<std::string> l = get_aliases(cmd);
if (!l.empty()) {
ss << " (" << _("aliases:") << " " << utils::join(l, " ") << ")";
// TRANSLATORS: alternative names for command-line commands, only shown if
// there is at least one of them.
ss << _n("command^Alias:", "Aliases:", l.size()) << " " << utils::join(l, " ") << "\n";
}
print(_("help"), ss.str());
}

12
src/menu_events.cpp
View file

@ -1188,9 +1188,15 @@ protected:
register_command("refresh", &console_handler::do_refresh, _("Refresh gui."));
register_command("droid", &console_handler::do_droid, _("Switch a side to/from AI control."),
_("do not translate the on/off/full^[<side> [on/off/full]]"));
// TRANSLATORS: These are the arguments accepted by the "droid" command,
// which must be a side-number and then optionally one of "on", "off" or "full".
// As with the command's name, "on", "off" and "full" are hardcoded, and shouldn't change in the translation.
_("[<side> [on/off/full]]\n“on” = enable but retain vision, “full” = as if it’s controlled by another player"));
register_command("idle", &console_handler::do_idle, _("Switch a side to/from idle state."),
_("do not translate the on/off^[<side> [on/off]]"));
// TRANSLATORS: These are the arguments accepted by the "idle" command,
// which must be a side-number and then optionally "on" or "off".
// As with the command's name, "on" and "off" are hardcoded, and shouldn't change in the translation.
_("command_idle^[<side> [on/off]]"));
register_command("theme", &console_handler::do_theme);
register_command("control", &console_handler::do_control,
_("Assign control of a side to a different player or observer."), _("<side> <nickname>"), "N");
@ -1200,7 +1206,7 @@ protected:
register_command("foreground", &console_handler::do_foreground, _("Debug foreground terrain."), "", "D");
register_command(
"layers", &console_handler::do_layers, _("Debug layers from terrain under the mouse."), "", "D");
register_command("fps", &console_handler::do_fps, _("Show fps."));
register_command("fps", &console_handler::do_fps, _("Show fps (Frames Per Second)."));
register_command("benchmark", &console_handler::do_benchmark);
register_command("save", &console_handler::do_save, _("Save game."));
register_alias("save", "w");