Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate features for v3 #689

Open
bhajneet opened this issue Sep 4, 2024 · 1 comment
Open

Deprecate features for v3 #689

bhajneet opened this issue Sep 4, 2024 · 1 comment
Labels
✓ Type Task Technical work that is not directly related to a user requirement but still must be completed.
Milestone

Comments

@bhajneet
Copy link
Member

bhajneet commented Sep 4, 2024

Summary

WIP

Removals and Reasons

Settings > Display:

  • Previous Lines + Next Lines: This feature was added for a Gurdwara in the UK and they no longer use this feature. It wasn't meant to be a permanent feature and should be replaced with "View Modes" in next version (similar to how the website has Classic, Reader, Presenter modes).
  • Larivaar Assist: This feature is the same as turning off larivaar using spaces. The assist is not a form of larivaar at all, so it's not named correctly either. Ideally this is supposed to be something someone turns on and off very quickly for a single line to make sure they're reading it correctly, but that can be done with spaces as well or by other means. It does not make sense to keep it as a persistent toggle.
  • Syllabic Weights/Counts: This can be moved into the line inspector feature that should be developed in v3

Settings > Layout:

  • Center Align: This should follow the "View Modes" setting. If we add custom view modes for users this option will move there, but for now it can be taken out. Users that were not opted-in to this feature will have to be moved to Center Align
  • Justify Multiple Lines: This does not bring any meaningful layout changes, it will not even be implemented in custom "View Modes", unless some good justification can be given for it (pun semi-intended)
  • Inline Transliterations and Inline Transliteration Guides should probably be deprecated in favor of a new "View Mode", however still pending that concept.
  • Current Line Spacing: To be replaced with new style in Presenter "View Mode" akin to website. So can be removed from settings.

Settings > Theme:

  • Theme Name: most themes should be removed, replace with "Ori, Avani, Example"
  • Current Line and Other Line Backgrounds: This should be removed and set by the theme.

Settings > Vishraams:

  • Show Colors: Remove and enable by default

Settings > Sources:

  • This entire menu should be removed. Each source should be added to the "Display" menu somehow. This way users can show multiple English/Panjabi translations at the same time. It also makes it clearer to the user from the beginning what they're showing. The "Display" menu will have to be organized better

Changes

Settings > Theme:

  • Rename "Theme Name" to "Color Palette"
  • Remove Visual Effects should be renamed to something that actual explains what it's doing. I think it's more about Prefer Reduced Motion or Disable Animations.
  • Background Image: should be changed into a dropdown like Theme Name and it should have at least "Lotus, None, Example".

Settings > Vishraams:

  • Rename "Vishraams" to "Pauses"
  • Change 3 options for Light, Medium, Heavy to a single dropdown (All, "Only Primary")

Additions

Settings > Layout:

  • "Always show next line": Based on the length of current line the next line can be pushed off screen. This feature would make it so that overflow of the current line would be cut off and the next line will always be displayed (basically changing CSS of currently activated line from min-height that can grow to max-height / height with no overflow). This should be enabled by default.

Settings > Theme:

  • Rename category to "Appearance"
  • Add links to theme tool and docs (should be done well perhaps as
  • "Appearance": Should be a dropdown for "Light, Dark, Auto, Device". Auto should change based on the time of day (do we need to be specific with locations and check sunrise/sunset or can we simply use something like 7 AM - 7 PM as day?). Device should follow the operating system / systemwide / device theme mode.

Meta

  • Remove all "Reset to Defaults" except on Hotkeys page, rename to "Restore Defaults"

Questions

Settings > Security:

  • Do the settings in here actually work or do anything?

Settings > System Options:

  • Do all of these work? I don't think we have any analytics? Or Beta updates?

No response

@bhajneet bhajneet added the ✓ Type Task Technical work that is not directly related to a user requirement but still must be completed. label Sep 4, 2024
@bhajneet bhajneet added this to the V3 - Required milestone Sep 8, 2024
@Harjot1Singh
Copy link
Member

Harjot1Singh commented Nov 5, 2024

"Appearance": Should be a dropdown for "Light, Dark, Auto, Device"

Does this mean that themes now incorporate light and dark mode? I'm in favour, if so.

Settings > Security:

The only thing that private mode does is stop another client from editing your settings. This is not usually useful over LAN (high-trust), but may be over internet connections/Shabad OS connect/mobile connections. Probably a nicer way of doing this, though.

Settings > System Options:

Agree. Will remove beta updates. We will be adding anonymous analytics, but I think we may be ok with not having the option to toggle since we're not collecting personally identifiable information.

Remove Visual Effects should be renamed to something that actual explains what it's doing. I think it's more about Prefer Reduced Motion or Disable Animations.

Agree. Reduced motion is more accessibility friendly and we could eventually think about grouping accessibility options.

Justify Multiple Lines: This does not bring any meaningful layout changes, it will not even be implemented in custom "View Modes", unless some good justification can be given for it (pun semi-intended)

Agree.

Previous Lines + Next Lines: This feature was added for a Gurdwara in the UK and they no longer use this feature. It wasn't meant to be a permanent feature and should be replaced with "View Modes" in next version (similar to how the website has Classic, Reader, Presenter modes).

With this removal + center align, let's move/remove them at the same time as rolling out the new view modes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✓ Type Task Technical work that is not directly related to a user requirement but still must be completed.
Projects
None yet
Development

No branches or pull requests

2 participants