Changes between Version 4 and Version 5 of SOPHIE2_BOOK_FORMAT_R1


Ignore:
Timestamp:
10/27/09 16:14:11 (16 years ago)
Author:
mira
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • SOPHIE2_BOOK_FORMAT_R1

    v4 v5  
    1717The result of this task must be source code and wiki pages for the required documentations. 
    1818== Implementation idea == 
    19  * There were three options for the file format 
    20   * 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. 
    21   * 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. 
    22   * And the third is something between the previous two.  
    23  * After the discussion with some of the team members, the following decisions for the file format were proposed: 
    24   * .sfb extension for the books 
    25   * .sfe extension for the extras (annotations) 
    26   * .sfp extension for the published books 
    27   * .sfr extension for the resources (frames, pages, etc.) 
    28  * The final decision should be after a discussion with Milo (Dan also could have some ideas on that). 
    29  * It is recommended to do the documentation in the design phase of the task. 
     19The file format extension should be composed by two parts: 
     20 * The first should be the type of the persisted resource ".book" or ".page"... 
     21 * The second and more generic is going to be ".s2". It is going to indicate that this file is a persisted sophie resource. 
    3022 
    3123== Related == 
    … …  
    3830 * Show the wiki pages with the documentation. 
    3931= Design = 
    40 ^(Describe your design here.)^ 
    4132 
     33 * A wiki page should be created for the description of the sophie file format and model. [[BR]] 
     34 * The design of the persistence in sophie 2 should be described in the design part of the [wiki:GROUP_FILE_ACCESSES_PERSISTENCE_R0]. [[BR]] 
     35 * Related to the file extension: [[BR]] 
     36  * The file extension for book should be made ".book.s2" and for anotation set ".anno.s2". Change the file filters that are used for naming and by the file dialogs for books and anotations. [[BR]] 
     37  * Change the way FileExtensionFilter accepts files not to look for the last extention. [[BR]] 
     38  * Change the FileLocator`s getTopRef() method so that it does not look for a certain file extension but openes the first file in the given path. [[BR]] 
    4239= Implementation = 
    43 ^(Describe and link the implementation results here (from the wiki or the repository).)^ 
     40  Implementation is done according to the design. [7798] 
     41The design of [wiki:GROUP_FILE_ACCESSES_PERSISTENCE_R0] has been finished. 
     42  The wiki page for the sophie file format is [wiki:SophieFormat] 
    4443 
    4544= Testing =