[chirp_devel] [PATCH] Chirp help menu should have a link to documentation on the wiki. Fixes #1277
# HG changeset patch # User Robert Terzi rct@r-t.org # Date 1385931834 18000 # Node ID f2f24b5c011c9c364327949168076f0a9c2873ab # Parent a03a1e9a3c99c1bcd85fe4c4a0501d3d02f68980 Chirp help menu should have a link to documentation on the wiki. Fixes #1277
diff -r a03a1e9a3c99 -r f2f24b5c011c chirpui/mainapp.py --- a/chirpui/mainapp.py Sun Nov 24 19:31:08 2013 -0600 +++ b/chirpui/mainapp.py Sun Dec 01 16:03:54 2013 -0500 @@ -1171,6 +1171,19 @@ d.run() d.destroy()
+ def do_documentation(self): + d = gtk.MessageDialog(buttons=gtk.BUTTONS_OK, parent=self, + type=gtk.MESSAGE_INFO) + + d.set_markup("<b><big>" + _("CHIRP Documentation") + "</big></b>\r\n") + msg = _("Documentation for CHIRP, including FAQs, and help for common " + + "problems is available on the CHIRP web site, please go to\n\n" + + "<a href="http://chirp.danplanet.com/projects/chirp/wiki/Documentation%5C%22%3E" + + "http://chirp.danplanet.com/projects/chirp/wiki/Documentation</a>\n") + d.format_secondary_markup(msg.replace("\n","\r\n")) + d.run() + d.destroy() + def do_columns(self): eset = self.get_current_editorset() driver = directory.get_driver(eset.rthread.radio.__class__) @@ -1358,6 +1371,8 @@ self.do_przemienniki(action[0] == "i") elif action == "about": self.do_about() + elif action == "documentation": + self.do_documentation() elif action == "columns": self.do_columns() elif action == "hide_unused": @@ -1452,6 +1467,7 @@ </menu> <menu action="help"> <menuitem action="about"/> + <menuitem action="documentation"/> <menuitem action="report"/> <menuitem action="developer"/> </menu> @@ -1506,6 +1522,7 @@ ('cancelq', gtk.STOCK_STOP, None, "Escape", None, self.mh), ('help', None, _('Help'), None, None, self.mh), ('about', gtk.STOCK_ABOUT, None, None, None, self.mh), + ('documentation', None, _("Documentation"), None, None, self.mh), ]
conf = config.get() @@ -1652,6 +1669,9 @@ aboutitem = self.menu_uim.get_widget("/MenuBar/help/about") macapp.insert_app_menu_item(aboutitem, 0)
+ documentationitem = self.menu_uim.get_widget("/MenuBar/help/documentation") + macapp.insert_app_menu_item(documentationitem, 0) + macapp.set_use_quartz_accelerators(False) macapp.ready()
This patch adds a menu entry, Documentation, which yields a pop-up box with the link to the Documentation page on the Chirp wiki.
On Linux, this link as well as the link in the About dialog will launch correctly, though there is a complaint about not being able to determine the mimetype in the console when clicking the documentation link.
On Windows clicking either URL results in a pop-up error message, "Could Not show Link No application is registered as handling this file"
There is an old open bug #330, "Invalid link in About dialog in Windows 7" which is some what of a misleading subject.
While it's possible that there is something that could be done in chirp's configuration of pyGTK, it seems to me that determining what the default browser is on the current windows and launching it is something that should be handled in gtk or pygtk's platform specific code.
On 12/1/2013 4:20 PM, Robert Terzi wrote:
# HG changeset patch # User Robert Terzi rct@r-t.org # Date 1385931834 18000 # Node ID f2f24b5c011c9c364327949168076f0a9c2873ab # Parent a03a1e9a3c99c1bcd85fe4c4a0501d3d02f68980 Chirp help menu should have a link to documentation on the wiki. Fixes #1277
diff -r a03a1e9a3c99 -r f2f24b5c011c chirpui/mainapp.py --- a/chirpui/mainapp.py Sun Nov 24 19:31:08 2013 -0600 +++ b/chirpui/mainapp.py Sun Dec 01 16:03:54 2013 -0500 @@ -1171,6 +1171,19 @@ d.run() d.destroy()
- def do_documentation(self):
d = gtk.MessageDialog(buttons=gtk.BUTTONS_OK, parent=self,
type=gtk.MESSAGE_INFO)
d.set_markup("<b><big>" + _("CHIRP Documentation") + "</big></b>\r\n")
msg = _("Documentation for CHIRP, including FAQs, and help for common " +
"problems is available on the CHIRP web site, please go to\n\n" +
"<a href=\"http://chirp.danplanet.com/projects/chirp/wiki/Documentation\">" +
"http://chirp.danplanet.com/projects/chirp/wiki/Documentation</a>\n")
d.format_secondary_markup(msg.replace("\n","\r\n"))
d.run()
d.destroy()
def do_columns(self): eset = self.get_current_editorset() driver = directory.get_driver(eset.rthread.radio.__class__)
@@ -1358,6 +1371,8 @@ self.do_przemienniki(action[0] == "i") elif action == "about": self.do_about()
elif action == "documentation":
self.do_documentation() elif action == "columns": self.do_columns() elif action == "hide_unused":
@@ -1452,6 +1467,7 @@ </menu> <menu action="help"> <menuitem action="about"/>
<menuitem action="documentation"/> <menuitem action="report"/> <menuitem action="developer"/> </menu>
@@ -1506,6 +1522,7 @@ ('cancelq', gtk.STOCK_STOP, None, "Escape", None, self.mh), ('help', None, _('Help'), None, None, self.mh), ('about', gtk.STOCK_ABOUT, None, None, None, self.mh),
('documentation', None, _("Documentation"), None, None, self.mh), ] conf = config.get()
@@ -1652,6 +1669,9 @@ aboutitem = self.menu_uim.get_widget("/MenuBar/help/about") macapp.insert_app_menu_item(aboutitem, 0)
documentationitem = self.menu_uim.get_widget("/MenuBar/help/documentation")
macapp.insert_app_menu_item(documentationitem, 0)
macapp.set_use_quartz_accelerators(False) macapp.ready()
chirp_devel mailing list chirp_devel@intrepid.danplanet.com http://intrepid.danplanet.com/mailman/listinfo/chirp_devel Developer docs: http://chirp.danplanet.com/projects/chirp/wiki/Developers
# HG changeset patch # User Robert Terzi rct@r-t.org # Date 1385931834 18000 # Node ID f2f24b5c011c9c364327949168076f0a9c2873ab # Parent a03a1e9a3c99c1bcd85fe4c4a0501d3d02f68980 Chirp help menu should have a link to documentation on the wiki. Fixes #1277
Personally, I think it's kinda silly these days to have in-app documentation for something that is built (and changed) daily. Having what looks like a documentation menu item which just reminds the user to go back to the website they just came from to find the documentation seems even more pointless to me. However, I know I'm not a normal user, so I've (begrudgingly) applied this.
- def do_documentation(self):
d = gtk.MessageDialog(buttons=gtk.BUTTONS_OK, parent=self,
type=gtk.MESSAGE_INFO)
d.set_markup("<b><big>" + _("CHIRP Documentation") + "</big></b>\r\n")
msg = _("Documentation for CHIRP, including FAQs, and help for common " +
"problems is available on the CHIRP web site, please go to\n\n" +
"<a href=\"http://chirp.danplanet.com/projects/chirp/wiki/Documentation\">" +
"http://chirp.danplanet.com/projects/chirp/wiki/Documentation</a>\n")
d.format_secondary_markup(msg.replace("\n","\r\n"))
d.run()
d.destroy()
I don't enforce 80-character columns tightly for driver submissions since they're often from non-developer types (even though I'd love to be better about that). For the core code, I'd like to keep it tidy whenever possible. I applied the patch and committed a small cleanup on top.
Thanks!
--Dan
participants (2)
-
Dan Smith
-
Robert Terzi