• Do not register here on develop.twiki.org, login with your twiki.org account.
• Use View topic Item7848 for generic doc work for TWiki-6.1.1. Use View topic Item7851 for doc work on extensions that are not part of a release. More... Close
• Anything you create or change in standard webs (Main, TWiki, Sandbox etc) will be automatically reverted on every SVN update.
Does this site look broken?. Use the LitterTray web for test cases.

Item3647: Usability: Control over variable expansion in topic templates

Item Form Data

AppliesTo: Component: Priority: CurrentState: WaitingFor: TargetRelease ReleasedIn
Engine   Enhancement Closed TWiki:Main/PeterThoeny minor 4.3.0

Edit Form Data

Summary:
Reported By:
Codebase:
Applies To:
Component:
Priority:
Current State:
Waiting For:
Target Release:
Released In:
 

Detail

The "My links" section of new user homepages has this:
   * %TWIKIWEB%.ATasteOfTWiki - view a short introductory presentation on TWiki for beginners
   * %TWIKIWEB%.WelcomeGuest - starting points on TWiki
   * %TWIKIWEB%.TWikiUsersGuide - complete TWiki documentation, Quick Start to Reference
   * Sandbox.%HOMETOPIC% - try out TWiki on your own
   * Sandbox.%TOPIC%Sandbox - just for me

Although accurate and correct to use TWiki variables, it can be initimidating to new users. For education purposes it is better to expand the variables (just in the "My links" section) to show:

   * TWiki.ATasteOfTWiki - view a short introductory presentation on TWiki for beginners
   * TWiki.WelcomeGuest - starting points on TWiki
   * TWiki.TWikiUsersGuide - complete TWiki documentation, Quick Start to Reference
   * Sandbox.WebHome - try out TWiki on your own
   * Sandbox.JimmyNewtronSandbox - just for me

Yes, expanded %TWIKIWEB% name and expanded %HOMETOPIC% do not work if at a later point the admin decides to name them TWikiDocs and StartingPoint, respectively. The chance is pretty low that this is done after the initial TWiki deployment. At deployment it may happen though, so the template should list the variables, but once instanciated they should get expanded.

Idea: Create a %EXPANDVARS{}% variable that can be put into template topics. Example:

   * %EXPANDVARS{%TWIKIWEB%}%.ATasteOfTWiki - view a short introductory presentation on TWiki for beginners
   * %EXPANDVARS{%TWIKIWEB%}%.WelcomeGuest - starting points on TWiki
   * %EXPANDVARS{%TWIKIWEB%}%.TWikiUsersGuide - complete TWiki documentation, Quick Start to Reference
   * Sandbox.%EXPANDVARS{%HOMETOPIC%}% - try out TWiki on your own
   * Sandbox.%EXPANDVARS{%TOPIC%Sandbox}% - just for me

-- TWiki:Main/PeterThoeny - 15 Feb 2007

New core feature. Should be a Codev topic added to TWiki:Codev.TWikiFeature04x02 per our process. Great idea by the way.

-- TWiki:Main.KennethLavrsen - 15 Feb 2007

I created TWiki:Codev.ControlOverVariableExpansion

-- TWiki:Main.PeterThoeny - 16 Feb 2007

Marking as Enhancement.

CC

This is work in progress. Code changes should be done. Doc changes and homepage change pending.

I would appreciate if someone could help out with the unit tests.

-- PeterThoeny - 28 May 2007

Please consider Item1855 when you do this. Thanks.

-- TWiki:Main.CrawfordCurrie - 22 Jun 2007

Closing this bug after TWiki 4.3.0 release

-- TWiki:Main.SopanShewale - 06 Apr 2009

ItemTemplate
Summary Usability: Control over variable expansion in topic templates
ReportedBy TWiki:Main.PeterThoeny
Codebase ~twiki4
SVN Range TWiki-4.1.1, Wed, 14 Feb 2007, build 12874
AppliesTo Engine
Component

Priority Enhancement
CurrentState Closed
WaitingFor TWiki:Main/PeterThoeny
Checkins TWikirev:13954 TWikirev:17799 TWikirev:17800 TWikirev:17803 TWikirev:17804
TargetRelease minor
ReleasedIn 4.3.0
Edit | Attach | Watch | Print version | History: r18 < r17 < r16 < r15 < r14 | Backlinks | Raw View |  Raw edit | More topic actions
Topic revision: r18 - 2009-04-06 - SopanShewale
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback