Features/Comment box in journal detail view: Difference between revisions

Created page with "<noinclude> Category:Feature Page Incomplete Journal enhancement </noinclude> == Summary == This feature adds a new section to the Sugar Journal Det..."
 
Godiard (talk | contribs)
No edit summary
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<noinclude>
<noinclude>
[[Category:Feature Page Incomplete]]
[[Category:FeatureLanded|Journal enhancement]]
[[Category:Feature| Journal enhancement]]
</noinclude>
</noinclude>


Line 16: Line 15:
* Targeted release: 1.0
* Targeted release: 1.0
* Last updated: 18 Feb 2013
* Last updated: 18 Feb 2013
* Percentage of completion: 100% (pending review)
* Percentage of completion: 100% (under review)


== Detailed Description ==
== Detailed Description ==
Line 22: Line 21:


The structure itself is a json-encoded list of Python dictionaries, one for each comment, where the dictionary contains three optional entries: 'from' (the nick of the commenter); 'message' (the comment itself); and 'icon' (in the case of comments from a Sugar user, these are the user's XO colors, but they could be replaced by any Sugar icon).
The structure itself is a json-encoded list of Python dictionaries, one for each comment, where the dictionary contains three optional entries: 'from' (the nick of the commenter); 'message' (the comment itself); and 'icon' (in the case of comments from a Sugar user, these are the user's XO colors, but they could be replaced by any Sugar icon).
[{"message": "This comment feature is really cool", "from": "Walter Bender", "icon": ["#FFC169", "#FF2B34"]}]


Whenever the detail view is updated, the comments metadata is rescanned and parsed into a series of liststore entries, which are displayed in a scrollable tree view. If there are no comments, the treeview is empty.
Whenever the detail view is updated, the comments metadata is rescanned and parsed into a series of liststore entries, which are displayed in a scrollable tree view. If there are no comments, the treeview is empty.
Line 36: Line 37:


==UI Design==
==UI Design==
There are no required UI/workflow interventions due to the introduction of this feature, but it does make more clear the distinction between comments and descriptions in both the Journal and Portfolio. See [[File:FB-comments.png]]
There are no required UI/workflow interventions due to the introduction of this feature, but it does make more clear the distinction between comments and descriptions in both the Journal and Portfolio.
 
<gallery>
File:FB-comments.png|The comment box in the detail view.
File:Portfolio-comments.png|FWIW, comments in the Portfolio activity
</gallery>


== How To Test ==
== How To Test ==