My observations on 'Help Topics' in Dapper

[Naaman Campbell]

On 1/31/06, Duncan Lithgow <duncan at lithgow-schmidt.dk> wrote:
> Here are some passing observations on the current state of the Help docs
> in Dapper. Hope something I've noted is relevant and useful.
>
> Duncan
>
> * 'Help Topics':
>   * General:
>     - file:///usr/share/ubuntu-docs/ubuntu/desktopguide/C/desktopguide.xml
>     - all headings and titles include unreadable character
> "3. Configuring Your System"
>   * Hardware > Sound:
>     - "1. Check that the sound isn't muted, click the speaker icon on
> the top panel of your Ubuntu desktop and check each device." Clicking on
> the speaker icon does not give access to multiple devices. Should this
> read "right click and select 'Open Volume Controls'" or something else?
>     - "2. Check to see if root can use sound. Type into a terminal:
>       ---------------------
>         $ sudo totem &
>       ---------------------
>     Once Totem launches, try playing a sound or movie file. If the sound
> now works, do the following in a terminal to enable everyone to use
> sound:" Should this include a phrase like '(you will need the root
> password)'
>     - the command doesn't seem to help:
>       -----------------
>       duncan at ubuntu:~$ sudo totem &
>       [1] 10604
>       -----------------
>     - Here's a try with 'sudo totem'
>       -----------------
>       duncan at ubuntu:~$ sudo totem
>       Password:
>       (totem:10664): Gdk-WARNING **: locale not supported by Xlib
>       (totem:10664): Gdk-WARNING **: cannot set locale modifiers
>       ** (totem:10664): WARNING **: Failed to connect to the session
> bus: No reply within specified time
>       -----------------

The 'sudo' should be replaced with 'gksudo', it worked for me although
I received warnings about the session manager.  I am yet to test on
Dapper (away from machine) - perhaps somebody else can confirm..  If
it is confirmed to work,  I think that there should be a rule in the
writing of docs to use gksudo with graphical apps and sudo only for
command-line based commands.

>     - At the end of the sound section it states "More information can be
> found on SoundProblemsHoary on the Ubuntu Wiki." If the information is
> valid for Dapper then the page should state that. Maybe it should to a
> page like SoundProblemsGeneral which links to version specific problem
> where needed.

At present, the Wiki, in general, is current for the current release -
Breezy Badger.  This is something I would like to address at a future
documentation team, what is the strategy for Wiki docs - my
suggestions are to explicitly state that a certain procedure is for an
older release and assume everything else is for the current release,
and to perhaps have CategoryBreezy, CategoryHoary, CategoryDapper
categories.  More on this later, another time, another place..

Naaman.