You are here: Foswiki>Tasks Web>Item2593 (07 Jan 2015, GeorgeClark)Edit Attach

Item2593: Documentation category listings are ugly, show naked macros

pencil
Priority: Enhancement
Current State: No Action Required
Released In: 1.0.9
Target Release: patch
Applies To: Engine
Component: Documentation
Branches:
Reported By: PaulHarvey
Waiting For:
Last Change By: GeorgeClark
If the beginning of a topic contains only macro code, the summary text in a search result will show those naked macros.

Propose that as a part of the flattening process we strip out macros.

An obvious deficiency in this behaviour is in the System.AdminToolsCategory shown in the screenshot attached.

  • Shows macro code in the summary text:
    silly-search-summaries.png

See also: Development.OptionToAvoidFlattenedSummaryInFormattedSearch

-- PaulHarvey - 06 Jan 2010

I am not sure the end result of the search summaries will be more intelligent by cutting out the naked macros. Maybe in some contexts it will be the other way around. What we do know is that it is absolutely not a good idea to try and expand these macros.

In System web context these summaries are doing more damage than good. We should really spend the time and give all those topics a one liner human intelligent description and show this instead. Either in a form or by hidden setting where we let the search list the meta content for this setting. The latter is my preferred as adding a form to all System web topics seems a bit of an overkill.

I am changing this to Enhancement because I do not see the current way a bug and the suggested alternative I am not sure is better.

-- KennethLavrsen - 06 Jan 2010

Changed the focus of this bug to address the specific usage of search summaries in the documentation categories as shipped in Foswiki.

-- PaulHarvey - 23 Jan 2010

No Action. These topics have been changed to crafted indexes and don't use search.

-- GeorgeClark - 07 Jan 2015

ItemTemplate edit

Summary Documentation category listings are ugly, show naked macros
ReportedBy PaulHarvey
Codebase 1.0.8, trunk
SVN Range
AppliesTo Engine
Component Documentation
Priority Enhancement
CurrentState No Action Required
WaitingFor
Checkins
TargetRelease patch
ReleasedIn 1.0.9
CheckinsOnBranches
trunkCheckins
masterCheckins
ItemBranchCheckins
Release01x01Checkins
I Attachment Action Size Date Who Comment
silly-search-summaries.pngpng silly-search-summaries.png manage 57 K 06 Jan 2010 - 03:31 PaulHarvey Shows macro code in the summary text
Topic revision: r4 - 07 Jan 2015, GeorgeClark
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