PHP Documentation - New skeletons

Author

New skeletons

Hannes Magnusson

2007-10-27, 7:01 pm

Hi All

As most of you know I've been working on new skeletons for a while,
mainly to solved "The OO Problem".

Creating those skeletons I've done bunch markup changes in
manual.xml.in and the "normal extensions" reference.xml.

The new manual.xml.in can be found in CVS (the REF_STRUCT_DEV branch)
and the new (normal extension) skeleton on
http://doc.php.net/wiki/skeletons.
I'm not entirely finished with the OO skeletons just yet, but am
aiming towards finishing them tomorrow.

The difference between (normal) procedural- & oo-extension skeletons
aren't that big, the OO ones will have more <reference /> elements
(one for each class) and some fancy markup to auto-generate a neat
"PHP code" representation of the methods, constants & properties of
the class.

The main difference from the old skeletons is that each extension will
now be a "fully functional docbook" and capable of having multiple
chapters, articles, appendixes and references.

For those of you with REF_STRUCT_DEV checkout, building with PhD, take
a look at the refs.basic.vartype and refs.basic.text pages (and all
their extensions) to see how these new skeletons will turn out.
For the rest of you; why don't you have PhD+REF_STRUCT_DEV checkout? :)

-Hannes

Hannes Magnusson

2007-10-28, 7:05 pm

On 10/27/07, Hannes Magnusson <hannes.magnusson@gmail.com> wrote:
> The new manual.xml.in can be found in CVS (the REF_STRUCT_DEV branch)
> and the new (normal extension) skeleton on
> http://doc.php.net/wiki/skeletons.

Class reference skeleton: http://doc.php.net/wiki/skeletons/oo

The reason for the xincludes there is to build a readable overview of
the methods and its properties.

Since the property usage in various extensions is very inconsistent
its impossibly to create one-skeleton-fits-all.
If the property has an equal function counterpart the property should
be documented above the function synopsis.

Class constants use the same markup as properties, with the exception
of added "<modifier>const</modifier>" in the fieldsynopsis

Basic "class usage examples" should use the "extension example
chapter" (xml:id=extname.examples).

Questions? Comments? Dislikes? Love? :)

-Hannes

Edward Z. Yang

2007-10-28, 7:05 pm

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hannes Magnusson wrote:
> The reason for the xincludes there is to build a readable overview of
> the methods and its properties.

Is there any way to abbreviate the XPointers?

> Questions? Comments? Dislikes? Love? :)

Do we have any extensions already using this format yet? I'm not really
sure I can comment until I see it in action, but the structure looks
quite intuitive and good.

- --
Edward Z. Yang GnuPG: 0x869C48DA
HTML Purifier <http://htmlpurifier.org> Anti-XSS Filter
[[ 3FA8 E9A9 7385 B691 A6FC B3CB A933 BE7D 869C 48DA ]]
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.7 (MingW32)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFHJL4ZqTO+fYacSNoRAiP/AJ0cG/wvHXBxF/zh27ceqKdHIq8EngCeP227
ByH2yA7oehafxQ8kZysDdoc=
=EWJs
-----END PGP SIGNATURE-----

Sponsored Links