GUI: Set a default user-callback script if none exists (containing how-to instructions)

[aryoda]

If you are a first time contributor...

Welcome to the project, if you pick up this Issue because of the "GOOD FIRST USE" label. You will be mentored through the process if you want. This issue is quit old and may lack some details important for new contributors. Just raise your hand and we will provide more details. Please do not hesitate to ask questions. Your solution don't need to be perfect.

The Problem

This is a feature request taken from: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=985257

Actual behaviour:

If no user-callback script exists and a user clicks on

settings > general > Edit user-callback

an empty user-callback editor windows is shown.

Impact

A normal user cannot understand what to do here and where to find documentation to learn more.

Expected behavior:

If no user-callback script file exists a default script (that does nothing!) should be shown.

The script should include the relevant documentation and links for an easy start.

BTW: There are already some user-callback scripts in the BiT repo that could be used: https://github.com/bit-team/user-callback

Possible extension (gold standard ;-)

A button could be added to the "user-callback" editor window which offers a choice of different default user-callback scripts
for different purposes.

Make sure that the existing user-callback is not overwritten without explicitly asking the user and making a backup!

[buhtz]

Do you have an idea about how to integrate "documentation" into this workflow?

Maybe create an extra markdown file in the repo and offer a link in the edit-user-callback-dialog? Or is this too lazy? ;)
Or we really create a section in the user manual (see #1659) we can then link to?

[aryoda]

Do you have an idea about how to integrate "documentation" into this workflow?

Perhaps add a "help" button

• linking to a specific page in our user-callback repo
• or showing the user-callback section of the installed man backintime.

Also adding enough comments to our default user-callback scripts could help (and mention there man backintime).

[buhtz]

Sounds good to me.

[emtiu]

My instinct would be a much simpler solution: Display an empty dummy-callback script with commented-out example code, and a few URLs to further help :)

Or maybe paths to local files with documentation, if we want to keep it offline.

[buhtz]

Related to

• User manual: Document user-callback scripts for users (migrate to MkDocs) #1659
• Migrate user manual to MkDocs #1838

[buhtz]

https://mail.python.org/archives/list/bit-dev@python.org/message/JDU4EYFYKFA6YZZD2WP2WKPE4QA5UIBA/

[buhtz]

See PR

• doc: Integrate user-callback docu and example scripts into manual #1899