Mailing List Archive: Gentoo: Doc

Upcoming DTD change, fix your documents

Index | Next | Previous | View Threaded

neysx at gentoo

Sep 21, 2004, 7:09 AM

Post #1 of 3 (477 views)
Permalink

Upcoming DTD change, fix your documents

Xavier Neys wrote:
> Sven Vermeulen wrote:
>
>> Hi all
>>
>> Xavier has put up a nice fix for our XSL/DTD files that allow our
>> users to
>> quickly find the printable document of the page they are viewing.
>> Interested
>> readers should point their webbrowser to
>> http://bugs.gentoo.org/show_bug.cgi?id=64052
>>
>> The DTD will now require (instead of allow) the use of the link attribute
>> inside the <guide> and <book> tags, so
>>
>> <guide link="name-of-the-document.xml">
>> is now mandatory. Xavier has nicely added "backwards compatibility"
>> so that
>> documents who don't contain this link attribute still function. The
>> problem
>> we face is that some documents do contain a link attribute, but with a
>> wrong
>> value. This may lead to incorrect printable documents or even internal
>> server errors.
>>
>> Can the languages please check their documents if they contain a
>> (correct) link
>> attribute:

The updated list of docs with an invalid link is at
http://dev.gentoo.org/~neysx/badlinks.txt

I have just fixed many docs all over /doc/ and made them DTD compliant at the
same time.
Please check that I did not screw up your docs, especially non-latin alphabet
ones. You may slap me with a fish if I did ;-)

The following invalid docs are still in need of attention (or retirement)
./doc/ja/portage-user.xml
./doc/ja/build.xml
./doc/ru/gentoo-pda.xml
./doc/ru/gentoo-hppa-install.xml
./doc/ru/gentoo-x86-install.xml
./doc/ru/lvm.xml

With kind regards,
--
/ Xavier Neys
\_ Gentoo Documentation Project
/ French & Internationalisation Lead
\ http://www.gentoo.org/doc/en
/\

Attachments:

signature.asc (0.25 KB)

swift at gentoo

Sep 22, 2004, 3:54 AM

Post #2 of 3 (444 views)
Permalink

Re: Upcoming DTD change, fix your documents [In reply to]

On Tue, Sep 21, 2004 at 04:09:34PM +0200, Xavier Neys wrote:
> The updated list of docs with an invalid link is at
> http://dev.gentoo.org/~neysx/badlinks.txt
>
> I have just fixed many docs all over /doc/ and made them DTD compliant at
> the same time.
> Please check that I did not screw up your docs, especially non-latin
> alphabet ones. You may slap me with a fish if I did ;-)

I've committed the necessary DTD changes to CVS. However, sadly, it also
contains a fix I'd rather not see, namely the acceptance of block entities
within a <ti>...</ti> construction.

Kurt and Pieter have asked this for the release-guidelines (put images
inside a table) and the project page (note's inside a table) respectively.

May I ask *not* to do this in your documentation? I can see how allowing
images inside a table can still be accepted, but I'm hardly in favor of
placing note's and such within one.

Wkr,
Sven Vermeulen

--
^__^ And Larry saw that it was Good.
(oo) Sven Vermeulen
(__) http://www.gentoo.org Documentation & PR

swift at gentoo

Sep 23, 2004, 4:16 AM

Post #3 of 3 (443 views)
Permalink

Re: Upcoming DTD change, fix your documents [In reply to]

On Wed, Sep 22, 2004 at 12:54:04PM +0200, Sven Vermeulen wrote:
> I've committed the necessary DTD changes to CVS.
[...]

I will leave the XSL as-is for the next 24 hours. After those, I will take
the liberty to apply Xavier's XSL changes in CVS. Perhaps not in the 25th
hour, but within a few days without further notice.

If your documents aren't fixed (check Xavier's list sent previously in this
thread) and we receive bugreports about them, I will probably move them in
the Attic until you've fixed those.

Wkr,
Sven Vermeulen

--
^__^ And Larry saw that it was Good.
(oo) Sven Vermeulen
(__) http://www.gentoo.org Documentation & PR

Index | Next | Previous | View Threaded

Interested in having your list archived? Contact Gossamer Threads