wiki:PREVIEW_MODE_R0

Version 25 (modified by dido, 16 years ago) (diff)

--

Error: Macro BackLinksMenu(None) failed
compressed data is corrupt

Error: Macro TicketQuery(summary=PREVIEW_MODE_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|) failed
current transaction is aborted, commands ignored until end of transaction block

Analysis

Overview

  • This mode shows the book as it will look like in Reader. This mode is most convenient for reading books. It allows the user to test his links, events, timelines etc.

Note: Preview mode = Test mode.

Author mode = Edit mode.

  • The user can’t edit his book in preview mode. He can only interact with it.
  • In preview mode, all links and timelines are functional.
  • Reader mode applies to current book.
  • The user can evoke preview mode window by:
    • click on preview mode button on the bottom bar
    • selecting View -> Preview Mode from the menu.
  • Preview mode window shouldn't have preview mode button and outline frames check box, also the button from the View menu is disabled.
    • Outline frames will be disable in the preview mode.
  • Frame borders will be visible if they are set so, the page borders will be visible also (all of them).
    • If some border is set to different than 0 value, it will be visible.
  • All menu items related to editing, for example the Insert menu, File->Save, should be disabled. Decide how the items will be disabled - whether each item/functionality will watch the current book previewMode option, or someone will disallow book editing. If every item will disable itself, define which are these items.
  • Tabs that allow editing are in disable mode and this should be visible for the user.
  • To exit preview mode window user have to close it.
  • Although editing is not allowed, comments and annotations (stickies, highlightings) can be created/modified/deleted.
  • Selecting objects and copying them to the clipboard is allowed.
  • Preview mode also has a presentation mode.
  • The preview mode should act as the reader do.
  • The preview mode should use the reader work area - it should not show elements outside the borders of the page.

Task requirements

  • Grate a prototype of the preview mode.
  • Update the current design.

Task result

  • The result of this task should be source code.

Implementation idea

  • Actually currently the book can edit the book using links/timelines; however, these changes should not affect the original book. This is why it is a good idea to make a copy of the book, operate on it, and this will not change the original book.
  • We should use the reader area - it will hide content outside the page borders. Note: the reader area is not working right now, so it must be implemented, too.
  • A good idea (maybe) is to move all logic about visibility in the corresponding feature - for example, huds should hide themselves, flaps, palettes also, etc. This way the bookView / readerArea does not need to know about all the visible gadgets and hide them one by one.
  • Preview mode needs performance optimizations and bugfixing - define these two problems, research for more.

How to demo

  • Run Sophie 2, Default book with 3 frames should be created. If not, create one.
  • Go to preview mode.
  • Try to move the frame or to edit its text content, to edit some palettes, to insert something or save the book - should not be possible.
  • Show the bottom flap and the timeline controls are active, if they are implemented - demonstrate them.

Design

  • Create a menu in the main menu bar called View. (class ViewMenu)
    • Title - "View"
    • Tool-tip - "View menu"
    • Mnemonic - KeyEvent.VK_V
  • Create a preview mode menu item. (class PreviewModeItem)
    • Title - "Preview mode"
    • Tool-tip - "Switch current book in preview mode."
    • Memonic - KeyEvent.VK_P
  • ViewMenu and PreivewModeItem should go in:trunk/sophie2-platform/modules/org.sophie2.main.view.menus package. The new package should be called "org.sophie2.main.view.menus.view".
    • Done - check commit before merging the release (when merging the release branch it was forgotten).
  • Disable the menus that should not be active by checking the inPreviewMode() value of the BookDocumentWindow.
    • Some menu items in File menu:
    • Most of the items in the Edit menu except for: UndoItem and RedoItem which should be available for Stickies and Comment frames only. - partially done (should fix the Undo and Redo items).
    • Whole Insert menu. InsertMenu
  • Hide HaloMenus and Frame borders, changing the computeVisible() method by checking the inPreviewMode() value of the BookDocumentWindow.
  • Create a copy of the book that should be used for preview mode. It should be computed for every BookWindow.
    • the book() method should return an AutoProperty that return either the original book or a copy of it depending on whether the BookDocumentWindow is in preview mode.
    • the original book should be set in a value property editableBook().
  • In in preview mode the scene interaction should not be included. Check the SceneInteractionLogic class for more details. It should not handle most of the input events in preview mode.

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.)