Difference between revisions of "Features/Replace GtkMenu"

Latest revision as of 02:22, 9 August 2015

Summary

Get rid of Gtk.Menu based palettes - use a modal.

Owner

Name: Sam

Email: sam@sl.o

Current status

Targeted release: 0.108
Last updated: 7/July/2015
Percentage of completion: 40%

Detailed Description

Gtk.Menu palettes (namely, clipboard and journal) are hard to maintain and theme. They should be removed.

The only reason they are used now is because they support nesting of menus. However, a modal could be used instead.

Benefit to Sugar

This will make sugar easier to maintain and reduce the amount of visual bugs.

Scope

Adding a modal should be a quick process. It would probably only involve:

Adding a modal primitive to sugar3.graphics.modal.SelectorModal` (DONE, patch: ~~https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/238~~ https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/249)

Migrating the 2 users of the Gtk.Menu to the modal and Gtk.Window based palettes
- The clipboard in the frame (DONE, patch: ~~https://github.com/sugarlabs/sugar/pull/551~~ https://github.com/sugarlabs/sugar/pull/567)
- The journal palettes

UI Design

Screenshots are on this pull request description https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/238

Resources (Other Platforms)

Android 4.x

GNOME 3.16.2

Firefox OS 3.0.0.0-prerelease

How To Test

Install the patches
Open log
Drag text to clipboard
Right click on the clipboard item
Click open with

User Experience

Users will no longer have the open with sub-menu. This means that they will have to move their mouse more. However, the search bar will make life eaiser for power users as they can jusotsearch and press <enter>.

Users will notice that palettes look more beautiful, as they are not Gtk.Menu based.

Dependencies

Contingency Polan

Documentation

Bits of documentation in the code, however improving them is still on the TODO list.

Release Notes

The Sugar Release Notes inform end-users about what is new in the release. An Example is 0.84/Notes. The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns. If there are any such changes involved in this feature, indicate them here. You can also link to upstream documentation if it satisfies this need. This information forms the basis of the release notes edited by the release team and shipped with the release.

Comments and Discussion

@@ Line 2: / Line 2: @@
 [[Category:Feature Page Incomplete]]
 [[Category:Feature|.]]
-<!-- You can add categories to tie features back to real deployments/schools requesting them, for example
-[[Category:Features requested by School Xyz|<Feature Name>]] (the |Feature Name option sorts the entry on the category page under the first letter of <Feature Name>). -->
 </noinclude>
-{{Note/important|Comments and Explanations:|There are comments (''in italics'') providing guidance to fill out each section, see also the [[Features/Policy|Feature Policy Page]] for a more detailed explanation of the new-feature process. '''Copy the source to a ''new page'' named Features/''Your Feature Name'' before making changes!  DO NOT EDIT THIS TEMPLATE.'''}}
-<!-- All fields on this form are required to be accepted.
- We also request that you maintain the same order of sections so that all of the feature pages are uniform.  -->
-<!-- The actual name of your feature page should look something like: Features/Your Feature Name.  This keeps all features in the same namespace -->
 == Summary ==
@@ Line 21: / Line 12: @@
 * Email: sam@sl.o
-* I do not own this feature, I just made the wiki page.
 == Current status ==
 * Targeted release: 0.108
-* Last updated: 24/May/2015
+* Last updated: 7/July/2015
-* Percentage of completion: 0%
+* Percentage of completion: 40%
 == Detailed Description ==
-GtkMenu palettes (namely, clipboard and journal) are hard to maintain and theme.  They should be removed.
+Gtk.Menu palettes (namely, clipboard and journal) are hard to maintain and theme.  They should be removed.
 The only reason they are used now is because they support nesting of menus.  However, a modal could be used instead.
@@ Line 38: / Line 28: @@
 == Scope ==
 Adding a modal should be a quick process.  It would probably only involve:
+* Adding a modal primitive to sugar3.graphics.modal.SelectorModal`  (DONE, patch:  <strike>https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/238</strike> https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/249)
-* Adding a modal primative to `sugar3.graphics.sleectormodal`
+* Migrating the 2 users of the Gtk.Menu to the modal and Gtk.Window based palettes
-* Migrating the 2 users of the GtkMenu to the modal and GtkWindow based palettes
+** The clipboard in the frame (DONE, patch: <strike>https://github.com/sugarlabs/sugar/pull/551</strike> https://github.com/sugarlabs/sugar/pull/567)
+** The journal palettes
 ==UI Design==
-===Resources===
-[[File:Change-default-app-android-31.png|none|thumb|Android 4.x]]
-[[File:GNOME Modal Gedit.png|none|thumb|GNOME 3.16.2]]
+Screenshots are on this pull request description https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/238
+===Resources (Other Platforms)===
+[[File:Change-default-app-android-31.png|none|thumb|Android 4.x|484x484px]]
+[[File:GNOME Modal Gedit.png|thumb|GNOME 3.16.2|333x333px|none]]
+[[File:FFOS Modal.png|thumb|Firefox OS 3.0.0.0-prerelease|none]]
 == How To Test ==
-{{:{{PAGENAME}}/Testing}}
+# Install the patches
+# Open log
+# Drag text to clipboard
+# Right click on the clipboard item
+# Click open with
 == User Experience ==
-''If this feature is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice.''
+Users will no longer have the open with sub-menu.  This means that they will have to move their mouse more.  However, the search bar will make life eaiser for power users as they can jusotsearch and press <enter>.
+Users will notice that palettes look more beautiful, as they are not Gtk.Menu based.
 == Dependencies ==
-''What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this feature depends?  In other words, does your feature depend on completion of another feature owned by someone else or that you would need to coordinate, which might cause you to be unable to finish on time?  Other upstream projects like Python?''
+== Contingency Polan ==
-== Contingency Plan ==
-''If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "None necessary, revert to previous release behaviour."  Or it might not.  If your feature is not completed in time, we want to assure others that other parts of Sugar will not be in jeopardy.''
 == Documentation ==
-''Is there upstream documentation on this feature, or notes you have written yourself?  Has this topic been discussed in the mailing list or during a meeting? Link to that material here so other interested developers can get involved.''
+Bits of documentation in the code, however improving them is still on the TODO list.
 == Release Notes ==
@@ Line 69: / Line 65: @@
 * http://lists.sugarlabs.org/archive/sugar-devel/2015-May/050174.html
 * http://lists.sugarlabs.org/archive/sugar-devel/2015-May/050209.html
-* See [[{{TALKPAGENAME}}|the discussion tab for this feature.]] <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page. -->
+* See [[{{TALKPAGENAME}}|the discussion tab for this feature.]]