Re: JDBC4 documentation, was: [jira] Commented: (DERBY-1079) Build javadoc under jdk 1.6

[Andrew McIntyre <mc...@gmail.com>]

On 5/9/06, Rick Hillegas <Ri...@sun.com> wrote:
> Hi Andrew,
>
> I don't think I understand your proposal. Do you want 10.2 to contain
> two bundles of documentation with a high level html page that switches
> between the two:
>
> 1) A bundle of user guides and javadoc for JDBC3 and
>
> 2) A separate bundle of user guides and javadoc for JDBC4?

No, just:

demo
docs
  html
  pdf
frameworks
javadoc
  publishedapi3.0
  publishedapi4.0
lib
index.html

and index.html has the links into the 3.0 and 4.0 javadocs, as well as
pointers to the various manuals, the same ones we have today. And, now
that I'm thinking of it, also into the demo html files as well. So, a
master index.html for the distribution.

andrew

Re: JDBC4 documentation, was: [jira] Commented: (DERBY-1079) Build javadoc under jdk 1.6

[Andrew McIntyre <mc...@gmail.com>]

On 5/9/06, Rick Hillegas <Ri...@sun.com> wrote:
>
> It turns out the if="jdk16" clause is on the target itself. I have
> verified that if I remove the jdk16 flag from ant.properties, then we
> continue to build the same javadoc we did six months ago.

Great, thanks.

> By top level, do you mean in the same directory that holds BUILDING.txt
> and published_api_overview.html?

Yes, please.

thanks,
andrew

Re: JDBC4 documentation, was: [jira] Commented: (DERBY-1079) Build javadoc under jdk 1.6

[Rick Hillegas <Ri...@Sun.COM>]

Thanks, Andrew,

A couple more small points:

Andrew McIntyre wrote:

> On 5/9/06, Rick Hillegas <Ri...@sun.com> wrote:
>
>>
>> Is the following then a fair summary of your patch comment:
>>
>> o I will remove my index.html from the patch
>> o At your leisure, you can create a more capable, top level index.html
>> and wrestle with the release machinery to get it into our release
>> distributions
>
>
> Yes. (don't forget to add that if="jdk16")

It turns out the if="jdk16" clause is on the target itself. I have 
verified that if I remove the jdk16 flag from ant.properties, then we 
continue to build the same javadoc we did six months ago.

>
>> Hope I'm not talking at cross-purposes still.
>
>
> Nope. Could you check your file in as index.html at the top level
> though? I like what you had written for the javadoc. I'll add sections
> for the docs and demos.

By top level, do you mean in the same directory that holds BUILDING.txt 
and published_api_overview.html?

Thanks,
-Rick

Re: JDBC4 documentation, was: [jira] Commented: (DERBY-1079) Build javadoc under jdk 1.6

[Andrew McIntyre <mc...@gmail.com>]

On 5/9/06, Rick Hillegas <Ri...@sun.com> wrote:
>
> Is the following then a fair summary of your patch comment:
>
> o I will remove my index.html from the patch
> o At your leisure, you can create a more capable, top level index.html
> and wrestle with the release machinery to get it into our release
> distributions

Yes. (don't forget to add that if="jdk16")

> Hope I'm not talking at cross-purposes still.

Nope. Could you check your file in as index.html at the top level
though? I like what you had written for the javadoc. I'll add sections
for the docs and demos.

andrew

Re: JDBC4 documentation, was: [jira] Commented: (DERBY-1079) Build javadoc under jdk 1.6

[Rick Hillegas <Ri...@Sun.COM>]

Thanks, Andrew. I think I'm beginning to track what you're proposing. 
Your directory structure is very similar to what's in my patch for 1079, 
except for the following:

o the subdirectory names are a little different under the javadoc directory
o I put the index.html in the javadoc directory rather than at the top
o your proposed index.html is more capable than what I wrote

Here's what's in the patch:

...
javadoc
  jdbc3
  jdbc4
  index.html
...

Is the following then a fair summary of your patch comment:

o I will remove my index.html from the patch
o At your leisure, you can create a more capable, top level index.html 
and wrestle with the release machinery to get it into our release 
distributions

Hope I'm not talking at cross-purposes still.

Thanks,
-Rick




Andrew McIntyre wrote:

> On 5/9/06, Rick Hillegas <Ri...@sun.com> wrote:
>
>> Hi Andrew,
>>
>> I don't think I understand your proposal. Do you want 10.2 to contain
>> two bundles of documentation with a high level html page that switches
>> between the two:
>>
>> 1) A bundle of user guides and javadoc for JDBC3 and
>>
>> 2) A separate bundle of user guides and javadoc for JDBC4?
>
>
> No, just:
>
> demo
> docs
>  html
>  pdf
> frameworks
> javadoc
>  publishedapi3.0
>  publishedapi4.0
> lib
> index.html
>
> and index.html has the links into the 3.0 and 4.0 javadocs, as well as
> pointers to the various manuals, the same ones we have today. And, now
> that I'm thinking of it, also into the demo html files as well. So, a
> master index.html for the distribution.
>
> andrew