Docstoc

WordPad

Document Sample
WordPad Powered By Docstoc
					   WordPad Text Editor


Software Functional Requirements and
     User Interface Specification

           September, 1999
1 Introduction
The purpose of this document is to define the software functional requirements and the user interface for the
WordPad text editor. WordPad shall be a simple text editor meant for non-expert users in the Windows 95 and NT
environments. WordPad should provide easily usable functions for creating, editing, and printing text documents.

This specification shall be used as a baseline for the design of WordPad as well as for the verification of the
functionality of the final product. This document is intended for review by the following people:
            potential customers
            software managers
            software developers
            quality assurance managers
            quality assurance testers


2 Hardware Requirements
WordPad should work on any standard PC capable of running Windows 95 or Windows NT. WordPad should not
require more than 2 MB of hard disk space, and its memory consumption should mainly depend on the size of the
edited document. WordPad should work with any printer compatible with the Windows environment.

3 Software Interfaces
WordPad should be able to interact with the Windows clipboard so that text (as well as “objects”) can be cut/pasted
to/from the clipboard. WordPad should be able to read/save documents in the following formats: ASCII text, Word
6.0, and RTF.

4 Product Functions
In general, WordPad should not under any circumstances crash nor get stuck in an infinite loop. It should display
meaningful and understandable error messages in exceptional situations. The overall performance of WordPad
should be feasible with documents smaller than 1MB (i.e., opening a document of that size should not last more than
30 seconds with a 160MHz PC).

In the following, an overview of the functional requirements for WordPad is given. If a particular requirement is
directly related to a specific user interface component, the number of the picture describing that component is also
given. Note also, that not all of the detailed functional requirements of WordPad are textually described, and the user
interface pictures at chapter 5 should be referred to as more detailed descriptions are needed.

4.1    Creating a New Document

WordPad should be able to create new documents. When creating a new document, WordPad should ask the type of
the document (see ”Software Interfaces”). After issuing the ”create new document” function, a new empty document
should appear and be ready for editing. WordPad shall only be able to handle one open document at a time.

If the user has not saved her previous file, the user should be prompted to save her work.

A user interface component related to this requirement is represented in picture 5.8.

4.2    Opening a Document

Opening an existing document should be done using the standard Windows file dialog. In the dialog, it should be
possible to filter the viewed files according to the file types WordPad recognizes (see ”Software Interfaces”). The
user should also be able to view all the files. After selecting the file to be opened, the contents of the file should



                                                          2
appear to the user and the user should be able to edit the opened document.

If the user has not saved her previous file, the user should be prompted to save her work before opening a new
document.

A user interface component related to this requirement is represented in picture 5.9.

4.3       Saving a Document

WordPad should be capable of saving a document in various formats (see ”Software Interfaces”). There should be a
”save” function for saving the document with its given name and a separate ”save as” function for saving the
document under a different name (and different type, if required). If the user issues the ”save” before she has given a
name for the document, the ”save as” dialog should be automatically displayed. The ”save as” dialog should be
implemented as the standard Windows file dialog, thus enabling the user to determine the name, location, and type
of the saved document.

A user interface component related to this requirement is represented in picture 5.10.

4.4       Printing a Document

It should be easy to print the open document from within WordPad.

WordPad should offer a ”print preview” functionality, so that the layout of the document can be properly checked
before printing. The ”print preview” function must include a zoom mechanism.

Via WordPad, the user should be able to choose the printer and set its printing options.

User interface components related to this requirement are represented in pictures 5.11, 5.12, and 5.13.

4.5       Exiting from WordPad

When exiting WordPad, the program should check that the user has saved her work. If this is not the case, the user
should be prompted to save her work.

4.6       Editing Text

The user should be able to edit her document by using the keyboard in a normal typewriter style. In addition, the
following tasks should be possible:
          inserting text in an arbitrary cursor position (not inside linked ”objects” though)
          moving the cursor to the beginning of line, end of line, beginning of document, and end of document with a
           single keystroke
          overwriting text
          selecting any number succeeding characters/”objects” in the document
          cutting/pasting selected text/”objects” into the clipboard and back into the document
          deleting selected text/”objects”
          ”automatically” inserting the current date/time to the document
          inserting/linking an arbitrary Windows ”object” into the document
          undoing (canceling) the last edit

User interface components related to this requirement are represented in pictures 5.14 and 5.25.
4.7       Finding and Replacing Text

WordPad should provide simple ”find” and ”replace” dialogs that enable both case sensitive and insensitive text
matching. It should also be possible to match only whole words (not just partial strings). Both ”find” and ”replace”
functions should enable the user to search all the instances of the matched text, one by one, until the end of the
document is reached. Using the ”replace” dialog it should be possible to replace just the previously found instance of
the matched text or all the instances at once.


                                                           3
User interface components related to this requirement are represented in pictures 5.15 and 5.16.

4.8    Setting General Options
User interface components related to this requirement are represented in pictures 5.19 – 5.24.
4.9    Formatting Text

The following settings for formatting text should be available in WordPad: text font, font style, font size, and font
color. It should also be possible to make bulleted lists and set paragraph indentation, paragraph alignment and tab
stops.
A user interface component related to this requirement is represented in picture 5.27, 5.28, 5.29.
4.10 Formatting the Document

A user interface component related to this requirement is represented in picture 5.13.

4.11 Online help

WordPad should offer a standard Windows online help.

A user interface component related to this requirement is represented in picture 5.30.

5 The User Interface
The layout and functionality of the user interface of WordPad should follow the standards set by the Microsoft
software products running on Windows 95/NT.

The main component of the user interface of WordPad is Edit area in which documents are mainly viewed and
edited (see picture 5.1). Optionally, the user should be able to view the following additional components: Toolbar,
Ruler, and Status Bar. Toolbar is used to invoke frequently used operations, Ruler displays the document tabs and
page margins, and Status bar offers context sensitive help for menu choices and reports about currently executed
tasks (e.g., printing).




Picture 5.1: The User Interface of WordPad



In any window, dialog or menu, WordPad should disable all the functions (buttons, menu items, etc.) that are not
relevant at the time (or whose use could even cause failures in the program execution).

It should be possible to use WordPad by only utilizing the keyboard.




                                                           4
5.1    The User Interface Menus

All the functions of WordPad (described in chapter 4) should be accessible via the menus on the main menu bar. The
following pictures describe the contents and layout for the menu items of WordPad. The numbers in the description
texts refer to the corresponding functional requirements in this document. The dialogs and other windows referred to
in the description texts are described in chapter 5.2.



                                            New displays the New dialog (func. req. 4.1).
                                            Open displays the Open dialog (4.2).
                                            Save saves the file in the active window (4.3).
                                            Save As opens the Save As dialog (4.3).
                                            Print opens the Print dialog (4.4).
                                            Print Preview opens the Print Preview dialog (4.4).
                                            Page Setup opens the Page Setup dialog (4.10).
                                            Most recent files opened.


                                            Exit closes WordPad (4.5).




Picture 5.2: The File menu




                                Undo backs out of the most recent change you have made in the editor (4.6).
                                Cut deletes the selected text and copies it to the clipboard (4.6).
                                Copy copies the selected text to the clipboard (4.6).
                                Paste inserts text you have cut or copied to the clipboard into the active window at
                                the current insertion point (4.6).
                                Paste Special opens the Paste Special dialog (4.6).
                                Clear erases the selected text (4.6).
                                Select All selects all text from the active window (4.6).
                                Find opens the Find dialog (4.7).
                                Find Next repeats the last find operation (4.7).
                                Replace opens the Replace dialog (4.7).
                                Links opens the Links dialog.
                                Object Properties opens the WordPad document properties dialog.
                                Object activates an embedded or linked object.


Picture 5.3: The Edit menu




                                                         5
                   Toolbar shows/hides the Toolbar.
                   Format Bar shows/hides the Format Bar.
                   Ruler shows/hides the Ruler.
                   Status Bar shows/hides the Status Bar.
                   Options opens the Options dialog (4.8).

Picture 5.4: The View menu



                        Date and Time opens the Date and Time dialog (4.6).
                        Object opens the Insert Object dialog.

Picture 5.5: The Insert menu



                   Font opens the Font dialog (4.9).
                   Bullet Style inserts a bullet into the selected line (4.9).
                   Paragraph opens the Paragraph dialog (4.9).
                   Tabs opens the tabs dialog (4.9).

Picture 5.6: The Format menu




                      Help Topics opens the Help dialog (4.11).
                      About WordPad opens the About dialog (4.11).


Picture 5.7: The Help menu


5.2    Dialogs and Other Windows
The following pictures describe the contents and layout of the dialogs and other windows of WordPad. The numbers
at the end of the picture descriptions refer to the corresponding functional requirement in this document. It should be
specially noted that the dialogs used for executing some operation should include a ”Cancel” button for canceling
the action.




                                                            6
Picture 5.8: The New dialog (func. req. 4.1)




Picture 5.9: The Open dialog (4.2)




Picture 5.10: The Save As dialog (4.3)



                                               7
Picture 5.11: The Print dialog (4.4)




Picture 5.12: The Print Preview window (4.4)




                                               8
Picture 5.13: The Page Setup dialog (4.4, 4.10)




Picture 5.14: The Paste Special dialog (4.6)




                                                  9
Picture 5.15: The Find dialog (4.7)




Picture 5.16: Replace dialog (4.7)




Picture 5.17: The General tab in the Document Properties dialog




                                                       10
Picture 5.18: The View tab in the Document Properties dialog




Picture 5.19: The Options tab in the Options dialog (4.8)




                                                            11
Picture 5.20: The Text tab in the Options dialog (4.8)




Picture 5.21: The Rich Text tab in the Options dialog (4.8)




Picture 5.22: The Word 6 tab in the Options dialog (4.8)




                                                           12
Picture 5.23: The Write tab in the Options dialog (4.8)




Picture 5.24: The Embedded tab in the Options dialog (4.8)




Picture 5.25: The Date and Time dialog (4.6)




                                                          13
Picture 5.26: The Insert Object dialog (4.6)




Picture 5.27: The Font dialog (4.9)




                                               14
Picture 5.28: The Paragraph dialog (4.9)




Picture 5.29: The Tabs dialog (4.9)




                                           15
Picture 5.30: The Help Topics window (4.11)




Picture 5.31: The About WordPad dialog (4.11)




                                                16

				
DOCUMENT INFO
Shared By:
Categories:
Tags:
Stats:
views:15
posted:12/10/2011
language:English
pages:16