Features/WebKit: Difference between revisions

Line 5:

[[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>

~~'''Comments and Explanations:'''~~

There are comments (in italic) 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. -->~~

~~~~

== Summary ==

~~Due to an increasing of support for building applications around the Mozilla web browsing technologies, this feature proposes that~~ Browse ~~is switched~~ to [http://www.webkit.org/ WebKit] as its back-end technology provider.

Browse and related components are switching to [http://www.webkit.org/ WebKit] as its back-end technology provider. (this is just a proposal, for now)

== Owner ==

~~''This should link to your home wiki page so we know who you are''~~

* Name: [[User:DanielDrake|Daniel Drake]]

Line 28:

Line 18:

== Detailed Description ==

'~~'Expand~~ on the ~~summary, if appropriate~~. ~~A couple of sentences suffices~~ to ~~explain~~ the ~~goal~~, ~~but~~ the more ~~details you can provide~~ the ~~better~~.''

Browse and related components currently embed Mozilla XUL/Gecko as their backend, however, Mozilla embedding has typically been neglected and buggy, causing a maintenance headache for us. It is now [https://groups.google.com/forum/#!topic/mozilla.dev.embedding/c_NMcO-N8wo/discussion actively discouraged] by Mozilla developers, who are focusing all their efforts on Firefox. From the perspective of a fairly regular open-source project, Mozilla's direction is also [http://lists.sugarlabs.org/archive/sugar-devel/2011-June/031865.html questionable on other points].

WebKit is a promising alternative, which is (by nature) an embeddable web engine. It is used in Apple Safari and Google Chrome and various other projects.

=== Existing prototype: Surf ===

The pywebkitgtk-based Surf activity can be used as a prototype. Possible areas that need work are:

* Downloads - originally missing due to [http://www.mail-archive.com/sugar-devel@lists.sugarlabs.org/msg08959.html no support in pywebkitgtk] but now landed?

* persistant history - not saved across sessions (or journal entries)

* clipboard/undo/redo - should be simple

* back and forward buttons - you can go back and forward through your history, but autocomplete and skipping back or forward in the history is not implemented. shouldn't be too hard to complete

* arrow key navigation in textbox

* No cookie support

pywebkit is seen as deprecated, [http://janalonzo.wordpress.com/2010/01/18/using-introspected-webkitgtk-in-gwibber/ even by the author himself]. PyGI is the solution, allowing direct calls into pywebkitgtk with no static bindings, and is now mature. Some of the missing features above can't be solved until either pywebkitgtk grows more API, or the switch is made to PyGI.

=== Proposed implementation ===

Browse should move to WebKitGtk (for GTK+-2.x) using PyGI (gobject-introspection). Even though most applications of PyGI target GTK+ v3, we believe it should work on v2. However, a possible problem here is that sugar-toolkit bindings use static GTK+ bindings, and mixing PyGI calls in the same app might lead to problems ([http://lists.sugarlabs.org/archive/sugar-devel/2011-June/031869.html source]).

== Benefit to Sugar ==

Line 47:

Line 56:

== 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?''

pywebkitgtk is already a part of the Sugar platform (for epub support in Read).

== Contingency Plan ==

@@ Line 5: / Line 5: @@
 [[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>
-'''Comments and Explanations:'''
-There are comments (in italic) 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 ==
-Due to an increasing of support for building applications around the Mozilla web browsing technologies, this feature proposes that Browse is switched to [http://www.webkit.org/ WebKit] as its back-end technology provider.
+Browse and related components are switching to [http://www.webkit.org/ WebKit] as its back-end technology provider. (this is just a proposal, for now)
 == Owner ==
-''This should link to your home wiki page so we know who you are''
 * Name: [[User:DanielDrake|Daniel Drake]]
@@ Line 28: / Line 18: @@
 == Detailed Description ==
-''Expand on the summary, if appropriate.  A couple of sentences suffices to explain the goal, but the more details you can provide the better.''
+Browse and related components currently embed Mozilla XUL/Gecko as their backend, however, Mozilla embedding has typically been neglected and buggy, causing a maintenance headache for us. It is now [https://groups.google.com/forum/#!topic/mozilla.dev.embedding/c_NMcO-N8wo/discussion actively discouraged] by Mozilla developers, who are focusing all their efforts on Firefox. From the perspective of a fairly regular open-source project, Mozilla's direction is also [http://lists.sugarlabs.org/archive/sugar-devel/2011-June/031865.html questionable on other points].
+WebKit is a promising alternative, which is (by nature) an embeddable web engine. It is used in Apple Safari and Google Chrome and various other projects.
+=== Existing prototype: Surf ===
+The pywebkitgtk-based Surf activity can be used as a prototype. Possible areas that need work are:
+* Downloads - originally missing due to [http://www.mail-archive.com/sugar-devel@lists.sugarlabs.org/msg08959.html no support in pywebkitgtk] but now landed?
+* persistant history - not saved across sessions (or journal entries)
+* clipboard/undo/redo - should be simple
+* back and forward buttons - you can go back and forward through your history, but autocomplete and skipping back or forward in the history is not implemented.  shouldn't be too hard to complete
+* arrow key navigation in textbox
+* No cookie support
+pywebkit is seen as deprecated, [http://janalonzo.wordpress.com/2010/01/18/using-introspected-webkitgtk-in-gwibber/ even by the author himself]. PyGI is the solution, allowing direct calls into pywebkitgtk with no static bindings, and is now mature. Some of the missing features above can't be solved until either pywebkitgtk grows more API, or the switch is made to PyGI.
+=== Proposed implementation ===
+Browse should move to WebKitGtk (for GTK+-2.x) using PyGI (gobject-introspection). Even though most applications of PyGI target GTK+ v3, we believe it should work on v2. However, a possible problem here is that sugar-toolkit bindings use static GTK+ bindings, and mixing PyGI calls in the same app might lead to problems ([http://lists.sugarlabs.org/archive/sugar-devel/2011-June/031869.html source]).
 == Benefit to Sugar ==
@@ Line 47: / Line 56: @@
 == 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?''
+pywebkitgtk is already a part of the Sugar platform (for epub support in Read).
 == Contingency Plan ==