10,502
edits
Changes
Jump to navigation
Jump to search
Line 6:
Line 6: − + Line 16:
Line 16: − + − + + + + + + + + + Line 41:
Line 49: − logging.debug(tag) −
Features/Activity specific metadata in Journal (view source)
Revision as of 19:09, 12 January 2012
, 19:09, 12 January 2012→Detailed Description
== Summary ==
== Summary ==
The idea is to record metadata related to the use of activity and display it in the detail view of the Journal.
The idea is to record metadata related to the use of an activity and display it in the detail view of the Journal.
[[File:TAtags.png]]
[[File:TAtags.png]]
== Current status ==
== Current status ==
* Targeted release: 0.96
* Targeted release: 0.96
* Last updated:
* Last updated: 2012-01-12
* Percentage of completion: 90%
* Percentage of completion: 95% (patch submitted, awaiting review)
:[http://lists.sugarlabs.org/archive/sugar-devel/2012-January/035219.html counter patch]
== Detailed Description ==
== Detailed Description ==
For 0.96, we've agreed to capture some addtional metadata to be used for assessment, but not display it by default in the Journal. Specifically, we are interested in how many times the instance of an activity has been run. This is captured in a new metadata field, 'activity count', which is incremented every time an activity is launched. This requires a small addition to widgets.py.
=== Old description ===
The Journal has a fixed set of metadata entries that are displayed in the Journal detail view for all entries, e.g., 'description', 'tags', 'preview', et al. It is proposed that we also include activity-specific metadata. For example, when assessing student work, it is of interest to teachers to know what tools a student may have used and, perhaps how many iterations a student made in creating an artifact. These data may vary from activity to activity, hence it is proposed to enhance the Journal Expanded View in a way that enables activities to specify which metadata fields would be useful to display.
The Journal has a fixed set of metadata entries that are displayed in the Journal detail view for all entries, e.g., 'description', 'tags', 'preview', et al. It is proposed that we also include activity-specific metadata. For example, when assessing student work, it is of interest to teachers to know what tools a student may have used and, perhaps how many iterations a student made in creating an artifact. These data may vary from activity to activity, hence it is proposed to enhance the Journal Expanded View in a way that enables activities to specify which metadata fields would be useful to display.
The proposed mechanism is two-fold: (1) a special metadata field, 'public' is used to list those metadata fields that should be displayed; and (2) a new text field is added to the Expanded View to display these data. In the illustration above, two fields are displayed: Iterations and Block Types. These fields were set by the Turtle Art program. Other activities may set other fields (or no fields, in which case, the new text field would not be shown.)
The proposed mechanism is two-fold: (1) a special metadata field, 'public' is used to list those metadata fields that should be displayed; and (2) a new text field is added to the Expanded View to display these data. In the illustration above, two fields are displayed: Iterations and Block Types. These fields were set by the Turtle Art program. Other activities may set other fields (or no fields, in which case, the new text field would not be shown.)
The Hippo version of the code is shown below:
<pre>
<pre>
text = ''
text = ''
for tag in activity_list:
for tag in activity_list:
text += '%s: %s\n' % (tag, str(metadata.get(tag, '')))
text += '%s: %s\n' % (tag, str(metadata.get(tag, '')))
public_data.props.buffer.props.text = text
public_data.props.buffer.props.text = text
def _create_public_data(self):
def _create_public_data(self):