Features/Write to journal anytime: Difference between revisions

(17 intermediate revisions by 2 users not shown)

Line 1:

[[Category:~~Feature Accepted 0.88]]~~

[[Category:FeatureLanded|Write to Journal anytime]]

~~[[Category:Feature~~|Write to Journal anytime]]

</noinclude>

Line 13:

Line 12:

== Current status ==

* Targeted release: 0.90

* Targeted release: 0.96

* Last updated: 08.10.~~2010~~

* Last updated: 01.12.2012

* Percentage of completion: 50%

* Percentage of completion: 100%

:[http://lists.sugarlabs.org/archive/sugar-devel/2012-January/035218.html patch to widgets.py]

:[http://lists.sugarlabs.org/archive/sugar-devel/2012-January/035217.html new icon]

* [http://www.mail-archive.com/sugar-devel@lists.sugarlabs.org/msg24814.html review thread]

== Detailed Description ==

Old Description: The Naming Alert is loved by some and despised by others. This enhancement makes it be available on demand from the <strike>activity toolbar</strike> Frame instead of automatically imposed when closing an activity. The goal is to encourage more writing and reflection throughout the activity, not just at the end.

'''Old Description:''' The Naming Alert is loved by some and despised by others. This enhancement makes it be available on demand from the <strike>activity toolbar</strike> Frame instead of automatically imposed when closing an activity. The goal is to encourage more writing and reflection throughout the activity, not just at the end.

New Description: The Naming Alert is loved by some and despised by others. This enhancement replaces it with a mechanism whereby notes can be added to the description field on demand from within an activity. Note that the only other user-midifiable fields in the Extended View of a Journal entry are Title, Tags, and Star (Favorite). ~~The~~ title has a mechanism for changing it in the toolbar already. There is a separate [[proposal for modifying tags]]. By using the same mechanism as the Alerts, it is non-modal and doesn't interfere with the action of the activity itself. The goal remains to encourage more writing and reflection throughout the activity, not just at the end.

'''New Description:''' The Naming Alert is loved by some and despised by others. This enhancement replaces it with a mechanism whereby notes can be added to the description field on demand from within an activity. Note that the only other user-midifiable fields in the Extended View of a Journal entry are Title, Tags, and Star (Favorite). (Note that the title has a mechanism for changing it in the toolbar already.) There is a separate [[proposal for modifying tags]]. By using the same mechanism as the Alerts, it is non-modal and doesn't interfere with the action of the activity itself. The goal remains to encourage more writing and reflection throughout the activity, not just at the end.

[[Image:Write_to_Journal_Alert.png]]

Line 27:

Line 29:

The open questions in my mind are:

* How is this alert evoked? A dedicated icon (See above) on the Activity toolbar (replacing for example the spot taken by the deprecated Keep button)? or a dedicated key on the keyboard (perhaps the unused Bulletin Board key)? or some other mechanism?

* How is this alert evoked? A dedicated icon (See above) on the Activity toolbar (replacing for example the spot taken by the deprecated Keep button)? or a dedicated key on the keyboard (perhaps the unused Bulletin Board key)? or some other mechanism (such as always appearing when the Activity toolbar is opened)?

* Should it be the entire entry or just a text field for augmenting the entry?

* Should it be folded into activity.py for all activities or just a mechanism reserved for activity authors who want this feature?

* Should it be optional and/or the default behavior?

* Should there be a separate mechanism for jumping to the Journal entry of an activity? (Again, a possible use of the Bulliten Board key).

Simon's alternative to the Alert mechanism is shown below:

[[File:Description.png|300px]]

We had a productive [[Talk:Features/Write_to_journal_anytime#Log_from_Design_Team_Meeting_08_January_2012|discussion]] that has led to a mashup of the various mock-ups above. New sketches will be available shortly.

First pass re the above discussion (modification of activity/widget.py):

[[File:Write_to_Journal_Palette.png|300px]]

Here is the the text-view version, which shows the entirety of the description field.

[[File:Write_to_Journal_Text_View.png|300px]]

===Considerations for 0.98 and beyond===

Why not add a Write to Journal for taking notes (from the Sugar Frame) as a general utility above and beyond the activity-specific notes???

I imagine a future Sugar having the ability to map the location of the pointer with a software component (much like right clicking in Etoys, or the picker in [http://live.gnome.org/GnomeShell/LookingGlass GNOME 3 Looking Glass]) and then having a data model and code to link learner annotations to any active Activity or visible software element. (Container objects could reveal subobjects or respond to subsequent requests.) A 'show annotations' gesture or control would reveal the appropriate content visibly and logically tied to the current view. --[[User:FGrose|FGrose]] 17:18, 24 January 2012 (EST)

== Benefit to Sugar ==

Line 41:

Line 64:

</strike>

I decided to implement this by adding write to Journal as a menu option to the activity's Frame instance in the shell. This will mean that we need no modifications to the toolbar, but it also means we need to find a way to notify the shell of the activities's object_id, since currently the shell only tracks activity_ids.

</strike>

== How To Test ==

Line 59:

Line 84:

== Release Notes ==

[[~~Image~~:Write-to-~~journal~~-0.90.~~png]]~~

[[File:Write to Journal Text View.png|300px]]

The Write-to-Journal-Anytime feature facilitates the process of writing notes and making reflections upon the work being conducted in an activity, while the activity is open. A new icon on the Activity Toolbar brings up a palette used to edit the activity Description Field. These notes are stored to the activity metadata, subsequently available for editing and viewing in the Journal and the Portfolio activity.

== Comments and Discussion ==

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

@@ Line 1: / Line 1: @@
 <noinclude>
-[[Category:Feature Accepted 0.88]]
+[[Category:FeatureLanded|Write to Journal anytime]]
-[[Category:Feature|Write to Journal anytime]]
 </noinclude>
@@ Line 13: / Line 12: @@
 == Current status ==
-* Targeted release: 0.90
+* Targeted release: 0.96
-* Last updated: 08.10.2010
+* Last updated: 01.12.2012
-* Percentage of completion: 50%
+* Percentage of completion: 100%
+:[http://lists.sugarlabs.org/archive/sugar-devel/2012-January/035218.html patch to widgets.py]
+:[http://lists.sugarlabs.org/archive/sugar-devel/2012-January/035217.html new icon]
+* [http://www.mail-archive.com/sugar-devel@lists.sugarlabs.org/msg24814.html review thread]
 == Detailed Description ==
-Old Description: The Naming Alert is loved by some and despised by others. This enhancement makes it be available on demand from the <strike>activity toolbar</strike> Frame instead of automatically imposed when closing an activity. The goal is to encourage more writing and reflection throughout the activity, not just at the end.
+'''Old Description:''' The Naming Alert is loved by some and despised by others. This enhancement makes it be available on demand from the <strike>activity toolbar</strike> Frame instead of automatically imposed when closing an activity. The goal is to encourage more writing and reflection throughout the activity, not just at the end.
-New Description: The Naming Alert is loved by some and despised by others. This enhancement replaces it with a mechanism whereby notes can be added to the description field on demand from within an activity. Note that the only other user-midifiable fields in the Extended View of a Journal entry are Title, Tags, and Star (Favorite). The title has a mechanism for changing it in the toolbar already. There is a separate [[proposal for modifying tags]]. By using the same mechanism as the Alerts, it is non-modal and doesn't interfere with the action of the activity itself. The goal remains to encourage more writing and reflection throughout the activity, not just at the end.
+'''New Description:''' The Naming Alert is loved by some and despised by others. This enhancement replaces it with a mechanism whereby notes can be added to the description field on demand from within an activity. Note that the only other user-midifiable fields in the Extended View of a Journal entry are Title, Tags, and Star (Favorite). (Note that the title has a mechanism for changing it in the toolbar already.) There is a separate [[proposal for modifying tags]]. By using the same mechanism as the Alerts, it is non-modal and doesn't interfere with the action of the activity itself. The goal remains to encourage more writing and reflection throughout the activity, not just at the end.
 [[Image:Write_to_Journal_Alert.png]]
@@ Line 27: / Line 29: @@
 The open questions in my mind are:
-* How is this alert evoked? A dedicated icon (See above) on the Activity toolbar (replacing for example the spot taken by the deprecated Keep button)? or a dedicated key on the keyboard (perhaps the unused Bulletin Board key)? or some other mechanism?
+* How is this alert evoked? A dedicated icon (See above) on the Activity toolbar (replacing for example the spot taken by the deprecated Keep button)? or a dedicated key on the keyboard (perhaps the unused Bulletin Board key)? or some other mechanism (such as always appearing when the Activity toolbar is opened)?
 * Should it be the entire entry or just a text field for augmenting the entry?
 * Should it be folded into activity.py for all activities or just a mechanism reserved for activity authors who want this feature?
 * Should it be optional and/or the default behavior?
+* Should there be a separate mechanism for jumping to the Journal entry of an activity? (Again, a possible use of the Bulliten Board key).
+Simon's alternative to the Alert mechanism is shown below:
+[[File:Description.png|300px]]
+We had a productive [[Talk:Features/Write_to_journal_anytime#Log_from_Design_Team_Meeting_08_January_2012|discussion]] that has led to a mashup of the various mock-ups above. New sketches will be available shortly.
+First pass re the above discussion (modification of activity/widget.py):
+[[File:Write_to_Journal_Palette.png|300px]]
+Here is the the text-view version, which shows the entirety of the description field.
+[[File:Write_to_Journal_Text_View.png|300px]]
+===Considerations for 0.98 and beyond===
+Why not add a Write to Journal for taking notes (from the Sugar Frame) as a general utility above and beyond the activity-specific notes???
+I imagine a future Sugar having the ability to map the location of the pointer with a software component (much like right clicking in Etoys, or the picker in [http://live.gnome.org/GnomeShell/LookingGlass GNOME 3 Looking Glass]) and then having a data model and code to link learner annotations to any active Activity or visible software element.  (Container objects could reveal subobjects or respond to subsequent requests.)  A 'show annotations' gesture or control would reveal the appropriate content visibly and logically tied to the current view.  --[[User:FGrose|FGrose]] 17:18, 24 January 2012 (EST)
 == Benefit to Sugar ==
@@ Line 41: / Line 64: @@
 </strike>
+<strike>
 I decided to implement this by adding write to Journal as a menu option to the activity's Frame instance in the shell. This will mean that we need no modifications to the toolbar, but it also means we need to find a way to notify the shell of the activities's object_id, since currently the shell only tracks activity_ids.
+</strike>
 == How To Test ==
@@ Line 59: / Line 84: @@
 == Release Notes ==
-[[Image:Write-to-journal-0.90.png]]
+[[File:Write to Journal Text View.png|300px]]
+The Write-to-Journal-Anytime feature facilitates the process of writing notes and making reflections upon the work being conducted in an activity, while the activity is open. A new icon on the Activity Toolbar brings up a palette used to edit the activity Description Field. These notes are stored to the activity metadata, subsequently available for editing and viewing in the Journal and the Portfolio activity.
 == Comments and Discussion ==
 * See [[{{TALKPAGENAME}}|discussion tab for this feature]]