Item8660: Rewrite SearchHelp

Priority: Normal
Current State: Closed
Released In: 1.1.0
Target Release: minor
Applies To: Engine
Component: Documentation
Reported By: ArthurClemens
Waiting For:
Last Change By: KennethLavrsen
SearchHelp has fallen in the same Foswiki/TWiki trap: it explains what's there without focusing on user needs.

For example, who cares that you can AND searches with plusses as well? (unless you want to search for a stop word...)

We can skip a lot of information. Query and formatted search and regex search are not useful as search help and can just be links. The search preferences neither, except for the list of stopwords.

We should ask first: what kind of search do you want to perform? (not to be taken literally)

So we can cover:
  • Searching topics
  • Troubleshooting (can't find xxx -- may be a stop word)

One example is Google's search help and the More search help.

-- ArthurClemens - 03 Mar 2010

As the only part in the new search interface that is not yet internationalized, rewriting becomes urgen.t

-- ArthurClemens - 08 Sep 2010

No way a search help text is a release blocker. We can always improve documentation and make more MAKETEXT strings but it is not blocking a minor release

-- KennethLavrsen - 11 Sep 2010

The text will be in English then. After feedback this text can be internationalized for trunk, but that may be a separate task.

-- ArthurClemens - 14 Sep 2010

ItemTemplate edit

Summary Rewrite SearchHelp
ReportedBy ArthurClemens
Codebase 1.1.0 beta1, trunk
SVN Range
AppliesTo Engine
Component Documentation
Priority Normal
CurrentState Closed
Checkins distro:0627bd5d25db
TargetRelease minor
ReleasedIn 1.1.0
Topic revision: r10 - 04 Oct 2010, KennethLavrsen - This page was cached on 16 Jan 2020 - 15:11.

The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. See Copyright Statement. Creative Commons License    Legal Imprint    Privacy Policy