search

TiddlyWiki / TiddlyWiki5

A self-contained JavaScript wiki for the browser, Node.js, AWS Lambda etc.
https://tiddlywiki.com/
Other
7.97k stars 1.18k forks source link

Theme tweak - "Story right" should be "Sidebar left" #1620

Open twMat opened 9 years ago

twMat commented 9 years ago

Ctrlpanel > Appearence > Theme Tweaks

Story right "how far the left margin of the sidebar is from the left of the page"

As clear from the description of it, this is in fact not "Story right" but "Sidebar left"

Jermolene commented 9 years ago

Hi @twMat. The underlying tiddler title is $:/themes/tiddlywiki/vanilla/metrics/storywidth, and it is indeed only used for the left position of the sidebar.

The history is that the same value was originally also be used as the tiddler width, so the name was reasonable. We should have changed the tiddler title to $:/themes/tiddlywiki/vanilla/metrics/storywidth back in the beta; I think it's too late now. We could change the caption text, though, albeit it would no longer be consistent with the title of the underlying configuration tiddler.

twMat commented 9 years ago

I just wrote a post on a related issue on the boards.

We could change the caption text, though, albeit it would no longer be consistent with the title of the underlying configuration tiddler.

+1. Applying some kind of utilitaristic perspective, I believe it would reduce the total amount of confusion i.e including that it may add some confusion for someone discovering the actual inconsistency. Particularly, I think it would reduce confusion for the group most important to reduce it for.

danielo515 commented 9 years ago

Why is too late? Should we live with an inconsistent name forever? This kind of things happens, but should be changed or we will end with a spaghetti of weird names.

Jermolene commented 9 years ago

Why is too late?

Changing the title of the underlying configuration tiddler would break existing wikis that had customised those settings (unless we wrote the appropriate rules into the upgrader modules, which is a lot of trouble to go to in the circumstances).

danielo515 commented 9 years ago

Maybe we should invest some time improving the upgrader to handle this kind of collisions. This way breaking backwards compatibility would be less risky

tobibeer commented 8 years ago

Maybe we should invest some time improving the upgrader to handle this kind of collisions. This way breaking backwards compatibility would be less risky

:+1: never considered this before

Jermolene commented 8 years ago

One issue is that the upgrader isn't used for Node.js upgrades, so we'd need a new mechanism to handle those

twMat commented 8 years ago

Regarding the OP;

  1. Create new (correctly titled) tiddler: $:/themes/tiddlywiki/vanilla/metrics/sidebarleft
  2. redefine the existing .../storyright tiddler to transclude the value from this new tiddler
  3. update previous existances of .../storyright to use the new tiddler.
  4. ...and change the title in Ctrlpanel > Appearence > Theme Tweaks - Story right

Thus, the misleading .../storyright will get a passive role (which IMO is better than a prominent+misleading role) and any user made stuff referring to it will still work.

Eventually, when there's collision handling in the upgrader, such passive tiddlers could be outphased.

pmario commented 7 years ago

@Jermolene ... label "improvement"