265995 - Ensure 2.18 branch documentation has valid XML files (partially done)

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[Colin Ogilvie [:cso]]

User-Agent:       Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.7.3) Gecko/20041024 Firefox/0.10.1
Build Identifier: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.7.3) Gecko/20041024 Firefox/0.10.1

The following patch ensures that the 2.18 Branch Documentation is valid XML
files. This will allow moving away from jade processing the docuemntation to
using xmlto.

As far as I can tell, the documentation will generate with both xmlto and
makedocs.pl after this change

Reproducible: Always
Steps to Reproduce:

Comment 1

[Colin Ogilvie [:cso]]

Attachment: Patch v1

This patch adds:

* The URL for the Docbook 4.1.2 DTD
* Removes bz-devel entity, and adds 3 new ones; may not be strictly needed on
the branch
* converts two cases of && to &

Comment 2

[Max Kanat-Alexander]

I think this is a definitely-wanted change.

Comment 3

[Jacob Steenhagen]

Ya know, I just discovered that the bz-devel thingy that I've been using isn't
standard in the XML version of DocBook. I'm actually really disappointed as I've
actually grown to love that little directive (even though some of my uses of it
were removed). I found it to be quite useful and as it made putting "development
version" type notes and refrences into the docs in such a way that they wouldn't
be included on a full realease so easy.

I really need to see if I can find a way to continue doing this while also
having standard XML. Truthfully, at this point I'd rather my XML be non-standard
yet retain this capability :(.

Comment 4

[Jacob Steenhagen]

Comment on attachment 163333 [details] [diff] [review]
Patch v1

There's no way to say that it's half a review, so instead I'm just gonna mark
this with a plus though I'm only gonna check in the stuff not related to
bz-devel. I know it's not everything you want, but it's at least better than
nothing.

Note: Still need to do it on the 2.18 branch.

Comment 5

[Jacob Steenhagen]

I can't approve the request for blocking 2.18, but being that this is a
documentation issue, I can approve it for the branch. Therefore, I'm changing
those two flags :)

Also, I filed bug 273519 about the bz-devel issue. So, even though it's only
partially fixed, I'm gonna go ahead and mark this bug as FIXED.

Comment 6

[Vlad Dascalu]

Docs no longer use the approval flag currently; clearing flag.