Tags:
findability1Add my vote for this tag search1Add my vote for this tag usability1Add my vote for this tag create new tag
, view all tags

Feature Proposals » Make topic summary optionally based on search terms

Summary

Current State: Developer: Reason: Date: Concerns By: Bug Tracking: Proposed For:
AcceptedProposal SteveMokris AcceptedBy14DayRule 2010-06-14   Bugs:Item4211 KampalaRelease

Edit Form

TopicSummary:
CurrentState:
CommittedDeveloper:
ReasonForDecision:
DateOfCommitment:   Format: YYYY-MM-DD
ConcernRaisedBy:
BugTracking:
OutstandingIssues:
RelatedTopics:
InterestedParties:
ProposedFor:
TWikiContributors:
 
Or: how to better scan search results for relevancy.

Motivation

When doing a search if is often hard to decide if a found topic is relevant. Deciding would be easier if the topic summary showed the searched terms in context (sentence fragments). This is how Google presents search results.

Specification

  • Add a searchcontext parameter to $summary: $summary(searchcontext)

Implementation

When searchcontext is used:

  • raw summarized text is used (after calling Render::makeTopicSummary)
  • the topic text is scanned for the search terms
    • for each occurrence (following Google convention) 18 words around the text are used. If less than 9 word before the search term are available, the remainder amount of words after the term are used (so when after 6 words the search term is encountered, this will be displayed: 6 words before, term, 12 words after)
  • after each "line" triple dots are displayed
  • a maximum number of n characters will be used, so searching will stop when n characters are stored
  • the resulting text will be parsed for occurrences of the search terms: these will be bolded

-- Contributors: ArthurClemens

Discussion

Good point.

On syntax, the existing tokens can be combined, for example $summary(100, showvarnames, noheader). Expanding on that seems logical, such as $summary(searchcontext), $summary(100, searchcontext), etc.

-- PeterThoeny - 13 Mar 2007

Noone has disagreed here. The originator never reacted to Peters proposed spec.

Who will drive the implementation?

-- KennethLavrsen - 08 Apr 2007

$summary(searchcontext) seems logical to me. I am not sure if I can do it by myself.

-- ArthurClemens - 08 Apr 2007

I amended the spec accordingly. Seems like a go, but we need a driver.

-- PeterThoeny - 09 Apr 2007

Signing up for driver.

-- ArthurClemens - 23 Apr 2007

Excellent, thanks Arthur!

-- PeterThoeny - 24 Apr 2007

I've written the #Implementation text.

-- ArthurClemens - 02 May 2007

Sounds like a very good spec to me.

-- KennethLavrsen - 05 May 2007

Accepted by 14-day rule

-- KennethLavrsen - 07 May 2007

Great!

Question: Is it aware of the number of chars in the summary, e.g. $summary(200, searchcontext)?

-- PeterThoeny - 08 May 2007

I'm very keen to use this. Is it available yet? What do I need to do?

-- TamsinTweddell - 01 Jun 2007

There's been no work on it yet, AFAIK. However a client of mine has come up with a similar request, so I may do some work on it.

-- CrawfordCurrie - 02 Jun 2007

Did not make it before feature freeze. So this should not be checked in before after 4.2.0 is released.

-- KennethLavrsen - 03 Jun 2007

Supported with a monkey patch in SearchSummaryPlugin. Code should be reusable for the core when 4.2 is out.

CC

Thanks Crawford. When we take this into the core I think it is better to add a $summary(searchcontext) switch instead of a SEARCHSUMMARYPLUGIN_CONTEXT preferences variable. The summary already groks $summary(50, showvarnames, noheader).

-- PeterThoeny - 06 Jun 2007

Good point, Peter. I was obviously focused on my clients requirements, so didn't need to support this.

-- CrawfordCurrie - 08 Jun 2007

Useful feature. Anyone taking it?

-- PeterThoeny - 2010-08-01

Edit | Attach | Watch | Print version | History: r27 < r26 < r25 < r24 < r23 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r27 - 2013-10-11 - PeterThoeny
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.