Context Navigation

Last modified 16 years ago Last modified on 03/07/09 15:41:59

Error: Macro BackLinksMenu(None) failed

compressed data is corrupt

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

Analysis

Overview

The Global specification provides artifacts that can produce useful specification and are very helpful for the analysis and user documentation.

Task requirements

Implement this task after (or in parallel with) GLOBAL_SPEC_STRUCTURE_R2
Define global requirements for the different types of elements (flaps, tabs, palettes). Choose where to put them. Collect and fill them in. See implementation idea.
Fill in the information in the structure created in GLOBAL_SPEC_STRUCTURE_R2
- In the layout visuals page
- In the page elements visuals page
- In the Drag and drop table

Take the prototypes for these from the current specification artifacts listed in GLOBAL_SPEC_STRUCTURE

For different elements, link related tickets where needed.

Task result

Filled in wiki pages. Migrated artifacts. Expanded and corrected specification where possible.

Implementation idea

Implement this task in parallel with GLOBAL_SPEC_MANAGING_R4 For the palette you can say the elements that it may contain (list, buttons, etc) and default behavior (common behavior). You can put these into the corresponding pages (visuals pages)

GLOBAL_SPEC_MANAGING_R4
GLOBAL_SPEC_STRUCTURE_R2
GLOBAL_SPEC_STRUCTURE

How to demo

Show the resulted pages.

Design

Checked that GlobalSpecification is covered and covers the artifacts

trunk/sophie2-platform/doc/specification/ files will be linked, but not added for now.
Copied the folder specification to another non repository location. Will delete moved things in order to make sure all of the information is covered.
Specification of common elements will be collected here and modified for approval. Note that common element has their own names as types. All of the other elements that do have specification pages should have one of these types.

Remove ? for filled sections.

Type

Dialog

Description

Dialogs are windows that provide non-editing functionalities (outside of book editing itself) and provide information - opening, saving, information for books, errors, etc. It is not nessesary for a dialog to be related to a specific book.

Diagram

trunk/sophie2-platform/doc/spec-diagrams/templates/TemplateDialog.odg

Mouse Behavior

Left Clicking dialog buttons triggers functionalities.
Left Clicking the Title Bar and moving the cursor moves the dialog around.
Other specific interactions may be present.

Keyboard Behavior

Clicking Tab button when a dialog is focused scrolls between dialogs controls.

Mouse + Keyboard?

Triggered by

Dialogs may be loaded automatically or by menu/keyboard shortcuts.

OS Specific?

Related tasks?

BASE_LAYOUT_R0
BASE_LAYOUT_R1?
BASE_LAYOUT_R2?
BASE_LAYOUT_R3?
APP_LAYOUT_ALTERNATIVE_R0
APP_LAYOUT_ALTERNATIVE_R1?
APP_LAYOUT_ALTERNATIVE_R2?
APP_LAYOUT_MYDOGGY_R0
APP_LAYOUT_MYDOGGY_R1
APP_LAYOUT_MYDOGGY_R2

Remove ? for filled sections.

Type

Flap

Description

The flaps hold most of Sophie’s functionality that the user can’t get at through the halos and HUDs. Each flap has tabs in it; each tab has palettes.

Diagram?

Tooltip?

Mouse Behavior

Left Clicking the inner border and dragging changes flap's width.
Left Clicking the Minimize button of a flap hides the flap.
Left Clicking the name of a hidden flap shows the flap
Left Clicking the Attach button of a flap detaches/attaches a flap.

Keyboard Behavior

Clicking Tab button when a flap is focused changes the focus to another flap.

Mouse + Keyboard?

Triggered by

Flaps are loaded automatically and cannot be closed.

OS Specific?

Related tasks?

Remove ? for filled sections.

Type

Tab

Description

Tabs are containers for palettes. A tab can contain one or more palettes. Tabs live inside flaps. The size of the tab is the same as the size of flap containing it.

Diagram?

Tooltip?

Mouse Behavior

Clicking a tab name switches to it.

Keyboard Behavior

Clicking Tab button when a tab is selected selects another tab.

Mouse + Keyboard?

Triggered by

Tabs are loaded automatically and cannot be closed.

OS Specific?

Related tasks?

Remove ? for filled sections.

Type

Halo

Description

Halos are icons that invoke HUDs. Different items in Sophie have different kinds of Halos.

Diagram?

Tooltip?

Mouse Behavior?

Left clicking a clickable halo invokes a HUD.
Left clicking and dragging a draggable halo moves halo around to perform various operations.

Keyboard Behavior?

Mouse + Keyboard?

Triggered by

Halos are showed when an element (book element) is selected. Displaying halos is relevant with what can be done with this element (book element).

Related tasks?

See specific halos.

Remove ? for filled sections.

Type

HUD

Description

HUDs are windows that provide information and control for a specific type of object.

Diagram

trunk/sophie2-platform/doc/spec-diagrams/templates/TemplateHud.odg

Tooltip?

Mouse Behavior?

Left clicking an empty area and dragging moves the HUD around.
Left clicking on fields, buttons, lists, etc. triggers various functionalities. See specific HUDs.

Keyboard Behavior?

Mouse + Keyboard?

Triggered by

HUDs are triggered by Halos.

Related tasks?

See specific HUDs.

Probably a notes section added to the templates will be useful.
The GlobalSpecification/DragNDrop table will be moved easily by using a text editor and copy/paste from the existing google spreadsheet.

Implementation

Copied the drag n drop table from http://spreadsheets.google.com/ccc?key=p-0Oq38E1aysuTs69KE68Nw to GlobalSpecification/DragNDrop
- Filled in blank spaces with
```
?
```

, selected, copied and pasted in Notepad++. Replaced " " with

||

. Replaced

^(.*)$

with

||\1||

Moved all of the artifact where needed. Still needs work, but timebox is exceeded.

Testing

^{(Place the testing results here.)}

Comments

Please, do not forget the R2 revision of this task during the next iteration. --kyli@2009-02-20

Download in other formats:

Plain Text