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

mNo edit summary
Godiard (talk | contribs)
No edit summary
 
(2 intermediate revisions by one other user 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.