Re: Questions about phpDocumenter standards.
| From: | Greg Beaver | Date: | Wed, 12 Jul 2006 23:55:55 +0000 |
| Subject: | Re: Questions about phpDocumenter standards. | ||
| References: | 1 2 3 | Groups: | php.pear.general |
| Request: | Send a blank email to pear-general+get-24638@lists.php.net to get a copy of this message | ||
Thomas Anderson wrote:
> On 7/12/06, Greg Beaver <cellog@php.net> wrote:
>
>>
>> <snip>
>>
>> In terms of linking to specific pages, if there is a way to pass this
>> information to the pdf through a url, then that will work. Otherwise,
>> you'll want to extract the necessary information. If it's tons of
>> pages, then perhaps re-formatting as html would work better.
>
>
>
> Should the re-formatted HTML (if I ended up doing that) be included in the
> package or should it be hosted remotely?
I would recommend you host it remotely. This will be far more
maintainable (I don't imagine you'd like to go through by hand and add
"*" at the start of every single line :).
> Based on your response, I assume I'd need to do something like...
>
> @see http://www.domain.tld/path/to
>
>>
>> /PAGE2 PAGE2chapter.subchapter.section
>>
>
> every time I referenced it? I don't mind doing that (or linking to
> re-formatted HTML) - I just want to make sure that's what I should do.
>
> Thanks for the response! :)
That is probably right. It's hard to give a definitive answer without
seeing an actual example of real code, but what you have looks to be right.
Greg