lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Cassandra Targett <casstarg...@gmail.com>
Subject Re: Solr Ref Guide, Highlighting
Date Wed, 11 Jan 2017 20:53:23 GMT
Yes, I can help - I meant to try today, but tomorrow looks much
clearer schedule-wise to focus on Ref Guide.

On Wed, Jan 11, 2017 at 12:32 AM, David Smiley <david.w.smiley@gmail.com> wrote:
> I made some progress... I'm having flashbacks to book-writing; ugh. If you
> wish to help Cassandra, I think a great spot would be the "Basic Usage"
> section I inserted.  I'll save that for last if nobody gets to it.  I need
> to do the end of the page, and then add a UH page and deal with the other
> highlighter pages.
>
> On Tue, Jan 10, 2017 at 12:20 PM David Smiley <david.w.smiley@gmail.com>
> wrote:
>>
>> Thanks for your input Cassandra.
>> Within the code, DefaultSolrHighlighter.java can be renamed; it's not set
>> in stone unlike code in SolrJ where there needs to be much more care.  Not
>> sure what it would be named though... any way it's another issue perhaps for
>> 7.0.
>> I'll work on the ref guide tonight.
>> ~ David
>>
>> On Tue, Jan 10, 2017 at 11:57 AM Cassandra Targett <casstargett@gmail.com>
>> wrote:
>>>
>>> (note: I replied to this thread earlier not noticing that dev@l.a.o
>>> was removed from the message I replied to...reposting the relevant
>>> part here for posterity or whatever...)
>>>
>>> [Regarding] reworking the Highlighting section, I'm +1 on the changes you
>>> propose, David. It's a bit of a mess, and not very consistent in the
>>> ways configuration options are described for each of the
>>> implementations.
>>>
>>> I generally prefer to name things along the lines they are named in
>>> the code, but in this case there's already a disconnect between
>>> "Standard Highlighter" and the DefaultSolrHighlighter. I wonder,
>>> though, if it would be a good idea to rename the
>>> DefaultSolrHighlighter? Perhaps it's too early to make such a change,
>>> but it's worth a moment's thought if you haven't already.
>>>
>>> Thanks for taking this on - I was briefly looking at UH yesterday and
>>> considering how to integrate it with the current docs. I didn't get
>>> very far, and found it a bit daunting, so I appreciate your assistance
>>> for sure. Please let me know if you need any help or review from me.
>>>
>>> On Mon, Jan 9, 2017 at 11:17 PM, David Smiley <david.w.smiley@gmail.com>
>>> wrote:
>>> > Unfortunately, The Solr Ref Guide is only editable by committers.  In
>>> > the
>>> > near future it's going to move to a different platform that will allow
>>> > you
>>> > to contribute via pull-request; that will be very nice.  In the mean
>>> > time,
>>> > your feedback is highly appreciated.
>>> >
>>> > ~ David
>>> >
>>> > On Mon, Jan 9, 2017 at 6:21 PM Timothy Rodriguez (BLOOMBERG/ 120 PARK)
>>> > <trodriguez25@bloomberg.net> wrote:
>>> >>
>>> >> +1, I'll be happy to offer assistance with edits or some of the
>>> >> sections
>>> >> if needed. We're glad to see this out there.
>>> >>
>>> >> From: dev@lucene.apache.org At: 01/09/17 18:03:32
>>> >> To: Timothy Rodriguez (BLOOMBERG/ 120 PARK), dev@lucene.apache.org
>>> >> Subject: Re:Solr Ref Guide, Highlighting
>>> >>
>>> >> Solr 6.4 is the first release to introduce the UnifiedHighlighter as
a
>>> >> new
>>> >> highlighter option.  I want to get it documented reasonably well in
>>> >> the Solr
>>> >> Ref Guide.  The Highlighters section is here: Highlighting   (lets see
>>> >> if
>>> >> this formatted email expands to the URL when it lands on the list)
>>> >>
>>> >> Unless anyone objects, I'd like to rename the "Standard Highlighter"
>>> >> as
>>> >> "Original Highlighter" in the ref guide.  The original Highlighter has
>>> >> no
>>> >> actual name qualifications as it was indeed Lucene's original
>>> >> Highlighter.
>>> >> "Standard Highlighter" as a name purely exists as-such within the Solr
>>> >> Reference Guide only.  In our code it's used by
>>> >> "DefaultSolrHighlighter"
>>> >> which is really a combo of the original Highlighter and
>>> >> FastVectorHighlighter.   DSH ought to be refactored perhaps... but I
>>> >> digress.
>>> >>
>>> >> For those that haven't read CHANGES.txt yet, there is a new
>>> >> "hl.method"
>>> >> parameter which can be used to pick your highlighter.  Here I
>>> >> purposely
>>> >> chose a possible value of "original" to choose the original
>>> >> Highlighter (not
>>> >> "standard").
>>> >>
>>> >> I haven't started documenting yet but I plan to refactor the
>>> >> highlighter
>>> >> docs a bit.  The intro page will better discuss the highlighter
>>> >> options and
>>> >> also how to configure both term vectors and offsets in postings.  Then
>>> >> the
>>> >> highlighter implementation specific pages will document the parameters
>>> >> and
>>> >> any configuration specific to them.  I'm a bit skeptical we need a
>>> >> page
>>> >> dedicated to the PostingsHighlighter as the UnifiedHighlighter is a
>>> >> derivative of it, supporting all it's options and more.  In that
>>> >> sense,
>>> >> maybe people are fine with it only being in the ref guide as a
>>> >> paragraph or
>>> >> two on the UH page describing how to activate it.  I suppose it's
>>> >> effectively deprecated.
>>> >>
>>> >> ~ David
>>> >> --
>>> >> Lucene/Solr Search Committer, Consultant, Developer, Author, Speaker
>>> >> LinkedIn: http://linkedin.com/in/davidwsmiley | Book:
>>> >> http://www.solrenterprisesearchserver.com
>>> >>
>>> >>
>>> > --
>>> > Lucene/Solr Search Committer, Consultant, Developer, Author, Speaker
>>> > LinkedIn: http://linkedin.com/in/davidwsmiley | Book:
>>> > http://www.solrenterprisesearchserver.com
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
>>> For additional commands, e-mail: dev-help@lucene.apache.org
>>>
>> --
>> Lucene/Solr Search Committer, Consultant, Developer, Author, Speaker
>> LinkedIn: http://linkedin.com/in/davidwsmiley | Book:
>> http://www.solrenterprisesearchserver.com
>
> --
> Lucene/Solr Search Committer, Consultant, Developer, Author, Speaker
> LinkedIn: http://linkedin.com/in/davidwsmiley | Book:
> http://www.solrenterprisesearchserver.com

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


Mime
View raw message