1724105 - Allow parameters to be localised

Status: RESOLVED FIXED

(SeaMonkey :: Chat, enhancement)

Description

[Ian Neal]

At the moment cmd.*.params is used both for parsing of parameters and also providing usage information for /help
This can cause confusion for localisers and also make help less friendly to cZ users.

Comment 1

[Ian Neal]

Attachment: 1724105-irc-params-25310.patch

[Approval Request Comment]
Regression caused by (bug #): n/a
User impact if declined: less friendly /help messages
Testing completed (on m-c, etc.): 2.53.10
Risk to taking this patch (and alternatives if risky): low
String changes made by this patch: lots

Whilst here I have removed the unused getDocumentation function.
Parameter information for parsing is now stored in the cmdary object.
Help information is now only collected for those commands that can be issued from the console (i.e. typed in) which means some unused strings can be removed from chatzilla.properties
Those commands that do have parameters now have a cmd..helpUsage entry in chatzilla.properties that can be localised - change from cmd..params to cmd.*.helpUsage is to prompt localisers to now translate the strings - will probably need to post to l10n forums about it.

Comment 2

[Ian Neal]

Attachment: 1724105-irc-params-v1_1-25310.patch

Changes since last patch:
Added some localization notes

Comment 3

[Frank-Rainer Grahl (:frg)]

Comment on attachment 9235247 [details] [diff] [review]
1724105-irc-params-v1_1-25310.patch

LGTM

At least 2 languages have partially translated params. Should a hint be added to just change the older .params to .helpUsage (this is what I did with de) if translated or something to communicate when the patch lands?

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/dcdca80bec85
Allow parameters to be localised. r=frg

Comment 5

[Frank-Rainer Grahl (:frg)]

https://gitlab.com/seamonkey-project/seamonkey-2.53-comm/-/commit/37b06e5074da58c0a46e0847c2e99f9ff333e670
Allow parameters to be localised. r=frg a=frg