• 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.

Item7202: PreferencesPlugin to support variants of preference setting format

Item Form Data

AppliesTo: Component: Priority: CurrentState: WaitingFor: TargetRelease ReleasedIn
Extension PreferencesPlugin Enhancement Closed   major 6.0.0

Edit Form Data

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

Detail

Currently, PreferencesPlugin detects the "Set" format below to convert it to the HTML <form> field:
  • Set VAR = VALUE

It is more desirable to support some other variants of the format:

  • Local VAR = VALUE
  • #Set VAR = VALUE
  • #Local VAR = VALUE

-- TWiki:Main/MahiroAndo - 2013-03-25

I just tried it out, it works as designed.

I recommend adding a preferences setting to enable this feature. Reason: 95+% of times only the "Set" is used. New users might be confused with the new option to select Set, #Set, Local and #Local for each setting. It might be better to leave this option for power users, e.g. ship the plugin with disabled setting (to get the old behavior), and let document in plugin how to enable this (for power users). What do you think?

-- TWiki:Main.PeterThoeny - 2013-04-01

Or, maybe no setting to enable/disable, but change the spec to this:

It is unlikely that a setting is changed from Set to Local once defined. To avoid confusion, how about just offering "Set" and "#Set" for the normal setting, and "Local" and "#Local" for the local setting? To make it clear what the "#" means, how about using this in edit mode?

  • For "Set" values:
    • Set FOO =
  • For "Local" values:
    • Local BAR =

-- TWiki:Main.PeterThoeny - 2013-04-01

Hi Peter - I like the idea of the new UI spec, which makes more sense for most users. I'm working on updating it.

-- TWiki:Main.MahiroAndo - 2013-04-03

Or, even more intuitive, possibly this:

  • For "Set" values:
    • Set FOO =
  • For "Local" values:
    • Local BAR =

-- TWiki:Main.PeterThoeny - 2013-04-03

That would be even better. I will use the checkboxes.

-- TWiki:Main.MahiroAndo - 2013-04-04

Thanks for adding the checkboxes.

I did some style sheet tweaks:

  • show/hide "#" depending on checkbox state (more intuitive than strikeout)
  • use twikiAlert class only for "Set NAME = ", not for setting input fields

-- TWiki:Main.PeterThoeny - 2013-04-05

Thank you! The hash signs look more intuitive and consistent.

I made a couple of small changes in your tweaks:

  • make "#" transparent rather than white, so it looks better when the page's bg color is not white
  • showing/hiding "#" looked the other way around, so I updated it to show "#" when the checkbox is disabled.

-- TWiki:Main.MahiroAndo - 2013-04-08

Thanks for fixing this. Haha, dummy me for mixing up enable/disable!

-- TWiki:Main.PeterThoeny - 2013-04-08

Edit | Attach | Watch | Print version | History: r31 < r30 < r29 < r28 < r27 | Backlinks | Raw View |  Raw edit | More topic actions
Topic revision: r31 - 2013-10-15 - PeterThoeny
 
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