After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 413452 - Wrong example for Preferred Application capplet usage
Wrong example for Preferred Application capplet usage
Status: RESOLVED FIXED
Product: gnome-user-docs
Classification: Core
Component: user-guide
2.16.x
Other All
: Normal minor
: ---
Assigned To: Maintainers of Gnome user documentation
Maintainers of Gnome user documentation
: 452868 (view as bug list)
Depends on:
Blocks:
 
 
Reported: 2007-03-01 14:57 UTC by Luca Ferretti
Modified: 2009-02-12 08:08 UTC
See Also:
GNOME target: 2.26.x
GNOME version: 2.17/2.18


Attachments
Preferred applications rewritten (13.27 KB, patch)
2008-04-05 14:51 UTC, Claude Paroz
none Details | Review
Screenshot of new section (145.85 KB, image/png)
2008-04-05 14:52 UTC, Claude Paroz
  Details
Revised patch for preferred applications (13.47 KB, patch)
2008-10-11 20:12 UTC, Claude Paroz
none Details | Review

Description Luca Ferretti 2007-03-01 14:57:54 UTC
Documentation 
Section: <sect2 id="prefs-preferredapps"> in goscustdesk.xml
For example, you can specify Xterm as your preferred terminal application. When you open the System menu then choose Open Terminal, Xterm starts.

Correct version:
Better something like: "For example, you can specify the web browser application (Epiphany, Mozilla Firefox, Opera...) to launch when you enter a web address in the Run Application dialog or when you clic on a web link in other applications like email clients or document viewer"

Other information:
Note that there is no System -> Open Terminal command in default GNOME Desktop (a Sun customization?). Also the web browser example is better IMHO for a larger audience.

In case, make sure to use the proper name for Firefox (FireFox? Mozilla Firefox? Firefox?)
Comment 1 Andrew Burton 2007-08-23 12:43:56 UTC
*** Bug 452868 has been marked as a duplicate of this bug. ***
Comment 2 Matt Micek 2007-09-11 09:54:46 UTC
A possible fix is just removing the Xterm example and replacing with the example from the 8.1.5.1 section of goscustdesk.xml, which is similar to the correction above or using something like:

"For example, you can specify the web browser Firefox to launch when you click on a web link in email clients or when you enter a web address in the Run Application dialog." 

Example from section 8.1.5.1:

"For example, the preferred web browser opens when you select a URL in an application, or when you select a URL launcher on the desktop"

Then remove the example from the Web Browser section because examples would be redundant. Also the other sections for email and terminal do not have examples. 
Comment 3 Claude Paroz 2008-04-05 14:51:24 UTC
Created attachment 108671 [details] [review]
Preferred applications rewritten

Here is a rewrite proposal. Basically, I removed the specific Web browser, Mail reader and Terminal sections to replace them with a more general "Custom command options" section.
Comment 4 Claude Paroz 2008-04-05 14:52:37 UTC
Created attachment 108672 [details]
Screenshot of new section

Here's the corresponding Yelp screenshot for easier review.
Comment 5 Shaun McCance 2008-10-08 22:10:23 UTC
A few comments:

* "Run Application" should be inside <application>.  Better still, just remove that bit.  The Run Application dialog isn't in the Applications menu anymore, so it's kind of an insider-feature.

* In that same sentence, change "web link" to "link" and "like" to "such as".  I know, I know, just "link" is vague, because it could be a mailto link or something else.  But it's not worth the verbage.

* Change "applications effectively installed" to simply "applications installed".

* Capitalize each word in "Custom command options" for the title.

* In "<command>"%s"</command>", drop the quotes.  I'd probably change command to literal or userinput as well, since "%s" isn't really a command.

* "Enter the <command>exec</command> option to use with the command."  That doesn't seem right.  "exec" certainly isn't a command, and it's not really any literal value that should get special treatment.  This probably needs to be a few sentences that explain what the hell it is.  "Most terminal applications have an option that cause them to treat the remaining command line options as commands to run.  This is used when blah blah blah..."  Not sure exactly, but this is certainly non-obvious to normal people, so should get a decent explanation.


Note that I haven't applied the patch and looked at it in Yelp.  Nor have I compared the content to make sure it's actually in like with 2.24.  All I did was look over the patch file for things that stood out to me.

Thanks Claude.
Comment 6 Claude Paroz 2008-10-11 20:12:10 UTC
Created attachment 120405 [details] [review]
Revised patch for preferred applications

Here's the revised patch. Check particularly the wording of the "Exec Flag" section.
Comment 7 Claude Paroz 2008-10-13 09:22:37 UTC
FYI I've checked on current Ubuntu Intrepid beta and I don't see any change related to this section.
Comment 8 Matthias Clasen 2009-02-12 04:16:29 UTC
Patch looks good to me.
Comment 9 Claude Paroz 2009-02-12 08:08:10 UTC
Committed in trunk.