| | 1 | [[BackLinksMenu]] |
| | 2 | |
| | 3 | [[TicketQuery(summary=GROUP_EMBEDDED_BOOKS_R0, 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|)]] |
| | 4 | |
| | 5 | = Analysis = |
| | 6 | |
| | 7 | == Overview == |
| | 8 | This group of tasks is about embedded books support. A user should be able to: |
| | 9 | * Insert a book into a frame (either by dragging and dropping or by using the Insert menu). |
| | 10 | * Choose whether the inserted book should be fully embedded or just linked. |
| | 11 | * Choose how to display the embedded book - in a frame or in its own window. |
| | 12 | * Manage the resources in the embedded book (via the Resources palette). |
| | 13 | * Navigate through the embedded book (change pages, interact with resources (play audio, video, etc.)). |
| | 14 | * Modify some basic properties of the embedded book (rename, scale, delete, etc.) |
| | 15 | At this revision only a basic version of some of these features will be implemented. |
| | 16 | |
| | 17 | == Task requirements == |
| | 18 | At this iteration the following the following should be achieved: |
| | 19 | * Provide basic support for embedded books: |
| | 20 | * Define and implement embedded book frame content. |
| | 21 | * Define and implement embedded book resource. |
| | 22 | * Allow inserting of a Sophie book through the menu. |
| | 23 | * Resolve issues related to embedded book resources: |
| | 24 | * See if cyclic referencies cause problems and resolve them. |
| | 25 | * Make sure that when the embedded book is on focus, only its resources are shown in the Resource palette. |
| | 26 | * Think of other possible smells and resolve or document them. |
| | 27 | * Define interaction with the embedded books: |
| | 28 | * Add a panel for controlling the embedded books or use the existing book's bottom panel. |
| | 29 | * Allow navigating through pages in the embedded book. |
| | 30 | * Define how embedded books will be managed: |
| | 31 | * Add an embedded books palette or use the existing books palette. |
| | 32 | * Allow renaming and deleting of embedded books. |
| | 33 | * (Optional) Document things related to embedded books in a wiki page: [wiki:EMBEDDED_BOOKS] |
| | 34 | |
| | 35 | == Task result == |
| | 36 | * Source code |
| | 37 | * (Optional) Wiki page |
| | 38 | |
| | 39 | == Implementation idea == |
| | 40 | * Create classes EmbeddedBookContent and EmbeddedBookResource (similar to other frame contents and resources). |
| | 41 | * You may display the first page of a book only as a start. |
| | 42 | * Have a look at the Resource library and see how it handles cyclic dependencies. |
| | 43 | * See similar tasks in the Related section to get an idea of how things can be done. |
| | 44 | |
| | 45 | == Related == |
| | 46 | [wiki:EMBEDDED_BOOKS_CONTENT_R0] |
| | 47 | [wiki:EMBEDDED_BOOKS_RESOURCE_SUPPORT_R0] |
| | 48 | [wiki:EMBEDDED_BOOKS_MANAGING_R0] |
| | 49 | [wiki:GROUP_PDF_R0] |
| | 50 | |
| | 51 | == How to demo == |
| | 52 | * Insert a Sophie book. |
| | 53 | * Navigate through pages. |
| | 54 | * Show that resources are displayed correctly in the resource palette. |
| | 55 | * (Optional) Show the created wiki page. |
| | 56 | |
| | 57 | = Design = |
| | 58 | ^(Describe your design here.)^ |
| | 59 | |
| | 60 | = Implementation = |
| | 61 | ^(Describe and link the implementation results here (from the wiki or the repository).)^ |
| | 62 | |
| | 63 | = Testing = |
| | 64 | ^(Place the testing results here.)^ |
| | 65 | |
| | 66 | = Comments = |
| | 67 | ^(Write comments for this or later revisions here.) |
