Dealing with Installing Programs in the desktopguide (was Re: A couple of DocBook style questions)

[Matthew East]

On Mon, 2006-02-13 at 07:32 -0800, Jeff Schering wrote:

> Here's how it's done in the internet section of common-tasks.xml:

> [quote]
> 2.4.4.1. Macromedia Flash for Mozilla Firefox
> 
>    1.      Make sure the multiverse repository is enabled. (See Adding
> Extra Repositories)
>    2.      Install the flashplayer-mozilla package with Add/Remove
> Applications (See Section 1.3 ― Adding, Removing and Updating
> Applications)
> 
>       World Wide Web (multiverse) > flashplayer-mozilla
> 
>    3.      The plug-in will be available the next time you start Firefox.
> [/quote]

This is kind of what I wanted to get away from. The problem is that
synaptic and gnome-app-install each have different categories in which
they put the packages. It is very easy for the user to just use the
search function, so I don't think the categories are helpful. So we
could reformulate, to ensure that this is as clear and easy as possible.

> > I'd also suggest that we use the <filename> tags around names of
> > repositories, because that makes them stand out a bit, in monospace,
> > which is nice I think.
> 
> It's better to use the <emphasis> tag for this, I think..

Ok, I agree. How about:

[quote]
Install <application>X</application> from the <emphasis>Y</emphasis
repository (see <xref linkend="add-applications"/>).
[/quote]

Using this everywhere has the advantage of simplicity, and shortening
the guide, which I think is very desirable. I don't think it sacrifices
any clarity, in fact I think it's easier to follow than before.

Matt
-- 
mdke at ubuntu.com
gnupg pub 1024D/0E6B06FF
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20060213/c7c54aa2/attachment.pgp>