Error: Macro BackLinksMenu(None) failed

compressed data is corrupt

Error: Macro TicketQuery(summary=SOPHIE2_BOOK_FORMAT_R1, format=table, col=summary|owner|status|type|component|priority|effort|importance, rows=description|analysis_owners|analysis_reviewers|analysis_score|design_owners|design_reviewers|design_score|implementation_owners|implementation_reviewers|implementation_score|test_owners|test_reviewers|test_score|) failed

current transaction is aborted, commands ignored until end of transaction block

Analysis

^{(Give as much as possible of the needed information for designing and implementing the task in the following sections.)}

Overview

Sophie must provide extensions for the files that are created. Documentation for the persistence and file formats must be provided.

Task requirements

• Choose appropriate extensions for the different file types of Sophie2. There are some suggestions in the implementation idea section.
• Write down documentation for the persistence.
• Write down documentation for the file format.

Task result

The result of this task must be source code and wiki pages for the required documentations.

Implementation idea

• There were three options for the file format
  • 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.
  • 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.
  • And the third is something between the previous two.
• After the discussion with some of the team members, the following decisions for the file format were proposed:
  • .sfb extension for the books
  • .sfe extension for the extras (annotations)
  • .sfp extension for the published books
  • .sfr extension for the resources (frames, pages, etc.)
• The final decision should be after a discussion with Milo (Dan also could have some ideas on that).
• It is recommended to do the documentation in the design phase of the task.

Related

BASE_PERSISTENCE_COMMONS_R0
BASE_PERSISTENCE_INTERMEDIATE_STORAGE_R0
SOPHIE2_BOOK_FORMAT_R0

How to demo

• Save and load different file types with Sophie2 (books, annotations).
• Export and import different resources from Sophie2 (frames, pages).
• Show the wiki pages with the documentation.

Design

^{(Describe your design here.)}

Implementation

^{(Describe and link the implementation results here (from the wiki or the repository).)}

Testing

^{(Place the testing results here.)}

Comments

^{(Write comments for this or later revisions here.)}