diamond help article

2
5 Diamond Online Help By Linda Turnbaugh and Steve Ortiz Each person is unique in the level of information required to run Diamond applications. Sometimes, all you need know is how to fill-in a parameter. Other times, you need to know steps to perform a task. Or perhaps, you need more information to make a decision, such as whether to archive a dataset or back it up. Diamond Help has all of that and more! How Diamond Help Works Diamond Help opens in a viewer provided by Trolltech’s Qt Assistant. Like a web browser, you get a documentation window, menu bar, and toolbar. A navigation pane displays in the left window. The tool or application home page displays in the right window. Underlined text signifies hyperlinked pages. Click a key word to display the associated page in the documentation window. Getting Your Work Done Quickly Diamond Help is task oriented, and contains step-by-step procedures. It also provides a list of related tasks (What do you want to do?) that you might want to perform. Each step explains how to perform a task, and provides links to additional information, such as reference material or a screen shot showing what happens after issuing a command. To retain your location in the help document as you view associated links, right-click a link and open the related help page in a new Tab, or bookmark the page. If you prefer, open a complete task list and click one of the links to get detailed information. Visual Cues Icons highlight different types of information. Provides tips that could save you time. Warns you to prevent time-consuming mistakes. Denotes information that might be important for you to know. Multiple Methods to Access Information Information is just a mouse click away when you use the Table of Contents Index List of Related Topics Hyperlinks throughout the page Getting Started Are you wondering how to get started with Diamond? The Home page provides a high-level view of each application, a workflow showing how the applications are integrated, information about what's new in this release, and some tips for getting started. Linda Turnbaugh Steve Ortiz

Upload: haven832

Post on 23-Jun-2015

158 views

Category:

Documents


3 download

DESCRIPTION

Internal article featuring the Diamond help system.

TRANSCRIPT

Page 1: Diamond Help Article

5

Diamond Online HelpBy Linda Turnbaugh and Steve Ortiz

Each person is unique in the level of information required to run Diamond applications. Sometimes, all you need know is how to fill-in a parameter. Other times, you need to know steps to perform a task. Or perhaps, you need more information to make a decision, such as whether to archive a dataset or back it up. Diamond Help has all of that and more!

How Diamond Help WorksDiamond Help opens in a viewer provided by Trolltech’s Qt Assistant. Like a web browser, you get a documentation

window, menu bar, and toolbar. A navigation pane displays in the left window. The tool or application home page displays in the right window. Underlined text signifies hyperlinked pages. Click a key word to display the associated page in the documentation window.

Getting Your Work Done QuicklyDiamond Help is task oriented, and contains step-by-step procedures. It also provides a list of related tasks (What do you want to do?) that you might want to perform.

Each step explains how to perform a task, and provides links to additional information, such as reference material or a screen shot showing what happens after issuing a command.

To retain your location in the help document as you view associated links, right-click a link and open the related help page in a new Tab, or bookmark the page. If you prefer, open a complete task list and click one of the links to get detailed information.

Visual CuesIcons highlight different types of information. Provides tips that could save you time. Warns you to prevent time-consuming mistakes.

Denotes information that might be important for you to know.

Multiple Methods to Access InformationInformation is just a mouse click away when you use the • Table of Contents • Index • List of Related Topics • Hyperlinks throughout the page

Getting StartedAre you wondering how to get started with Diamond? The Home page provides a high-level view of each application, a workflow showing how the applications are integrated, information about what's new in this release, and some tips for getting started.

Linda Turnbaugh

Steve Ortiz

Page 2: Diamond Help Article

6

Getting Help with ToolsAre you trying to find the right tool to add to your job flow? You can choose from the alphabetical list view or you view the tools by categories.

When you find the tool, you can get detailed information about it. This information also displays when you click the Help button.

Tooltips versus ‘What's This?’ HelpTo get parameter information, hold the mouse over the parameter field until the tooltip displays information about the parameter, including minimum and maximum values.

To access ‘What's This?’ Help and get more information about the parameter, click and then click the parameter field.

Diamond Help was designed and written with you in mind.

Choose tools from an alphabetical list.

Detailed information about selected item. Choose tools from an alphabetical list or by category.

Tooltips can be accessed by holding mouse over the parameter field.

sseleabetical list o

©mipan. Image from BigStockPhoto.com

‘What’s this?’ Help