Ticket	Summary	Owner	Status	Type	Component	Priority	Effort	Importance
#1048	EMBEDDED_BOOKS_CONTENT_R0	sriggins	closed	planned_task	COMPOSITE_ELEMENTS	3	1	10
Reported by Astea, 4 years ago.
Description	wiki page: EMBEDDED_BOOKS_CONTENT_R0 - effort: 1d
Analysis_owners	sriggins
Analysis_reviewers	tanya
Analysis_score	3.5
Design_owners	boyan
Design_reviewers	meddle
Design_score	2
Imp._owners	mira
Imp._reviewers	meddle
Imp._score	0
Test_score	0

Analysis

Overview

Embedded Book content connects a book resource (in other words, a book) to a frame

• Embedded Book content is a content of a frame representing a book.
• Embedded Book resources are resources for books.
• Embedded Book resources have the same information as any other resources plus specific information about the book they are representing.
• Embedded Book content is responsible for returning the visual representation of the book
• There should be drag and drop support, so a book can be dropped onto a frame and a Embedded Book content is created automatically from them. Books are scaled if they are bigger than the frame they are dropped onto.
• There should be support for creating a frame with an Embedded Book content by choosing a book file.

Task requirements

• Define basic Embedded Book content.
• Define basic Embedded Book resource.
• Define how content works with frames to find a renderer (is this a scene?)

Task result

The result of this task should be source code.

Implementation idea

• Create class EmbeddedBookContent which is concrete implementation of org.sophie2.base.model.book.FrameContent for a book.
• EmbeddedBookContent should override mainResource() and return Prop<EmbeddedBookResource>.
• Create class EmbeddedBookResource which is concrete implementation of org.sophie2.base.model.book.resource.BookResource for book resources.
• EmbeddedBookResource should reflect methods we allow sent to a book, such as:
  • pageCount
  • currentPage
  • bookFrameSize (size of the original book)
  • posterFrame - a page of the book to use as a poser frame

• EmbeddedBookContent
  • EmbeddedBookContent is represented by an image, either the first page of the book, or the poster frame
  • EmbeddedBookContent can have a controller, but unlike a video controller, it would be more like a page status bar (next page, previous page, back)
  • Determine if any of this should be part of the content, or kept elsewhere, ie does the content have any say in how the resource is represented on screen?
  • If yes, maybe contents should have extension points that keep the list of renderers for this content (and similar for images and audio, ie any content)

Related

• UNPLANNED_BASE_MODEL_FRAME_CONTENT_R0
  
• BASE_RESOURCE_COMMONS_R0
• IMAGE_CONTENT_R0
• AUDIO_CONTENT_R0
• VIDEO_CONTENT_R0

How to demo

• Create a frame with book resource.
• Check if the resource is set correctly and check if the information about the resource is correct.
• Try changing the resource and check again the same things.

Design

Implementation

^{(Implementation results should be described and linked here (from the wiki or the repository))}

Testing

Comments

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