encoding declarations and stuff

Sean Wheller sean at inwords.co.za
Sat Dec 25 09:26:53 UTC 2004


I have noticed a number of problems in the docs that are technically wrong. I 
bring it to everyones attention so that we may avoid these simple errors.

Here is the results of a validation done on userguide.xml directly after svn 
co

E Element type "xi:include" must be declared.	usersguide.xml	
file:/home/sean/projects/unbuntu-docs/docs/faq/usersguide.xml	84:1

# to use XInlcude we need to declare the namespace. In my WC I have done the 
following
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
	"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY % xinclude SYSTEM "xinclude.mod">
%xinclude;
<!ENTITY % globalent SYSTEM "global.ent">
%globalent;
]>

F Invalid encoding name "utf8".	main.xml	
file:/home/sean/projects/unbuntu-docs/docs/faq/parts/about/main.xml	1:1

# the xml declaration should be
# <?xml version="1.0" encoding="UTF-8"?> as apposed to 
# <?xml version="1.0" encoding="utf8" ?>

F Error attempting to parse XML file (href='parts/about/main.xml').	
usersguide.xml	file:/home/sean/projects/unbuntu-docs/docs/faq/usersguide.xml	
84:1

# each file must have a DocType Decl

The validation fails at this point. Fixing userguide.xml reveals more 
problems. I won't list them here, but I think that we should enure that all 
files are valid and well-formed before any checkin.

-- 
Sean Wheller
Technical Author
sean at inwords.co.za
http://www.inwords.co.za
Registered Linux User #375355
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20041225/22a1a1d5/attachment.pgp>


More information about the ubuntu-doc mailing list