Changes between Version 1 and Version 2 of SOPHIE2_BOOK_FORMAT_R1


Ignore:
Timestamp:
10/22/09 15:19:39 (16 years ago)
Author:
todor
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • SOPHIE2_BOOK_FORMAT_R1

    v1 v2  
    77 
    88== Overview == 
    9 ^(Provide a brief overview of the whole task in its first revision. Stick to the current revision of the task, but keep an eye to the whole task progress, and stay alert for possible smells.)^ 
    10  
     9Sophie must provide extensions for the files that are created. Documentation for the persistence and file formats must be provided. 
    1110== Task requirements == 
    12 ^(List the necessary requirements that the task must fulfill.)^ 
     11 * Choose appropriate extensions for the different file types of Sophie2. There are some suggestions in the implementation idea section. 
     12 * Write down documentation for the persistence. 
     13 * Write down documentation for the file format. 
    1314 
    1415== Task result == 
    15 ^(List the end product of the task (for example "Source code", "Wiki page", etc.))^ 
    16  
     16The result of this task must be source code and wiki pages for the required documentations. 
    1717== Implementation idea == 
    18 ^(Provide some rough implementation idea(s).)^ 
     18 * There were three options for the file format 
     19  * The first is to have only one extension for all things. It is easier form users' point of view, however when working with multiple resource types it could get confusing. 
     20  * The second is to have different extensions for everything (something like .book.sph, .extra.sph) this is easiest from developers' point of view, but doesn't look too good. 
     21  * And the third is something between the previous two.  
     22 * After the discussion with some of the team members, the following decisions for the file format were proposed: 
     23  * .sfb extension for the books 
     24  * .sfe extension for the extras (annotations) 
     25  * .sfp extension for the published books 
     26  * .sfr extension for the resources (frames, pages, etc.) 
     27 * It is recommended to do the documentation in the design phase of the task. 
    1928 
    2029== Related == 
    21 ^(Add links to related tasks that could be useful or helpful.)^ 
    22  
     30[wiki:BASE_PERSISTENCE_COMMONS_R0][[BR]] 
     31[wiki:BASE_PERSISTENCE_INTERMEDIATE_STORAGE_R0][[BR]] 
     32[wiki:SOPHIE2_BOOK_FORMAT_R0][[BR]] 
    2333== How to demo == 
    24 ^(Provide instructions for demonstration of the task.)^ 
    25  
     34 * Save and load different file types with Sophie2 (books, annotations). 
     35 * Export and import different resources from Sophie2 (frames, pages). 
     36 * Show the wiki pages with the documentation. 
    2637= Design = 
    2738^(Describe your design here.)^