Fwd: RFC:Simple Help widget for activities

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view

Fwd: RFC:Simple Help widget for activities

Adam Holt
Thanks Gonzalo for pushing the envelope below!  REMINDER: On Apr 3-5 (video tutorials presprint) and Apr 6-10 (docs sprints) we hope to contribute too where we can -- particularly updating the Help Activity and its associated http://laptop.org/manual -- thanks to Seth Woodworth, Caryl Bigenho & All:


From: Gonzalo Odiard <[hidden email]>
To: Sugar-dev Devel <[hidden email]>; iaep <[hidden email]>
Sent: Wednesday, March 7, 2012 7:37 AM
Subject: [Sugar-devel] RFC:Simple Help widget for activities

We receive many times request about adding help in the activities,
and if is true Sugar propose a exploratory approach,
not all the people learn in the same way,
and there are people who prefer a little guidance.

For the development we need a simple api, and easy i18n,
and a non obtrusive experience for the user.

Inspired by the DescriptionItem, I was experimenting with a widget to add simple help to activities.
This is not:
* A manual
* Lessons
* Tips
Is a short startup help for the activity.

Use only text and the icons already used by the activity.

A example can be seen here: http://dev.laptop.org/~gonzalo/images/simple_graph_help.png

In the activity we only need do:

    helpitem = HelpButton()
    toolbar.insert(helpitem, -1)
    helpitem.add_section(_('Basic usage'))
    helpitem.add_paragraph(_('First you need add data to create the graphic'))
    helpitem.add_paragraph(_('You can add data with this button'),
    helpitem.add_paragraph(_('...or remove data with this button'),
    helpitem.add_paragraph(_('To change the graphic title, just change the activity title'))

This proposal is late for sugar 0.96, but may be we can try it in one or two activities,
and start thinking about this topic.
I really like the help in the Implode activity, but have the following problems:
* I don't know if apply to other type of activities.
* Is modal
* need a lot of code to implement it.



Library mailing list
[hidden email]