On 8/23/07, M. Sokolewicz <[EMAIL PROTECTED]> wrote:
> Philip Olson wrote:
> >
> >> We have been kicking around the idea, on IRC, of making each extension
> >> "a book", i.e. having tutorial, faq, best practices and lot of other
> >> info for each and every extension. Its kinda unrealistic goal, but I
> >> think it is worth the consideration at least.
> >
> > It's well worth a consideration even knowing how much work such a move
> > would entail. Once we finalize our dream structure we will then compare
> > it to our current and then decide where to go (if anywhere) next. We'd
> > allow a lot more flexibility by designating each extension as a book,
> > but is it worth it (I think so) or do we need it? How painless of a
> > transition could we make it while keeping the translations in mind? Not
> > sure, yet.
> >
> > Regards,
> > Philip
>
> I must say, I really like that idea, however it might be best to view
> over any other alternatives we can come up with before commiting to this
> specific idea.

The only other alternative, I can find, is a custom reference element,
<phpdoc:classreference xmlns:phpdoc="http...">
<title>classname</title>
<partintro... />
&reference.classname....;
</phpdoc:classreference>

And that is actually what I had in mind for the new OOskel...

> Translations will always be a problem unfortunately, unless you manually
> correct them. All we'd be changing is the structure, not the content,
> but unfortunately each translation has its own copy of the structure
> along with its content. However, if we make sure to implement this new
> structure alongside the current structure we should be able to keep the
> translations as-is and working, and have the english version as the most
> up-to-date one, structure-wise too. It would then be up to the
> translators to update the structure of any file they're editing to
> reflect the english manual one imo.


I did a quick'n'dirty test with <set />s of <set />s of <book />s...
Turns out all we need to change is manual.xml.in and the
entities/builtin-extension.xml script to implement it.

Not kidding.

All "root files" (en/reference/<extname>/*.xml) will be childrens of
<book>. Meaning; they would have to be <reference />, <article />,
<appendix />, <chapter />... heh, that is *exactly* what we are
looking for, no?

No need to touch any translation or even en/ for that matter[1].

PhD even has out-of-the-box (with one minor typo) support for sets of
sets, and sets of books.

-Hannes

[1] With the exception of "class entry files" in en/reference/http/,
and couple of others, who should be changed to <reference>s anyway.

Reply via email to