Changes between Version 8 and Version 9 of GROUP_EMBEDDED_BOOKS_R0

Timestamp:

03/27/09 10:54:11 (16 years ago)

Author:

boyan

Comment:

--

GROUP_EMBEDDED_BOOKS_R0

@@ -60 +60 @@
 = Design =
 
-Currently the resource library does not handle cyclic references. If this cannot be fixed, importing a book that will cause cyclic references will be disabled.
+Since embdedded books are extra content, they will be separated into a new module - org.sophie2.extra.func.embedded. This module will provide extensions and classes that are required for the embedded books functionality:
+ * EmbeddedBookContent - a class representing the content of an embedded book frame.
+ * Extensions for:
+  * a menu item in the Insert menu;
+  * a file dialog for choosing a book;
+  * a frame content provider;
+  * a frame content view provider;
+  * an embedded books palette;
+ * An R3Logic OperationDef for inserting the book.
+These are new things and their relation is shown in the following class diagram:
 
-When an EmbeddedBook frame is selected, the current book and book view should change to reflect that. This will affect the resources displayed in the Resources palette and the behaviour of the book bottom panel.
+^The diagram goes here.
 
-Renaming and deleteing of embedded books will be implemented if resource management works.
+The following things require changes to existing classes to be achieved:
 
-The embedded books will be listed in the opened books palette, below the book they are embedded in and indented to the right.
+When a frame with an embedded book is selected (i.e. the embedded book is on focus), the embedded book will become the current book of the application. Thus the page preview palette and the resources palette will display the correct corresponding information. When the frame is deselected, the parent book should become current again. This will also affect the book bottom panel - it will control the embedded book and it will contain only the Navigation and Search panels.
+
+There are some issues related to embedded books:
+ * Cyclic references - Book A embeds Book B which embeds book A. Any problems and exceptions that come up with this will be solved by changing the Resource library to handle cyclic dependencies. If that cannot be achieved in a reasonable time, embedding a book that will cause cyclic references will be disabled.
+ * Preview mode - A book that is embedded should be displayed as in Preview mode and should not be editable in place. You have to open it in its own window if you want to edit it. Currently the Preview mode is working to a quite basic extent and might need refactoring for proper displaying of embedded books.
+
+Embedded books will be displayed under the Books tab in a new palette. From there you will be able to rename and delete embedded books. This requires the Resources library to provide ability for renaming and deleting and may slow down the task if not implemented.
+
+Since this task depends on a lot of other things documenting will be done only if there is time left and after a stable design has been achieved.
 
 = Implementation =
-^(Describe and link the implementation results here (from the wiki or the repository).)^
+^Describe and link the implementation results here (from the wiki or the repository).
 
 = Testing =
-^(Place the testing results here.)^
+^Place the testing results here.
 
 = Comments =
-^(Write comments for this or later revisions here.)
+^Write comments for this or later revisions here.