Usage of apturl in the documentation

Phil Bull philbull at gmail.com
Sat Sep 6 08:57:27 UTC 2008


Hi Matt,

On Fri, 2008-09-05 at 23:40 +0100, Matthew East wrote:
> Having discussed this briefly with Vadim on irc, it seems like a good
> idea to me to simplify some of our installation instructions
> (currently set out on WikiGuide/Style). But it would also apply to our
> offline docs, as well as wiki docs.
> 
> Does anyone know of any potential disadvantages to switching to apturl
> as our preferred method of giving an instruction to install software?
> 
> I haven't thought of a neat way to express an installation instruction
> so that it is helpful both to an Ubuntu user who can use apturl and
> just click a link, and those reading the page from another operating
> system or printing the page. I guess it would be something like:
> 
>  * Install ''package'' (by clicking here, or visiting
> SoftwareInstallation for more information).
> 
> But that's a little unwieldy. Does anyone have any neater ideas?

I can't think of any disadvantages, although it does make me wonder why
we don't automate more stuff like this...

Do we really need to link to a page explaining installation each time we
mention a package? Hopefully, any user who came across the instruction
but didn't know how to install packages would look up that information
independently.

Thanks,

Phil

-- 
Phil Bull
https://launchpad.net/people/philbull





More information about the ubuntu-doc mailing list