Linking to upstream documentation.

Matthew East mdke at ubuntu.com
Wed Dec 27 22:48:16 UTC 2006


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1



* Will Simpson:
> Is this an example of appropriate linking to upstream documentation.

{snip}

> New
> <para>For help with <application>gThumb</application>, use <ulink
> url="/usr/share/gnome/help/gthumb/C/gthumb.xml">gThumb
> Help</ulink>.</para>

The problem with that is that it will result in the link pointing at the
English langage version, whereas where possible we want it to go to the
automatically localised version. To do that with Gnome, there is the
following trick:

<ulink type="help" url="ghelp:documentname#section-id">Link text</ulink>

(#section-id is optional; grep for "ghelp" through trunk/ubuntu/C for
some examples of usage).

There is an equivalent trick for Kde, which Rich will no doubt know :)

Matt
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFFkvgwtSaF0w5rBv8RAhK2AJ9qwXL3ouJk1GWPTwlMjrRF6zfjqQCdGbH6
Qkdltb3+Mu81/r707gzA7WY=
=YlKv
-----END PGP SIGNATURE-----




More information about the ubuntu-doc mailing list