wiki:GROUP_HELP_R1

Version 22 (modified by deyan, 16 years ago) (diff)

--

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

Error: Macro TicketQuery(summary=GROUP_HELP_R1, 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

Add tooltips for most of the existing controls and elements.

Task requirements

  • Create a convention for the tooltips (How should a tooltip look, punctioation marks, etc.)
  • Create a list of ALL needed tooltips for the application
    • Existing
    • Nonexisting
    • Layout elements
      • Flaps
        • Flap controls
      • Tabs
      • Palettes
      • Tabs in opened books tabbar
      • App window buttons
      • Book window controls
      • Menu items
      • Halos
      • Hud controls
    • Book elements
      • Frames
      • Frame borders
      • Page work area
  • Make the tooltips easily accesible and editable (in a file for example)
    • See if they are in skin

Task result

Convention, list of tooltips, code.

Implementation idea

http://wayfarerweb.com/wtooltip.php

ElementExisting tooltipNew tooltip
Open Menu ItemOpen existing book.Open existing book

GROUP_APP_HELP_R0

How to demo

Show the convention and the new tooltips.

Design

Convention

Every tooltip is a sentence that doesn't have a period at the end of a sentence. If there is a shortcut connected with this action, it should be written in parentheses.

Tooltips

File File Menu File Menu (Alt-F)
New Book Create a new book. Create a new book
Open Book... Open an existing book. Open an existing book
Close ? Close the current book
Save Save the current book to a file. Save the changes made to the current book
Save As... Save the current book to another file. Save the current book to a file
Save As Template Save the current book as a template. Save the current book as a template
Export Book As ? Save the book As a non-Sophie file format
PDF... ? Save the book As an Adobe Portable Document Format losing some of the content
HTML... ? Save the book As a Web Page losing some of the content
Print... ? Print a page or the whole book to paper
Book Properties... ? View or edit current book's title and dimensions
Quit ? Exit Sophie 2
Edit Edit Menu Edit Menu (Alt-E)
Undo ? Discard the last change
Redo ? Repeat the last discarded change
Cut ? Move the selected element to another location by pasting
Copy ? Copy the selected element to another location by pasting
Paste ? Put the last copied/cut element to selected location
Delete ? Remove the selected element from it's current location
Insert Insert Menu Insert Menu (Alt-E)
Text ? Add an empty text frame to the current page
Image... ? Add an image file to the current page
Audio... ? Add an audio file to the current page
Audio Record... ? Record an audio file and add it to the current page
Video... ? Add a video file to the current page
Book... ? Add a whole book to the current page
PDF... ? Add a PDF document to the current page
HTML... ? Add a Web page to the current page
Plain text... ? Add a text file to the current page
Browser ? Add an interactive web page browser to the current page
Script ? Create an empty script file that can control Sophie
Script file... ? Insert a script that can control Sophie
View View Menu View Menu (Alt-V)
Normal mode ? Switch the view back to a normal window
Full screen mode ? View the application on the whole screen for more convinient work
Skins Skins Menu Skins Menu (Alt-S)
Window Window Menu Window Menu (Alt-W)
Cascade ? Stack book windows so that each window title bar is visible
Tile ? Arrange book windows so they are shown side by side
Book Window Item ? Book Title
Help Help Menu Help Menu (Alt-H)
Help Contents ? Display main help index
Send an Error Report ? Report problems related to application use
About ? Show version and licence information

Flaps

Left ? Browse, download, preview books
Right ? Edit books, templates
Bottom ? View and edit timelines

Tabs

Books ? Lists opened and embedded books
Pages ? Shows thumbnails of pages of the current book and gives opportunity to navigate between pages
Tools ? Provides alternative navigation ways such as search
Config ? Application setup and configuration
Servers ? List of available servers and connectivity options
Resources ? Used and not used contents of the current book
Changes ? History of the actions performed to the current book
Library ? Lists existing templates for creating frames, pages and books with properties given in advance
Book Extras ? Shows content that is not part of the book such as annotations, highlights and other external content related to the book
Styles ?
Timelines ? Shows interactivity controls

Book content

Implementation

(Describe and link the implementation results here (from the wiki or the repository).)

Testing

(Place the testing results here.)

Comments

(Write comments for this or later revisions here.)

Attachments