View source for Taxonomy of Dialog Prompts

You do not have permission to edit this page, for the following reasons:
The action you have requested is limited to users in one of the groups: Autoconfirmed users, emailconfirmed, editors.
You must confirm your email address before editing pages. Please set and validate your email address through your user preferences.
You can view and copy the source of this page:
[[Category:Extending EiffelStudio]]
[[Category:EiffelStudio User Interface Guidelines]]

Having trouble deciding which of the [[Using Dialog Prompts (Advanced)#Introducing Dialog Prompt Classes|common dialog prompts]] to use or if you should use a [[Using Dialog Prompts (Advanced Discardable)#Introducing Dialog Prompt Classes|common discardable dialog prompt]]?

== What Are You Trying To Say? ==
Choosing the right dialog prompt for the situation is harder than it might seem. Choosing the right type of dialog prompt is crucial to the end-user's understanding of the situation. On top of all that there's the buttons the dialog prompts should offer as options, what the dialog prompt should actually say and how it should say it. These are all required factors in choosing a dialog prompt and it can be done incorrectly.

== Choosing a Type ==
The first step is to actually decided on the type of dialog to display to the user. This is actually, sometimes the most erroneous step. The following sections describe the different styles of common dialog prompts and a brief outline on how they should be used. Each description also contains the standard available buttons, which should help you in the final decision.

=== Error Prompts ===
Errors dialog prompts are the most critical of prompts. Generally they indicate an error has occurred and the regular/expected course of action was not/cannot be taken. For instance, if an attempt to save a file does not succeed it's an error because the file could not be saved. 

[[Image:Dialog_prompts_error.png|Error dialog prompt]] [[Image:Dialog_prompts_error_abort.png|Error dialog prompt with Abort, Retry and Ignore buttons]]


Generally error prompts show show a single '''Ok''' button or '''Abort'''|'''Retry'''|'''Cancel''' button. These are not buttons that are set in stone. In the example given regarding saving of files, it might be required to have '''Retry Save'''|'''Dismiss''' buttons.

=== Warning Prompts ===
Warning dialog prompts are just that, warnings. It is easy to consider an error as actually being an warning, which has been done in EiffelStudio. However, warnings are very different from [[#Error Prompts|error dialog prompt]]. A warning dialog prompt should indicate that that something unexpected happened but an alternative course of action was taken automatically, with the course not the best course. Alternatively a warning can be shown to alert the user that what they are about to do may be dangerous, and so they will have to confirm to proceed with the action.

[[Image:Dialog_prompts_warning.png|Warning dialog prompt]] [[Image:Dialog_prompts_warning_cancel.png|Warning dialog prompt with a cancel button]]


Generally warnings prompts should show a single '''Ok''' button or '''Ok'''|'''Cancel'''

Use of the additional '''Cancel''' button is warranted when asking the user to continue with a potentially dangerous operation, where '''Ok''' will proceed and '''Cancel''' will return without performing the operation.

=== Informative Prompts ===
From time to time you may want to show the user some information in response to an action requesting it, or display information when a long process/action has completed. Be careful when using informative dialog prompts, too many, too often will harass and annoy the end-user.

[[Image:Dialog_prompts_information.png|Informative dialog prompt]]


Informative dialog prompts should only show a single '''Ok''' button, except for special circumstances.

=== Question prompts ===

Question (as known as Confirmation) dialog prompts offer the user a choice, proposed with a question which has a ''yes'' or ''no'' answer. Question dialog prompts can easily be used instead of [[#Warning Prompts|warning dialog prompts]] so they require careful consideration. You need to ask if any course of action taken from the a selection made in the dialog prompt is dangerous or possibly time consuming in anyway. If so then a [[#Warning Prompts|warning dialog prompt]] should be used.

[[Image:Dialog_prompts_question.png|Question dialog prompt]] [[Image:Dialog_prompts_question_cancel.png|Question dialog prompt with a cancel button]]


Generally question prompts should only show '''Yes'''|'''No''' buttons or '''Yes'''|'''No'''|'''Cancel''' buttons.

Use of the additional '''Cancel''' button is warranted when a situation arises where the end-user may not want to do either. Such a case is when exiting EiffelStudio when there are unsaved changes. '''Yes''' will save the changes and exit, '''No''' will discard the changes and exit, and finally '''Cancel''' will no save the changes and will ''not'' exit, allowing the end-user to review their changes.

== Showing the Correct Text ==
The text formatting of dialog prompts is another subject that is incorrectly used. Generally this happens between using [[#Warnings Prompts|warning]] and [[#Warnings Prompts|question dialog prompts]], because the dialog prompts are used incorrectly.

Given the subject is more involved that just simple declarations based on the dialog prompts used, please refer to [[Dialog Prompt Text and Messages]].

== Setting Default Actions ==
If you have read through [[Using Dialog Prompts (Advanced)]] you'll know about setting default buttons on dialog prompts. If you have read [[Using Dialog Prompts (Basic)]] it does not mention default buttons because they default buttons are set automatically. You should be aware of the [[Using Dialog Prompts (Advanced)#Setting Default Buttons|default buttons]] even when using the [[Using Dialog Prompts (Basic)|basic method]] of showing dialog prompts because the automatically set default buttons should affect how you word your dialog prompts.

== Choosing Basic Vs. Advanced Dialog Prompts ==
If you have already decided that a discardable dialog is what you require when you only have the option to use the [[Using Dialog Prompts (Advanced Discardable)|advanced methods] of instantiating and showing a dialog prompt. However if it's a simple common dialog prompt then you can choose to use the [[Using Dialog Prompts (Basic)|basic]] methods, which provide a fast a easy way to show dialog prompts or the [[Using Dialog Prompts (Advanced)|advanced]] method which is still simple and provides a lot more control.
Return to Taxonomy of Dialog Prompts.
Retrieved from "https://dev.eiffel.com/Taxonomy_of_Dialog_Prompts"
View source for Taxonomy of Dialog Prompts

Navigation

Development

Wiki

Search

Tools
