When is Ubuntu-help used and when is GNOME-help used?

Doug Smythies dsmythies at telus.net
Wed Sep 11 23:34:35 UTC 2013


Hello Everyone (and we hope Matthew East and Jeremy Bicha see this and
provide valuable historical input):

 

In several of the desktop help master source files, there are conditional
statements so that one set of code will be used if the desktop is unity and
another set of code will be used otherwise (presumably for GNOME desktop).

 

Kevin has been working very hard (see the spreadsheet entries) on merging
GNOME updates and also checking the Unity part of each page, and has added
many more conditionals based on the precedence set by what was done
previously. 

 

The question we are asking is why?

 

We have tested a few scenarios and we can not find any situation where an
Ubuntu desktop computer would use the NOT Unity conditional code within
ubuntu-help. If the desktop environment is GNOME then the help system uses
GMONE-help and not Ubuntu-help. Therefore, we think all of this conditional
stuff is a waste of time. The proposed solution is to delete it.

 

Are we missing something?

 

Doug Smythies and Kevin Godby

 

Some more details:

 

Regular Ubuntu desktop computer: Uses ubuntu-help and displays what is
expected from Ubuntu-help.

 

GMONE desktop was installed on a 13.10 standard Ubuntu desktop installation,
and that option selected during logon. Any way that we could think of to get
into any help system resulted in GNOME-help and not Ubuntu-help. Note that
special little "flag" paragraphs were added to various index.page files to
be certain as to which page was being loaded (as if the title wasn't enough
of an indication).

 

The Ubuntu (GMONE) saucy daily ISO from a day or three ago was installed on
a new machine. Again, any way that we could think of to get into any help
system resulted in GNOME-help and not Ubuntu-help. Of course, one can force
Ubuntu-help by manually navigating to the correct file folder (which is
there, by the way) and selecting index.page and selecting "open with" and
then "help", but we consider that cheating, and it doesn't seem to work
properly anyway.

 

There are html build benefits if this can be cleaned up (due to some issues
in yelp-build, where it seems to include referenced files that are part of
the un-met condition during html compile). This is a minor point.

 

Below is segment of an example file (from prior to Kevin's edits) showing an
example of the conditionals we are discussing herein. The claim is that the
conditionals and the second paragraph can be deleted.
(Bluetooth-turn-on-off.page (revision 220)):

 

<if:choose>

  <if:when test="platform:unity">

    <p>You can turn Bluetooth on to use Bluetooth devices and send and
receive files,

    but turn it off to conserve power. To turn Bluetooth on, click the
Bluetooth icon

    in the menu bar and click <gui>Turn On Bluetooth</gui>.

    </p>

  </if:when>

  <p>You can turn Bluetooth on to use Bluetooth devices and send and receive
files,

  but turn it off to conserve power. To turn Bluetooth on, click the
Bluetooth icon

  on the top bar and switch <gui>Bluetooth</gui> on.</p>

</if:choose>

 

 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20130911/7d319b69/attachment.html>


More information about the ubuntu-doc mailing list