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

Item9670: System and Main need a good index

pencil
Priority: Normal
Current State: Confirmed
Released In: n/a
Target Release: minor
Applies To: Engine
Component: Documentation, FoswikiUsability
Branches:
Reported By: CrawfordCurrie
Waiting For:
Last Change By: GeorgeClark
There's no good index in the System and Main webs, and it's a struggle sometimes understanding how it all hangs together.

Example: imagine you are interested in how user registration works, and how you can modify it. You go to the System web and list all the topics that seem to relate:

BulkRegistration UserRegistration DefaultUserRegistration ManagingUsers UserFormHelp UsersTemplate NewUserTemplate UserForm TopicUserMappingContrib UserRegistration UserToolsCategory UserAuthentication UserSetting UserDocumentationCategory UsersGuide

Then you go to the Main web (not obvious in itself) and list all the topic there: AdminUser UnknownUser UserList WikiUsers UserHomepageHeader UserListByDateJoined PatternSkinUserViewTemplate UserListByLocation UserListHeader RegistrationAgent

Yes, I know all these topics are linked from somewhere in the doc, but if you start from the index, it's daunting.

What might help would be a standard section - it could be hidden - in all shipped topics. For example, DefaultUserRegistration could contain:
<!-- Synopsis: Re-usable components used by registration pages. Designed to be INCLUDEd. -->
This could then be presented in the index for these webs.

-- CrawfordCurrie - 14 Sep 2010

 

ItemTemplate edit

Summary System and Main need a good index
ReportedBy CrawfordCurrie
Codebase 1.1.0 beta1, 1.0.10, trunk
SVN Range
AppliesTo Engine
Component Documentation, FoswikiUsability
Priority Normal
CurrentState Confirmed
WaitingFor
Checkins
TargetRelease minor
ReleasedIn n/a
CheckinsOnBranches
trunkCheckins
masterCheckins
ItemBranchCheckins
Release01x01Checkins
Topic revision: r2 - 06 Jan 2015, GeorgeClark - This page was cached on 26 Jan 2021 - 13:36.

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