Add menu to Scribe app

[andrewtavis]

Terms

• I have searched open and closed feature requests
• I agree to follow Scribe-iOS' Code of Conduct

Description

This issue is for discussing and implementing a menu with settings to choose which Scribe functionality is available or order how commands are displayed when the Scribe key is pressed. There could be the potential that a user would not need one of the Scribe command buttons, or when more commands are available they'd want to order the commands so that some are easier to access than others (with more commands there likely will be some kind of meatball menu where the extra ones are located, so the user could choose their main ones). Also system functionality like the double space period shortcut could be removed.

Edit: note that this issue now encompasses only the multiple screens for the Scribe app, with separate sections then being added in other issues :) This branch contains an example of how the app screens should be reworked 😊

[andrewtavis]

This would be best achieved by a hamburger menu at the top right of the app screen.

[andrewtavis]

This issue will be done with a settings view that has the following options:

• Home: return to the install instructions
• Settings: a few basic settings like removing the double space period shortcut
• Privacy Policy: view the privacy policy
• Contact Scribe: contact information that asks for feedback
• Wikidata and Scribe: a description of how Wikidata is used with a call to action to support free and open data

[andrewtavis]

A back button should be added to each page that's not the home screen, with a swipe right also potentially being used as a way to get back to the original screen.

[andrewtavis]

The following would be the potential icons that would be used for the menu (mostly SF Symbols):

• house (home)
• arrow.2.circlepath, plus.bubble, memories (language practice)
• gear (settings)
• lock.shield (privacy policy)
• envelope (contact)
• Wikimedia/Wikidata logo (Wikidata)
• arrow.left (back button)
• line.horizontal.3 (humburger)

[wkyoshida]

Also now included is how the privacy policy and other About screens could look.

Oh also, very minor comment - just felt that the font for the About pages seemed a tad small. Other than that though, I think the format for how they look seems good 😁👍

[andrewtavis]

I am also wondering now though, if it could be good perhaps to also provide a main override for settings. So Settings could have the option to go adjust settings per-keyboard, but also have the same settings be available to just apply generally. Adjusting the main Settings affects all keyboards.

I agree on this :) Let me give another thought to this and we can edit it a bit. Initial impressions are that some form of your first option would be better, as having the per keyboard settings that deep in the menu as in the second version would likely hide this functionality from many. For now I've added an option for All keyboards, but that's just a placeholder for now until we figure out a better way to integrate it all :) I'll talk to the original designer about all of this as well 😊 Also made the font bigger, good point!

[andrewtavis]

I was able to talk with the designer for all this over the weekend. His general feedback was do exactly what we’re planning and that he’ll let me do the Figma from now on 😅 He hadn’t seen my Figma work for a bit and I’d been practicing 😇😊

Specifically his comment was we have what we need to test all this and see how it actually works in a user’s hands, and from there we iterate 🚀

Minor comments have already been implemented: that we need more spacing between the TabBar words and icons, and that we should have a call to action on Settings when the user has yet to install a keyboard. We now have an Install keyboard button that will go away once we detect they’re installed something. Clicking that would take them back to Install, which isn’t much, but we were thinking that a minor nudge back to the install directions would be enough along with some hints.

[wkyoshida]

Clicking that would take them back to Install, which isn’t much, but we were thinking that a minor nudge back to the install directions would be enough along with some hints.

What about directly opening and taking them to the iPhone keyboard settings? Could that make sense potentially?

[andrewtavis]

What about directly opening and taking them to the iPhone keyboard settings? Could that make sense potentially?

Very much so, @wkyoshida, but sadly for some reason this is not an option in iOS as of now. What used to be possible was encoding paths via strings for what you wanted to open in the menu, but I guess this was breaking with multiple system languages... 🤷‍♂️ I've checked on Stack Overflow a lot for this (just did again), and as of now it doesn't seem to be possible. Lots of people saying that their app got denied by App Store Connect or that it passed and then got rejected later.

As of now that button calls UIApplication.shared.open(URL(string: UIApplication.openSettingsURLString)!). Hopefully at some point they'll add some functionality to get it to keyboard settings directly, in which case we can also remove the directions on the first page and take them right there. This is what we do in Scribe-Android, as this functionality is available there.

[wkyoshida]

Very much so, @wkyoshida, but sadly for some reason this is not an option in iOS as of now.

Oh I see - well, that's a bummer.. Yeah, hopefully it becomes possible to do so, as it would be an easy user workflow, I think.

[andrewtavis]

Closed via #324 🥳 Thank you, @SaurabhJamadagni! Crazy to have this finished 😊