8,288
edits
Changes
Jump to navigation
Jump to search
mLine 1:
Line 1: − + − + Line 12:
Line 12: − + − + − You may now share Journal entries with another learner using a USB drive or SD card. The user experience is: Martin wants to give a picture he has been drawing to Simon. He plugs in his USB drive and copies the Journal entry on the drive. Simon plugs in Martin's drive in his laptop. The entry will be shown with Martin's XO color on the drive. Simon copies Martin's entry into his Journal.+ + + + + − You can use this feature to backup Journal entries to a USB drive or SD card.+ − + − + Line 37:
Line 41: − + Line 43:
Line 47: − + Line 49:
Line 53: + Line 57:
Line 62: − + + + + + + + + + + +
Features/Journal Entry Sharing (view source)
Revision as of 15:06, 22 November 2011
, 15:06, 22 November 2011category sort
<noinclude>{{TOCright}}
<noinclude>
[[Category:Feature Page Incomplete]]
[[Category:Feature Page Incomplete]]
[[Category:Feature|<Feature Name>]]
[[Category:Feature|Journal Entry Sharing]]
</noinclude>
</noinclude>
== Current status ==
== Current status ==
* Targeted release: 0.92
* Targeted release: 0.92
* Last updated: 07.02.11
* Last updated: 07.03.11
* Percentage of completion: 90%
* Percentage of completion: 100% (landed in 0.92)
== Detailed Description ==
== Detailed Description ==
A Journal entry contains metadata (e.g. description, title, tags, color) and optionally a preview. Furthermore an entry contains a data file in most of the cases. For example a .odt file in Write. Another example is an entry of a Memorize Game that has no file associated with it, only the metadata and a preview (there is no state saved).
In 0.82 when you copied a Journal entry to a storage device (e.g. USB) the files where stored in the root directory of the device and the metadata and preview was stored in a hidden folder called .olpc.store. You could then go to another machine and copy those entries over or use the stick as backup and copy back the entries to your Journal later. The entries on the device did have the color of the creator of the entries. Other files on the stick were shown in black and white.
The datastore has changed significantly from 0.82 to 0.84 and therefore the old entries are not handled by the new datastore. Furthermore the copying to a storage device using the 0.84 datastore did only copy the data file over and the metadata and preview were omitted.
The implementation will be described below:
=== Sharing/Backup Journal entries using a storage device===
=== Sharing/Backup Journal entries using a storage device===
The new code will store the metadata and preview in a hidden folder like in 0.82. The folder will be named ''.Sugar_metadata''. There will be two files per entry, one for the metadata named ''filename''.metadata and one for the preview (if exists) named ''filename''.preview. The data files will be stored in the root folder of the device. Like in 0.82 the entries will be colored in the creator's color.
The new code will store the metadata and preview in a hidden folder like in 0.82. The folder will be named ''.Sugar_metadata''. There will be two files per entry, one for the metadata named ''filename''.metadata and one for the preview (if exists) named ''filename''.preview. The data files will be stored in the root folder of the device. User experience: When the user views the content of a mass storage device Journal entries that have been copied to the device will be shown in the color of the creator (same behavior as with 0.82).
Note: Entries that do not contain a data file can not be copied to a storage device anymore in 0.84 (this was possible in 0.82), an alert is displayed to the learner in those cases. This change has been independent of these patches.
Note: In 0.84 entries that do not contain a data file can not be copied to a storage device anymore (this was possible in 0.82), an alert is displayed to the learner in those cases. This change has been independent of these patches.
The code is written defensive. If the metadata/preview is corrupted or has been removed it will be skipped, so the deletion of a data file on the device is handled gracefully.
The code is written defensive. If the metadata/preview is corrupted or has been removed it will be skipped, so the deletion of a data file on the device is handled gracefully.
== Benefit to Sugar ==
== Benefit to Sugar ==
A functionality which was present in 0.82 will be restored. You are able to share Journal entries with another learner using a USB drive or SD card. You can use this feature to backup Journal entries to a USB drive or SD card. Furthermore you will be able to read entries that have been saved in 0.82 to a USB drive.
== Scope ==
== Scope ==
==UI Design==
==UI Design==
[[File:Journal_Entries.png|thumb|none|800px|The view of a storage device containing Journal entries of two different users.]]
== How To Test ==
== How To Test ==
== User Experience ==
== User Experience ==
Martin wants to give a picture he has been drawing to Simon. He plugs in his USB drive and copies the Journal entry on the drive. Simon plugs in Martin's drive in his laptop. The entry will be shown with Martin's XO color on the drive. Simon copies Martin's entry into his Journal.
== Dependencies ==
== Dependencies ==
== Documentation ==
== Documentation ==
http://wiki.laptop.org/go/Release_notes/10.1.3#Sharing.2FBackup_Journal_entries_using_a_mass_storage_device
* [http://wiki.laptop.org/go/Journal_Entries OLPC documentation]
* [http://wiki.laptop.org/go/Release_notes/10.1.3#Sharing.2FBackup_Journal_entries_using_a_mass_storage_device OLPC 10.1.3 release notes]
* [http://bugs.sugarlabs.org/ticket/1636 Discussion about the issue on the SL tracker]
Patches for the current master:
* http://bugs.sugarlabs.org/attachment/ticket/1636/0001-Journal-entry-sharing.patch
* http://bugs.sugarlabs.org/attachment/ticket/1636/0001-Convert-Journal-entries-that-have-been-saved-to-a-st.patch
These are the 0.84 patches that went into [http://wiki.laptop.org/go/Release_notes/10.1.3 10.1.3]:
* Sharing/Backup Journal entries using a storage device: [http://dev.laptop.org/ticket/9657 9657]
* Convert Journal entries that have been saved to a storage device in 0.82: [http://dev.laptop.org/ticket/9658 9658]
== Release Notes ==
== Release Notes ==
You may now share Journal entries with another learner using a USB drive or SD card. The user experience is: Martin wants to give a picture he has been drawing to Simon. He plugs in his USB drive and copies the Journal entry on the drive. Simon plugs in Martin's drive in his laptop. The entry will be shown with Martin's XO color on the drive. Simon copies Martin's entry into his Journal.
You can use this feature to backup Journal entries to a USB drive or SD card.
== Comments and Discussion ==
== Comments and Discussion ==
* See [[{{TALKPAGENAME}}|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. -->
* See [[{{TALKPAGENAME}}|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. -->