Ubuntu Switching

[Matthew East]

Hi Dougie,

* Dougie Richardson:
> Evening all,
> 
> I've updated the installing.xml part of the Ubuntu switching
> documentation. Its tested and works.

It's REALLY good. I've got some small points on the style. I haven't
been able to reliably check the content - I haven't used the installer
in a long time, so we'll trust you on that!

If you can just make some small changes as per the below then we'll
upload it and people can build on it if that's appropriate.

= Validity =

Always try the validate.sh script on your document before sending a patch:

$ ../../../validate.sh switching.xml

In this case, there are some invalidity problems caused a lack of <para>
tags inside some <listitem> tags, you need:

<listitem><para>CONTENT</para></listitem> to make it valid.

Also there are some missing entities in applications.xml, which is
obviously not your fault so ignore those!

= Cross referencing =

Please don't use xreflabels - they cause problems for translations. Just
leave it out and the contents of <title> will be used for cross
referencing, which works better. However, since we do that, it's
important when inserting cross references to use language that is
completely neutral, because different programs which generate html may
generate xrefs in different ways. So, instead of

"This will involve some extra steps when <xref
linkend="installing-partitioning"/> later"

use

"This will involve some extra steps when partitioning later (see <xref
linkend="installing-partitioning"/>"

And, instead of:

"There is much more information in <xref
linkend="preparing-backing-up-entire"/>"

use

"For more information, see <xref linkend="preparing-backing-up-entire"/>

I would guess you have just picked up what you have done from an
existing error somewhere in our docs - if so, please feel free to
correct it too.

The rest is all great, subject to a few typos which we don't need to
worry about: we'll just iron those out once it is uploaded.

Thanks for the work and long may it continue!

Matt
-- 
http://www.mdke.org
gnupg pub 1024D/0E6B06FF

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 252 bytes
Desc: OpenPGP digital signature
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20070727/5615d8ab/attachment.pgp>