Re: Questions about phpDocumenter standards.

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? Also...

And what should I do for subsequent references to specific sections within that PDF? I'd like to do something like... see PAGEA 14.2.4, but that's apparently not in accord with PEAR Coding Standards. Maybe I should instead just do an @link for each of them and let the reader read through the 50+ pages to figure out what I'm talking about, each time? If I do that I might as well just link to www.google.com for everything I want to document and let the reader figure out the search string and do the search themselves. It'd make for really poor documentation I'm not sure what else I can do and still be in compliance with the PEAR Coding Standards.

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! :)