On 8/17/07, Stanislav Malyshev <[EMAIL PROTECTED]> wrote:
> > Neither. functions.xml is autogenerated by configure and referes to
> > the filepath.
>
> So, the function list in main extension page gets one entry per file in
> functions/? Where the names come from - is it refname? What if I have
> more than one refname - is it only first?
I'm not following (could be to tired, in which case I'll reply again
to morrow :P)
If you mean "each file in functions/ gets one entry in functions.xml"
you are right.
Its all done via magically created entities.
How this works:
reference.xml (the "index page" for all extensions):
<reference xml:id="....>
<title>extname..</title>
<partintro>
<section><title>Requirements..</title></section>..
<section....
</partintro>
&reference.extname.functions;
</reference>
The reference.extname.function is defined (by configure) in
entities/file-entities.xml (as are all other xml files) and acts like
PHPs require("./functions.xml").
functions.xml is autogenerated (by configure) and contains a list of
all the files in the functions/ folder and "includes them" into the
reference section.
So, if the files foo.xml and bar.xml are in functions/ the resulting
xml (after make .manual.xml) would be:
<reference xml:id="....>
<title>extname..</title>
<partintro>
<section><title>Requirements..</title></section>..
<section....
</partintro>
<refentry xml:id="foo">
.....
</refentry>
<refentry xml:id="bar">
...
</refentry>
</reference>
This magic include has nothing to do with IDs or refnames or any other
element/attribute. Its a total file based voodoo.
The bottom line: you don't have to think about how or where to
"include" the xml files. Its all done automatically.
For consistency, please name the files with their xml:id (stripping
"function." from the filename).
i.e. the strpos() function is located in functions/strpos.xml and
therfor has the ID "function.strpos"
Just to be sure, you are using the skeletons from
http://wiki.phpdoc.info/DocSkel?v=sx8, right?
> >> 2. There's two ways of making external links <ulink url> and <link
> >> xlink:href>. Is there a difference? Which one should be used?
> >
> > <ulink /> does not exist in DocBook5.
> > The correct method is <link xlink:href="&entity;"> (all external URLs
> > should be entities and added to phpdoc/entities/global.ent
>
> I guess someone has to fix the README in phpdoc then ;) It tells to use
> <ulink>.
Grr. I'll fix it. Thanks for the heads up
-Hannes
