You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by Daniel Naber <lu...@danielnaber.de> on 2007/04/06 23:00:11 UTC
linking the API docs
Hi,
we have a short but (I think) useful snippet of example code in our API
docs:
http://lucene.zones.apache.org:8080/hudson/job/Lucene-Nightly/javadoc/overview-summary.html#overview_description
We also have the "Getting started" section on the web site, which only
refers to the demo and doesn't offer code examples:
http://lucene.apache.org/java/docs/gettingstarted.html
I'd like to link from the "Getting Started" to the API example. Is it okay
to just put the above link (lucene.zones.apache.org) in the file or isn't
that supposed to be stable? If that's not okay, the best thing might be to
move the code example to the "Getting Started".
Regards
Daniel
--
http://www.danielnaber.de
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org
Re: linking the API docs
Posted by Grant Ingersoll <gs...@apache.org>.
Hi Daniel,
Can you file this as an issue and assign it to me? Nigel and I are
working through a few things w/ Hudson and the docs, still. The gist
of it is that the API and website will be put back on people.a.o.
This will mean that a relative link like api/overview-
summary.html#overview_description should be sufficient.
Thanks,
Grant
On Apr 7, 2007, at 4:01 PM, Daniel Naber wrote:
> On Saturday 07 April 2007 00:42, Chris Hostetter wrote:
>
>> : I think you can put in the link, just use relative link like in the
>> : site.xml.
>>
>> using a relative link is *key* ... it ensures not only that the
>> static
>> files build by the nightly build work, but also that the docs
>> distributed with each release contain good local pointers.
>
> I'm not familiar with forrest, could you help me setting the link?
>
> The pages to be linked are these:
> http://lucene.zones.apache.org:8080/hudson/job/Lucene-Nightly/
> javadoc/overview-summary.html#overview_description
> http://lucene.apache.org/java/2_1_0/api/overview-
> summary.html#overview_description
> (etc)
>
> Note that this is not the API docs page (which contains the
> frameset) but a
> content page plus an anchor. So I cannot use <a
> href="ext:javadocs"> but
> <a href="ext:javadocs/overview-summary.html#overview_description">
> doesn't
> work either.
>
> Regards
> Daniel
>
> --
> http://www.danielnaber.de
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: java-dev-help@lucene.apache.org
>
-
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org
Re: linking the API docs
Posted by Daniel Naber <lu...@danielnaber.de>.
On Saturday 07 April 2007 00:42, Chris Hostetter wrote:
> : I think you can put in the link, just use relative link like in the
> : site.xml.
>
> using a relative link is *key* ... it ensures not only that the static
> files build by the nightly build work, but also that the docs
> distributed with each release contain good local pointers.
I'm not familiar with forrest, could you help me setting the link?
The pages to be linked are these:
http://lucene.zones.apache.org:8080/hudson/job/Lucene-Nightly/javadoc/overview-summary.html#overview_description
http://lucene.apache.org/java/2_1_0/api/overview-summary.html#overview_description
(etc)
Note that this is not the API docs page (which contains the frameset) but a
content page plus an anchor. So I cannot use <a href="ext:javadocs"> but
<a href="ext:javadocs/overview-summary.html#overview_description"> doesn't
work either.
Regards
Daniel
--
http://www.danielnaber.de
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org
Re: linking the API docs
Posted by Chris Hostetter <ho...@fucit.org>.
:
: I think you can put in the link, just use relative link like in the
: site.xml.
using a relative link is *key* ... it ensures not only that the static
files build by the nightly build work, but also that the docs distributed
with each release contain good local pointers.
-Hoss
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org
Re: linking the API docs
Posted by Grant Ingersoll <gs...@apache.org>.
I think you can put in the link, just use relative link like in the
site.xml.
-Grant
On Apr 6, 2007, at 5:00 PM, Daniel Naber wrote:
> Hi,
>
> we have a short but (I think) useful snippet of example code in our
> API
> docs:
>
> http://lucene.zones.apache.org:8080/hudson/job/Lucene-Nightly/
> javadoc/overview-summary.html#overview_description
>
> We also have the "Getting started" section on the web site, which only
> refers to the demo and doesn't offer code examples:
>
> http://lucene.apache.org/java/docs/gettingstarted.html
>
> I'd like to link from the "Getting Started" to the API example. Is
> it okay
> to just put the above link (lucene.zones.apache.org) in the file or
> isn't
> that supposed to be stable? If that's not okay, the best thing
> might be to
> move the code example to the "Getting Started".
>
> Regards
> Daniel
>
> --
> http://www.danielnaber.de
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: java-dev-help@lucene.apache.org
>
--------------------------
Grant Ingersoll
Center for Natural Language Processing
http://www.cnlp.org
Read the Lucene Java FAQ at http://wiki.apache.org/jakarta-lucene/
LuceneFAQ
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org