In app help/tip/hint system #1071

agrogers · 2021-05-16T00:43:43Z

I mentioned elsewhere that there are so many features in And Bible now that it is getting harder to know they are there and perhaps understand how they operate.

Maybe it's time to implement a tip or hint system (there isn't one is there?) that can fill in these gaps. A few thoughts

show a single tip when the app is opened and don't make it too easy for the user to stop seeing tips.
the first tip explains where in the settings they can turn this off
tips are shown during use when the user clicks on some button. For example, when they use the maximise button a tip pops up explaining they can also maximise by double clicking. I feel this is perhaps the most important aspect of the tip system.
The problem I find with tips is that I might read it when I first use the app but then 6 months later when I need that feature I have forgotten the tip. So showing the tip again when I use a slow way to do something is helpful. Have some way of dismissing permanently
Use the tips like the in app manual. So they can be launched from a menu option somewhere.
add a help question mark button to dialogs that open the related tip
enable links in tips so they can jump to other tips
re enable tips when a new feature is added.
tips should be able to display images

I am happy to work on assembling a tip list if you want.

tuomas2 · 2021-05-19T06:45:15Z

Anyone knows an easy-to-use framework how to include such tips into app?
(perhaps we need even 2 frameworks: for js side, and for android native side)

agrogers · 2021-05-21T13:42:53Z

This is not what I had in mind but it is related and could be a nice intro. Apparently Google even use it

https://github.com/amlcurran/ShowcaseView

agrogers · 2021-05-21T13:47:22Z

And this as an intro but still not what I had in mind
https://developer.android.com/training/tv/playback/onboarding

tuomas2 · 2021-05-21T14:29:42Z

Thanks, I'll try a little ShowcaseView. Then I'll let you know what I think.

Minus side is that this might add considerable amount of translatable strings... and advanced users (like me) often hate them.

timbze · 2021-05-21T15:04:43Z

and advanced users (like me) often hate them.

It might be good to have a checkbox in the new startup screen, where after a new install the user could uncheck if they don't want to see any first-time tips. If they leave it checked then they would see the tips.

tuomas2 · 2021-05-21T15:22:06Z

and advanced users (like me) often hate them.

It might be good to have a checkbox in the new startup screen, where after a new install the user could uncheck if they don't want to see any first-time tips. If they leave it checked then they would see the tips.

But as @agrogers said, it should not be "too easy" to turn them off, as "grandmas" also might opt out, and then they do not know how to use AB. I would say it's better to have option to disable it on app preferences and tell user (with words) this in first tip.

tuomas2 · 2021-05-21T15:26:40Z

though for grandmas it's often enough that they know how to read their favourite bible and that's all. For that they hopefully do not need any tips... (AB might not be the best choise for them in any case)

Dleemuse · 2021-05-22T01:28:24Z

Hey all,

I am 60 years old, & a grandma of 6... I use AB everyday, & can keep up with a lot of the features... I admit I am tech challenged, but some grandmas are not all that slow, I do way more in AB than you might think, Lol... Just had to tease you a bit.

I do love the idea of it not being too easy to turn tips off.

Debra

agrogers · 2021-05-22T03:49:51Z

I think the 'ShowcaseView' could be a nice intro to the software. But i am not sure that it would be used more than that very first instance.

I have kept looking for a framework or library for a help system (or tips or hints or whatever - i have searched for all). But I cant find any. So I am starting to think my first idea which i haven't shared might be as good as any.

And Bible is already a very good hyperlinked document system. Why not just use the current functionality to make a 'help document' that does what we want? I have very limited experience in making OSIS documents (got a nice TSK like commentary made). But you will know if the following can be done:

Popup the document in its only window ( it needs to sit above the And Bible docs)
Nice formatting - headings, bolding etc
Include images an animated gifs/pngs
Allows hyperlinking to itself. Most docs target the link window I think.
Be able to open to a specific topic
Follow a link to a web page or youtube video
Be able to write it in a nice format. Ideally we could have the master copy here https://readthedocs.org/ and then use that content to generate the document
The book document seems to me to be able to do most of this already.
I hadn't looked at the book document types for a while - it looks great. It feels like it can do pretty much everything we would need in a help system.

tuomas2 · 2021-05-22T06:20:16Z

Hey all,

I am 60 years old, & a grandma of 6... I use AB everyday, & can keep up with a lot of the features... I admit I am tech challenged, but some grandmas are not all that slow, I do way more in AB than you might think, Lol... Just had to tease you a bit.

I do love the idea of it not being too easy to turn tips off.

Debra

Hehe, sorry... Those grandmas that I was talking about are not in Github reading/commenting on tickets :-D I think you definitely do not fall into the category I was talking about. Perhaps my use of word 'grandma' was a bit too generalizing =)

My mom is more of the type I'm talking about. She's using speak aloud feature, and sometimes reads bible @ church with AB, but I doubt she knows what are workspaces, or does not care about bookmarks, and I believe she has never touched any settings (unless by accident). But fortunately, AB has not got too difficult for her to use so far anyway.

tuomas2 · 2021-05-22T06:25:38Z

@agrogers Help doc would not be easy to translate, probably would serve english-speaking people only. And instead, it could be implemented as an online documentation @ wiki (Github or something else, if Github is not good enough). Also, updating screenshots/animated gifs would be painful, because UI is changing all the time (same issue as with promotional material, which I was thinking to tackle with #803).

tuomas2 · 2021-05-22T07:58:22Z

Though if you would like to do that and take main responsibility of maintaining it, we can make a source repo in And Bible github org for it and include it in And Bible sword repo.

Perhaps it's better than nothing anyway. But I'd like to have some translatable short feature descriptions in help screen as allways, so that users of any language can have at least that.

agrogers · 2021-06-25T05:09:31Z

Re timing of this feature, there are so many big changes to AB that it feels like this coming release is when such a feature is needed. But I understand that this is not a simple thing to do.

Maybe Include this feature in v3.4.

tuomas2 · 2021-06-25T07:27:50Z

By this date we don't have a good plan to implement this, I think we should not delay the update too much. I think people (I think our target audience is rather smart anyway) can learn most of the features by trial and error and watching tutorial videos.

agrogers · 2021-06-25T13:13:52Z

Tim made me think that maybe an easy help system would be to

add a window - maybe maximum 10 lines high - at the top of all lists.
In this we show the explanation (scrollable if it is long) explaining how the list/dialog etc works.
The user can dismiss it somehow so it goes away forever (or until a new feature is added or something changes).
Is it easy to add such a control to the top of these lists / dialogs?

tuomas2 · 2021-06-26T08:11:26Z

What about making it same way as in workspaces view?

tuomas2 · 2021-06-26T08:30:42Z

Added string for assign label dialog help. Implementation can be desided later but I would go with (?) button and similar help dialog that we have been using earlier.

tuomas2 · 2021-06-26T08:31:51Z

Did not push them yet to Transifex, so please review and suggest improvements if you think they are needed! 78b2b21

tuomas2 · 2021-06-30T06:37:01Z

@agrogers could you think of a short help text for "All text settings" screens, both per-workspace and per-window, that would tell briefly how setting inheritance works?

I.e. essentially what I tell here https://www.youtube.com/watch?v=rz0zyEK9qBk

That's something I'd like to have questionmark button because it's not completely obvious without instructions.

agrogers · 2021-06-30T10:33:54Z

Sure thing. Happy to help. Thanks for being specific - I was struggling a little to know where to start.

…

___________________________ *www.TenOutOfTen.org* <https://www.TenOutOfTen.org> ***@***.*** (+61) 0477 174 193 (Australia) (+95) 09 250018669 (Myanmar)

On Wed, 30 Jun 2021 at 16:37, Tuomas Airaksinen ***@***.***> wrote: @agrogers <https://github.com/agrogers> could you think of a short help text for "All text settings" screens, both per-workspace and per-window, that would tell briefly how setting inheritance works? I.e. essentially what I tell here https://www.youtube.com/watch?v=rz0zyEK9qBk That's something I'd like to have questionmark button because it's not completely obvious without instructions. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1071 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADKGTJXDW4YZGLWKBLEZY33TVK3RPANCNFSM446NAK5A> .

agrogers · 2021-06-30T13:01:11Z

Hi Tuomas. You can find a document here with my best effort for workspace settings. I think i have found all of them and grouped them in a way that seems logical to me. https://docs.google.com/document/d/1KlhgSyLFjscep79emSN38XFrZknd3Ptrx6A1G4BaTL0/edit?usp=sharing I have also had some more thoughts on how to do the window button menus. It seems that my picture is pretty much impossible to make with our multi-window format. I will do a mock up of what i have in mind tomorrow night when i am back home. Cheers Andrew

…

___________________________ *www.TenOutOfTen.org* <https://www.TenOutOfTen.org> ***@***.*** (+61) 0477 174 193 (Australia) (+95) 09 250018669 (Myanmar)

On Wed, 30 Jun 2021 at 20:33, Andrew Rogers ***@***.***> wrote: Sure thing. Happy to help. Thanks for being specific - I was struggling a little to know where to start. ___________________________ *www.TenOutOfTen.org* <https://www.TenOutOfTen.org> ***@***.*** (+61) 0477 174 193 (Australia) (+95) 09 250018669 (Myanmar) On Wed, 30 Jun 2021 at 16:37, Tuomas Airaksinen ***@***.***> wrote: > @agrogers <https://github.com/agrogers> could you think of a short help > text for "All text settings" screens, both per-workspace and per-window, > that would tell briefly how setting inheritance works? > > I.e. essentially what I tell here > https://www.youtube.com/watch?v=rz0zyEK9qBk > > That's something I'd like to have questionmark button because it's not > completely obvious without instructions. > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > <#1071 (comment)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/ADKGTJXDW4YZGLWKBLEZY33TVK3RPANCNFSM446NAK5A> > . >

tuomas2 · 2021-06-30T13:10:27Z

Hmm. I was thinking if you could help me to figure out short help text for the current "all text settings" menu entries, similar way as you wrote in the above for assign labels.

i.e. these: for workspace

for window

tuomas2 · 2021-06-30T13:16:45Z

I'm going to freeze strings tomorrow, so I need help strings by tomorrow evening. I can write something myself too, but I'm thinking you might come up with better help texts.

tuomas2 · 2021-06-30T15:53:33Z

Okay, here are my suggestions. How do these sound:

https://docs.google.com/document/d/1eSZct6Qe2ZFduU5T4p_N4UtMh6P-UJq6o3WKJexR228/edit

Please @AndBible/developers @agrogers comment / improve directly in docs.

agrogers · 2021-06-30T23:33:38Z

OK, i have made some suggestions. Maybe they are helpful. Keep up the good work!

…

___________________________ *www.TenOutOfTen.org* <https://www.TenOutOfTen.org> ***@***.*** (+61) 0477 174 193 (Australia) (+95) 09 250018669 (Myanmar)

On Thu, 1 Jul 2021 at 01:53, Tuomas Airaksinen ***@***.***> wrote: Please @AndBible/developers <https://github.com/orgs/AndBible/teams/developers> @agrogers <https://github.com/agrogers> comment / improve here: https://docs.google.com/document/d/1eSZct6Qe2ZFduU5T4p_N4UtMh6P-UJq6o3WKJexR228/edit — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1071 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADKGTJTTTDORKKB7AZVBCELTVM4YPANCNFSM446NAK5A> .

tuomas2 · 2021-07-01T06:45:44Z

tuomas2 · 2021-07-01T06:46:01Z

Thanks @agrogers !

tuomas2 · 2021-07-01T09:07:44Z

Now help items are added to label selection related screens and text options screens.

tuomas2 · 2021-07-01T09:09:24Z

Strings can still be changed UNTIL I freeeze them later today... (after that only via transifex (en_GB)

tuomas2 · 2021-07-01T15:40:39Z

I think this is now more or less implemented as far as we want to do it now.

agrogers added Type: Feature Prio: Minor Status: Preliminary labels May 16, 2021

agrogers mentioned this issue May 16, 2021

Create a setting to pick bibles in compare... #1049

Closed

agrogers mentioned this issue Jun 19, 2021

What should a new install of And Bible look like? #1163

Closed

agrogers mentioned this issue Jun 25, 2021

"Assign labels" screen needs more information / help #1179

Closed

tuomas2 added a commit that referenced this issue Jun 26, 2021

Add string to #1071

78b2b21

This comment has been minimized.

Sign in to view

tuomas2 added a commit that referenced this issue Jul 1, 2021

Add instructions to text options screens #1071

a77d5ec

tuomas2 added a commit that referenced this issue Jul 1, 2021

Help related changes #1071

84bd1a1

tuomas2 closed this as completed Jul 1, 2021

agrogers mentioned this issue Jul 5, 2021

Quick (between 3-6 step) tutorial on the basics of how to use And Bible #1239

Open

tuomas2 moved this to Closed in Tuomas' project board Sep 7, 2022

tuomas2 added this to Tuomas' project board Sep 7, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

In app help/tip/hint system #1071

In app help/tip/hint system #1071

agrogers commented May 16, 2021

tuomas2 commented May 19, 2021

agrogers commented May 21, 2021

agrogers commented May 21, 2021

tuomas2 commented May 21, 2021

timbze commented May 21, 2021

tuomas2 commented May 21, 2021

tuomas2 commented May 21, 2021

Dleemuse commented May 22, 2021

agrogers commented May 22, 2021

tuomas2 commented May 22, 2021 •

edited

Loading

tuomas2 commented May 22, 2021

tuomas2 commented May 22, 2021

agrogers commented Jun 25, 2021

tuomas2 commented Jun 25, 2021

agrogers commented Jun 25, 2021 •

edited

Loading

tuomas2 commented Jun 26, 2021

tuomas2 commented Jun 26, 2021

tuomas2 commented Jun 26, 2021

tuomas2 commented Jun 30, 2021

agrogers commented Jun 30, 2021 via email

agrogers commented Jun 30, 2021 via email

tuomas2 commented Jun 30, 2021 •

edited

Loading

tuomas2 commented Jun 30, 2021

This comment has been minimized.

tuomas2 commented Jun 30, 2021 •

edited

Loading

agrogers commented Jun 30, 2021 via email

tuomas2 commented Jul 1, 2021 •

edited

Loading

tuomas2 commented Jul 1, 2021

tuomas2 commented Jul 1, 2021

tuomas2 commented Jul 1, 2021 •

edited

Loading

tuomas2 commented Jul 1, 2021

In app help/tip/hint system #1071

In app help/tip/hint system #1071

Comments

agrogers commented May 16, 2021

tuomas2 commented May 19, 2021

agrogers commented May 21, 2021

agrogers commented May 21, 2021

tuomas2 commented May 21, 2021

timbze commented May 21, 2021

tuomas2 commented May 21, 2021

tuomas2 commented May 21, 2021

Dleemuse commented May 22, 2021

agrogers commented May 22, 2021

tuomas2 commented May 22, 2021 • edited Loading

tuomas2 commented May 22, 2021

tuomas2 commented May 22, 2021

agrogers commented Jun 25, 2021

tuomas2 commented Jun 25, 2021

agrogers commented Jun 25, 2021 • edited Loading

tuomas2 commented Jun 26, 2021

tuomas2 commented Jun 26, 2021

tuomas2 commented Jun 26, 2021

tuomas2 commented Jun 30, 2021

agrogers commented Jun 30, 2021 via email

agrogers commented Jun 30, 2021 via email

tuomas2 commented Jun 30, 2021 • edited Loading

tuomas2 commented Jun 30, 2021

This comment has been minimized.

tuomas2 commented Jun 30, 2021 • edited Loading

agrogers commented Jun 30, 2021 via email

tuomas2 commented Jul 1, 2021 • edited Loading

tuomas2 commented Jul 1, 2021

tuomas2 commented Jul 1, 2021

tuomas2 commented Jul 1, 2021 • edited Loading

tuomas2 commented Jul 1, 2021

tuomas2 commented May 22, 2021 •

edited

Loading

agrogers commented Jun 25, 2021 •

edited

Loading

tuomas2 commented Jun 30, 2021 •

edited

Loading

tuomas2 commented Jun 30, 2021 •

edited

Loading

tuomas2 commented Jul 1, 2021 •

edited

Loading

tuomas2 commented Jul 1, 2021 •

edited

Loading