Re: Quick question about the manual and DocBook
| From: | Philip Olson | Date: | Thu, 02 Sep 2004 07:07:55 +0000 |
| Subject: | Re: Quick question about the manual and DocBook | ||
| References: | 1 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969363678@lists.php.net to get a copy of this message | ||
> > I have written the part in the manual about installing PHP on Gentoo
> > at the beginning of the summer. I can see now that it is online.
> >
> > My question is, is there any way to force the manual build so that the
> > Gentoo part of the UNIX installation is in a different file? The fact
> > that it is on the main "UNIX install" page is bugging me.
>
> That sort of bugs me as well, Its mostly due to the way phpweb is
> built. Attached is a fix so that the introduction has its own
> <sect1> forcing the gentoo not to be displayed on the first page.
>
> Example phpweb rendering:
> http://phpweb.zirzow.dyndns.org/manual/en/install.unix.php
>
> Any objections to this patch?
If this is done, it should also be applied to many other sections
in the PHP manual as that behavior is used all throughout the
manual. In just the installation docs alone, it's like this for
every chapter (Unix, Windows, and OS X) so if done all of them
should be edited too. And, eventually applied to other parts of
the manual. A big decision. It would have to be case-by-case
otherwise a lot of introductions would need written. For example
the control structures section has if() docs in the intro, is this
good? Bad? I don't know.
That said, I like the idea as it's often bugged me too. For example
the Windows installation docs should not include the "installer"
section within the Introduction. That's just plain wrong!
Regarding the patch itself, how about making the title read
Introduction instead of Intro.
Regards,
Philip