Make /help useful + plugin api to register/unregister help commands

Bug #1033249 reported by Szabolcs Molnár
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
DC++
Fix Released
Wishlist
Unassigned

Bug Description

Currently the DC++ /help command shows nothing useful information on screen:

[19:19:34] *** /refresh, /me <msg>, /clear [lines to keep], /slots #, /dslots #, /search <string>, /f <string>, /dc++, /away <msg>, /back, /g <searchstring>, /imdb <imdbquery>, /u <url>, /rebuild, /download, /upload, /join <hub-ip>, /showjoins, /favshowjoins, /close, /userlist, /conn[ection], /fav[orite], /removefav[orite], /info, /pm <user> [message], /getlist <user>, /ignore <user>, /unignore <user>, /log <status, system, downloads, uploads>, /raw <raw-command>, /topic

After reaching a certain amount of commands, you won't be able to find what you're looking for. I suggest to change the output to the "one command per line with a descriptive text" format. Plugins could also benefit from that: if you make possible for plugins to register and unregister commands to the /help the same time (thus providing the consistent formatting which would depend on DC++ not the plugin itself!) plugins would also benefit from this.

Revision history for this message
Fredrik Ullner (ullner) wrote :

Adds a descriptive text to each /help-command and splits them up on multiple lines. Using "/help brief" will yield the old behaviour.

Note that it does not add support for plugins: this would need to be extended upon later if need be.

Revision history for this message
poy (poy) wrote :

this is great but the descriptions should be translatable.

1) make them translatable by using tstring(T_("text")) instead of _T("text") or with str(TF_("text %1% %2%") % param1 % param2) if parameters are needed. new lines should be kept out of translations.

2) either re-use the texts in the help/chat_commands.html file or modify it accordingly so that translators only have to translate once.

Revision history for this message
Fredrik Ullner (ullner) wrote :

Will now use T_ so the texts are translatable. Copied the texts from the help, so they should be (displaywise) the same.

Revision history for this message
poy (poy) wrote :

there is still a _T in the brief code paths, otherwise it's perfect. feel free to commit.

Fredrik Ullner (ullner)
Changed in dcplusplus:
status: New → In Progress
Fredrik Ullner (ullner)
Changed in dcplusplus:
importance: Undecided → Wishlist
Fredrik Ullner (ullner)
Changed in dcplusplus:
status: In Progress → Fix Committed
Revision history for this message
poy (poy) wrote :

Fixed in DC++ 0.830.

Changed in dcplusplus:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.