Content Editor

The DesignGuide Developer Studio initially starts with the Content Editor. The Content Editor is the central organizational tool used to organize, register all the content, and construct the DesignGuide.

Main Menu Bar

The main menu bar is used to navigate through the Developer Studio while developing DesignGuides. Some menu items are attached to tool bar buttons for ease of use.

File Menu

New
Create a new Studio Project.

Open
Open an existing Studio Project.

Save
Save the currently opened Studio Project.

Save As. Prompts for a filename before saving the active file.
 

Delete. Delete an existing Studio Project.
 

Build
Creates the necessary directory structure inside ADS to run your DesignGuide. All registered content will be copied into this structure. Additionally the necessary files will be created to run your menus and palettes or any other objects created in the DesignGuide Studio.

Unbuild. The opposite of build. It will remove all directories and files from a previous build.

Package
Creates the xxx.deb file for your DesignGuide, copying all the design files, datsets, data display pages, and so on, to the studio_files/<project name> directory. Then all files that went into the xxx.deb file are deleted, and this file is now the archive file to be transportable and installable in ADS.

Version
Version control is an easy way to revert to previous versions of your Studio Projects. Refer to the section Version Control.

Preferences . Summons a dialog box allowing you to specify certain variables used in the build and package or your DesignGuide.
 

Recent Files. List of the most recently used Studio Projects.
 

Exit. Quits the DesignGuide Developer Studio.
Tools Menu
 

Menu Editor
Opens the Menu Editor utility.

Palette Editor
Opens the Palette Editor utility.

Tab Dialog Editor
Opens the Tab Dialog Editor utility.

Bitmap Editor
Opens the Bitmap Editor utility.

System Help Editor
Opens the System Help Editor utility.

Quick Help Editor
Opens the Quick Help Editor utility.

Note See the appropriate chapters for more details on the editors.

Reports Menu

Problem Summary.
Displays a spreadsheet of problems within the Studio Project.

Content Summary. Displays a summary from the Content Editor.

Menu Summary. Displays a summary from the Menu Editor.

Palette Summary . Displays a summary from the Palette Editor.

Dialog Summary. Displays a summary from the Dialog Editor.

Help Menu

Getting Started . Opens the Getting Started documentation.

Reference Manual. Opens the Technical Reference Manual.

Style Guide. Opens the Agilent DesignGuide Style Guide.

Tutorial. Step-by-step tutorial using the DesignGuide Studio to create our example studio project.

About DesignGuide Studio . Informative synopsis of the DesignGuide Developer Studio.

Content Browser

The Content Editor uses a hierarchal organization that simplifies the addition of content and makes viewing added content easy to see and understand. Content is viewed inside the Content Browser.

Content Hierarchy

Since the Content Browser uses a structural tree to organize the content the focus inside the browse window is very important. Where you are inside the window will change the result of pressing an Action Button. The hierarchal order is as follows:
 

  Project Name
                       Group Name
                                           Content Type
                                                                Content File
                                                                                    Dependent File

There are five different possible levels inside the Content Browser:

• Project Name . Name of the currently opened Studio Project.
• Group Name .

Content can be divided into groups at your convenience.

• Content Type . There are five different content types that can be added to a Studio Project.
  • Dataset.
    Any file inside the /data directory of an ADS project.
    
  • Design
    Any . dsn file inside the /networks directory on an ADS project.
    
  • Display
    Any . dds file inside the root directory of an ADS project.
    
  • Subnetwork
    Any .dsn file inside the /networks directory on an ADS project.
    
  • Template
    Any .dsn file inside the /networks directory on an ADS project.
    
• Content File. Added content files are listed under the Content Type of which they belong. The default object name is the file name with no extension.
• Dependent File. Any Content File may also take on Dependent Files. Dependent files must first be included as regular Content Files and then added as Dependent Files. All Dependent Files will be denoted by the icon relative to the Content Type they belong to.

Action Buttons

The Content Editor has only two action buttons. In essence, one is to add content while the other removes it. These buttons will be explained in greater detail further on in the manual.

• Add. Depending on the focus inside the Content Editor, adds content.
• Remove . Depending on the focus inside the Content Editor, removes content.

Adding Groups

1. Change the focus to be on the Project Name hierarchal level. The Add action button will change to Add New Group.
2. Click Add New Group and a new default group will appear. The focus will automatically go to the Object Name text box.
3. Change the group name.
   If you don't change the name and you try to add another group, it will prompt you to change the first group name.

Adding Content Types

1. Change the focus to be on the Group Name hierarchal level. The Add action button will change to Add Content Type .
2. Highlight the Content Type you want to add inside the window titled Content Types .
3. Click Add Content Type and this Content Type will be added to the highlighted group.

Adding Content File

1. Change the focus to be on the Content Name hierarchal level below the group you want to add files. The Add action button will change to Add Project File. The window titled Project Files will now display all the ADS projects on your hard drive.
2. Browse to the file you want to add and click on Add Project File or double-click the file itself. The file will be added to the highlighted content type in that group.

Adding Dependent Files

1. Change the focus to be on the Content File hierarchal level, specifically on the file to which you want to add dependent files. The Add action button will change to Add Dependent File . The window titled Dependent File List will now display all the content yet added to your project.

   Note A dependent file is any related file that needs to be copied along with the selected file.

   
   

2. Browse to the file you want and click Add Dependent File or double-click the file itself. The dependent file will be add to the Content File .

Removing Content

Removing content is a simple procedure.

1. Highlight any object beneath the Project Name hierarchal level inside the Content Browser.
2. You will notice that the caption on the Remove action button will change according to which object you want to remove. Click the Remove action button.
3. All objects from the selection level down the hierarchal tree will be removed.

   Note Content removed from the content editor is not deleted. Projects cannot be removed using the Remove action button. To remove a project, select File > Delete from the main menu bar.

   
   

Object Info

Object Info displays information about a Content File . Something will be displayed only when the focus is on the Content File hierarchal level. Three items are shown:

• Object Name. All of the Developer Studio Editors will use the Object Name as a reference to added content. The content file minus the extension is the default Object Name .
• Description . A Description of the added content. The Developer Studio does not use the Description for anything, but can be used to help organize studio projects. By default, the description is the Content Type.
• Path. Starting in the $HOME directory for ADS shows the Path where the source file resides.

Content Action Window

The Content Action Window dynamically changes depending on the focus inside the Content Browser. There are five states the Content Action Window can be in:

• Groups. The Content Browser focus is on the Project Name level. The Content Action Window will display a list of the added Groups.
• Content Type . The Content Browser focus is on the Group Name level. The Content Action Window will display Content Types.
• Project Files . The Content Browser focus is on the Content Type level. The Content Action Window will display a directorial list of all ADS projects in the $HOME directory.
• Dependent Files . The Content Browser focus is on the Content File level. The Content Action Window will display a list of all content in the current studio project.
• Nothing . The Content Browser focus is on the Dependent File level. The Content Action window will display nothing.

Version Control

The Version Control creates backups of your studio project files (i.e., files with the .stu extension).

Creating a New Version

1. With your studio project open, click File > Version.
2. Click New.
   A new file will appear in the Version Files list. Default information will appear for Name, Description , and Date. Any of this information may be changed to suit this version.

Restoring an Older Version

1. Have your studio project open and click File > Version .
2. Highlight the version you want to restore.
3. Click Restore .
4. The older version will be restored and loaded into the Content Editor.

Preferences

The Package dialog box displays variables that can be changed. Clicking in the text box next to a variable opens a paragraph at the bottom of the window describing what the variable means.

Preference Variables

There are seven user-defined variables that can be changed according to each DesignGuide:

• Build Name . Refers to the name of the directory where your DesignGuide will be built. It is used as the project name in the studio_file directory and in the $HPEESOF_DIR/DesignGuides/Projects directory.)

  Note The next five variables are used to make the control file for your package. The control file defines information about your DesignGuide.

  
  

• DesignGuide Name . Name of the Debian archive (package) file. Also used as a default name for some of the DesignGuide Developer Studio Editors.

  Note Spaces and special characters are not allowed in DesignGuide Name, though they are permitted in Build Name.

  
  

• Version . DesignGuide Version. Default is 1.5.X, where X can be changed to any number.
• Depend. Some DesignGuides depend on other DesignGuides to function. A list of dependent DesignGuides may be placed here. Default is dgbase . All listed DesignGuides must be separated by a comma.
• Description . A short description of your DesignGuide.