Features/Save-As: Difference between revisions

(5 intermediate revisions by 2 users not shown)

Line 18:

== Current status ==

* Targeted release: 0.112

* Last updated: ~~24th April~~ 2017

* Last updated: 15th September 2017

* Percentage of completion: ~~complete~~

* Percentage of completion: 100%

== Detailed Description ==

* ~~for~~ a new document (start new), when the user ~~quits~~ the activity, a popup provides an opportunity for the user to give the ~~document~~ a name. The user can ~~also decide not to save it~~.

* For a new document (start new), when the user '''Stops''' the activity, a popup provides an opportunity for the user to give the Journal entry a name. The user can choose from the 'Save' and 'Don't Save' options. However, an instance will appear in the Journal for statistical purpose but no changes would be saved if user selects 'Don't Save' option.

* ~~for~~ an existing document, when the user ~~quits~~ the activity, a popup provides an opportunity to give it a new name. In this case, ~~it will be saved under~~ the new name ~~and~~ the original will be preserved. If the user ~~chooses not to provide a new~~ name, the document is saved replacing the original.

* For an existing document, when the user '''Stops''' the activity, a popup provides an opportunity to give it a new name.

* ~~provides~~ a ~~setting~~ to enable or disable the feature

** In this case, if the user supplies a new name (different from original), a new instance is created with the new changes while the original (previous) will remain preserved.

** If the user saves with the same name, the document is saved replacing the original.

** If the user selects 'Don't Save' option, no changes are saved (no new entry is created) and the original instance will remain preserved.

* Provides a settings (GConf & GSettings) to enable or disable the feature.

** '''GConf -''' https://github.com/sugarlabs/sugar/pull/751

** '''GSettings -''' https://github.com/sugarlabs/sugar/pull/750

*After pressing Stop if the user feels that he needs to continue with the current work, he can '''dismiss''' the alert by pressing '''<nowiki/>'Esc' key''' on keyboard.

== Benefit to Sugar ==

''What is the benefit to the platform? If this is a major capability update, what has changed? If this is a new feature, what capabilities does it bring? Why will Sugar become a better platform or project because of this feature?''

''What is the '''benefit''' to the platform? If this is a major capability update, what has changed? If this is a new feature, what capabilities does it bring? Why will Sugar become a better platform or project because of this feature?''

Currently Sugar saves objects to the Journal with the name of the activity. In the original toolkit design, the name was displayed to the top left of the toolbar so that a user could enter their own name. At that time, the user had a 'keep' button on the toolbar which enabled an object to be saved while continuing to work as found on most document based applications.

Line 45:

Line 52:

''What work do the developers have to accomplish to complete the feature in time for release? Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?''

* pull request review,

* documentation changes.

Feature is implemented in activity.py (sugar and sugar3).

Line 50:

Line 60:

==UI Design==

~~''Does the feature have a direct impact on the work flow, or does it need a UI? Link here mockups, or add detailed descriptions.''~~

Direct impact on work flow. A visual mockup is in https://github.com/sugarlabs/sugar-toolkit/pull/4

Line 59:

Line 67:

== 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.''~~

When the user presses the stop button or ctrl + q, a dialog will appear giving the opportunity to name or rename the associated Journal entry.

Line 68:

Line 75:

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

No dependencies.

Line 77:

Line 83:

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

See PR #327 at https://github.com/sugarlabs/sugar-toolkit-gtk3

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

Save As

A user or deployment can enable this feature by setting ~~gsetting~~ 'save as' ~~to True)~~. This feature provides a capability comparable to the 'save' and 'save as' capabilities offered by conventional document processing programs such as those of Libre Office.

A user or deployment can enable this feature by setting 'save as'. This feature provides a capability comparable to the 'save' and 'save as' capabilities offered by conventional document processing programs such as those of Libre Office.

== Comments and Discussion ==

* Link to the discussion on lists.sugarlabs.org: http://lists.sugarlabs.org/archive/sugar-devel/2017-April/054141.html

* ''Link to the discussion ~~of this feature~~ on lists.sugarlabs.org''

* See [[{{TALKPAGENAME}}|the discussion tab for this feature.]]

@@ Line 18: / Line 18: @@
 == Current status ==
 * Targeted release: 0.112
-* Last updated: 24th April 2017
+* Last updated: 15th September 2017
-* Percentage of completion: complete
+* Percentage of completion: 100%
 == Detailed Description ==
-* for a new document (start new), when the user quits the activity, a popup provides an opportunity for the user to give the document a name. The user can also decide not to save it.
+* For a new document (start new), when the user '''Stops''' the activity, a popup provides an opportunity for the user to give the Journal entry a name. The user can choose from the 'Save' and 'Don't Save' options. However, an instance will appear in the Journal for statistical purpose but no changes would be saved if user selects 'Don't Save' option.
-* for an existing document, when the user quits the activity, a popup provides an opportunity to give it a new name. In this case, it will be saved under the new name and the original will be preserved. If the user chooses not to provide a new name, the document is saved replacing the original.
+* For an existing document, when the user '''Stops''' the activity, a popup provides an opportunity to give it a new name.
-* provides a setting to enable or disable the feature
+** In this case, if the user supplies a new name (different from original), a new instance is created with the new changes while the original (previous) will remain preserved.
+** If the user saves with the same name, the document is saved replacing the original.
+** If the user selects 'Don't Save' option, no changes are saved (no new entry is created) and the original instance will remain preserved.
+* Provides a settings (GConf & GSettings) to enable or disable the feature.
+** '''GConf -''' https://github.com/sugarlabs/sugar/pull/751
+** '''GSettings -''' https://github.com/sugarlabs/sugar/pull/750
+*After pressing Stop if the user feels that he needs to continue with the current work, he can '''dismiss''' the alert by pressing '''<nowiki/>'Esc' key''' on keyboard.
 == Benefit to Sugar ==
-''What is the benefit to the platform?  If this is a major capability update, what has changed?  If this is a new feature, what capabilities does it bring? Why will Sugar become a better platform or project because of this feature?''
+''What is the '''benefit''' to the platform?  If this is a major capability update, what has changed?  If this is a new feature, what capabilities does it bring? Why will Sugar become a better platform or project because of this feature?''
 Currently Sugar saves objects to the Journal with the name of the activity. In the original toolkit design, the name was displayed to the top left of the toolbar so that a user could enter their own name. At that time, the user had a 'keep' button on the toolbar which enabled an object to be saved while continuing to work as found on most document based applications.
@@ Line 45: / Line 52: @@
 ''What work do the developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?''
+* pull request review,
+* documentation changes.
 Feature is implemented in activity.py (sugar and sugar3).
@@ Line 50: / Line 60: @@
 ==UI Design==
-''Does the feature have a direct impact on the work flow, or does it need a UI? Link here mockups, or add detailed descriptions.''
 Direct impact on work flow.  A visual mockup is in https://github.com/sugarlabs/sugar-toolkit/pull/4
@@ Line 59: / Line 67: @@
 == 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.''
 When the user presses the stop button or ctrl + q, a dialog will appear giving the opportunity to name or rename the associated Journal entry.
@@ Line 68: / Line 75: @@
 == 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?''
 No dependencies.
@@ Line 77: / Line 83: @@
 == 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.''
 See PR #327 at https://github.com/sugarlabs/sugar-toolkit-gtk3
 == 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.''
 Save As
-A user or deployment can enable this feature by setting gsetting 'save as' to True). This feature provides a capability comparable to the 'save' and 'save as' capabilities offered by conventional document processing programs such as those of Libre Office.
+A user or deployment can enable this feature by setting 'save as'. This feature provides a capability comparable to the 'save' and 'save as' capabilities offered by conventional document processing programs such as those of Libre Office.
 == Comments and Discussion ==
+* Link to the discussion on lists.sugarlabs.org: http://lists.sugarlabs.org/archive/sugar-devel/2017-April/054141.html
-* ''Link to the discussion of this feature on lists.sugarlabs.org''
 * 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. -->