Mailing-List: contact java-dev-help@lucene.apache.org; run by ezmlm
Precedence: bulk
Reply-To: java-dev@lucene.apache.org
Date: Fri, 6 Oct 2006 11:20:24 -0700 (PDT)
From: Chris Hostetter <hossman_lucene@fucit.org>
To: java-dev@lucene.apache.org
Subject: Re: [jira] Commented: (LUCENE-664) [PATCH] small fixes to the new
 scoring.html doc
In-Reply-To: <29453436.1160140226712.JavaMail.root@brutus>
Message-ID: <Pine.LNX.4.58.0610061113001.21069@hal.rescomp.berkeley.edu>
References: <29453436.1160140226712.JavaMail.root@brutus>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; charset=US-ASCII


: I also think I want to drop the formula (and explanation) in
: scoring.html and just put a link to similarity in, so that we don't have
: to maintain two copies.  Ideally, there would be a way to do a server
: side include so that we could have one file that contains the formula
: and then have it included in both the javadocs and this page.  Does
: anyone know if this possible using our current setup?

Even if it is possible to uses SSIs on lucene.apache.org, it would make
the documentation hard to read when included in the published releases.

Extracting the formula into it's own micro HTML file is agood iea
though ... it could be commited into a "doc-files" directory into the
source tree so thatit's included along with the javadocs, (so it can be
linked to from the SImilarity javadocs) and like any other javadoc file it
could be linked to from the scoring.html file.

We could concievably even use an IFRAME of Javascript DOM manipulation
tricks to slurp it into the scoring.html


http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#unprocessed


:
: > [PATCH] small fixes to the new scoring.html doc
: > -----------------------------------------------
: >
: >                 Key: LUCENE-664
: >                 URL: http://issues.apache.org/jira/browse/LUCENE-664
: >             Project: Lucene - Java
: >          Issue Type: Improvement
: >          Components: Website
: >    Affects Versions: 2.0.1
: >            Reporter: Michael McCandless
: >         Attachments: boosts_plus_scoring_formula.patch, lucene.uxf, scoring-small-fixes.patch, scoring-small-fixes2.patch, scoring-small-fixes3.patch
: >
: >
: > This is an awesome initiative.  We need more docs that cleanly explain the inner workings of Lucene in general... thanks Grant & Steve & others!
: > I have a few small initial proposed fixes, largely just adding some more description around the components of the formula.  But also a couple typos, another link out to Wikipedia, a missing closing ), etc.  I've only made it through the "Understanding the Scoring Formula" section so far.
:
: --
: This message is automatically generated by JIRA.
: -
: If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
: -
: For more information on JIRA, see: http://www.atlassian.com/software/jira
:
:
:
: ---------------------------------------------------------------------
: To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
: For additional commands, e-mail: java-dev-help@lucene.apache.org
:


-Hoss


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org