[ 
http://issues.apache.org/jira/browse/LUCENE-664?page=comments#action_12440648 ] 
            
Doron Cohen commented on LUCENE-664:
------------------------------------

I played with including the formula from a separate file, Client Side Include. 

=== Summary === 
 I think the "include" is not going to work well enough and hence not worth to 
invest in it.
So, bottom line, I give up for now on "include", and so I will make the changes 
in Similarity.java.

=== Details  === 
I know of 3 ways to do this: Javascript, Iframe, Object-Embed. 

Iframe can work for both the javadocs and the xdocs - I think that Embed also 
would work though I did not try it.

Both Iframe and Embed have a problem of appearance: you have to decide on the 
size of the frame showm, in pixels. If you set too large an area, blank space 
will remain. If you set a too small area, scroll bars would show up. If the 
user changes the text side, the required area size is changing, but not the 
allocated area, so scrollbars or blank space are showing up and disapearing. 
Very ugly. 

Iframe also has an issue with inner links navigation: once you navigate to an 
anchor text in the iframe part (this works), the back action from some reason 
does not work (both Firefox and IE).

The javascript approach should not have these issues, because the imported text 
becomes part of the embedding page (the imported text is "dynamically 
generated"). I saw that Javadocs themselves use javascript (at least in 1.5) so 
I feel better with using this. However to use Javascript you have to put some 
javascript code in the HTML Header, as well as an onload event in the BODY tag. 
I didn't find a way to do this with Javadocs. 

(Another tricky issue with Javascript is that outgoing links from the imported 
text have the base address of the embedding page. So references going out from 
the embedded text should be different in Similarity.html and Scoring.html 
(which are in separate directories). But I think this can be resolved with 
passing a 'base' param to the include() function.)

Bottom line, I give up for now on "include", and so I will make the changes in 
Similarity.java.

> [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: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to