Getting Started With DesignGuide Developer Studio

The DesignGuide Developer Studio is designed to help developers quickly and easily create and use custom DesignGuides for use in Advanced Design System. The following section provides basic introduction to the DesignGuide Developer Studio components and how to use them to create a custom DesignGuide.

Using DesignGuides

The DesignGuide Developer Studio is accessed from the DesignGuide menu in the ADS Main window.

The commands in this menu are as follows:

DesignGuide Studio Documentation > Developer Studio Documentation is only available on this menu if you have installed the DesignGuide Developer Studio. It brings up the DesignGuide Developer Studio documentation. Another way to access the Developer Studio documentation is by selecting Help > Topics and Index > DesignGuides > DesignGuide Developer Studio (from any ADS program window).

DesignGuide Developer Studio > Start DesignGuide Studio is only available on this menu if you have installed the DesignGuide Developer Studio. It launches the initial Developer Studio dialog box.

Add DesignGuide brings up a directory browser in which you can add a DesignGuide to your
installation. This is primarily intended for use with DesignGuides that are custom-built through the Developer Studio.

List/Remove DesignGuide brings up a list of your installed DesignGuides. Select any that you would like to uninstall and choose the Remove button.

Preferences brings up a dialog box that is not applicable to the DesignGuide Developer Studio itself, but for all other installed DesignGuides (such as Bluetooth or RF System), it allows you to:

• Disable the DesignGuide menu commands (all except Preferences) in the Main window by unchecking this box. In the Schematic and Layout windows, the complete DesignGuide menu and all of its commands will be removed if this box is unchecked.
• Select your preferred interface method (cascading menus vs. dialog boxes).
  
• Close and restart the program for your preference changes to take effect.

  Note On PC systems, Windows resource issues might limit the use of cascading menus. When multiple windows are open, your system could become destabilized. Thus the dialog box menu style might be best for these situations.

Accessing documentation

To access the documentation for the DesignGuide, select either of the following:

• DesignGuide > DesignGuide Studio Documentation > Developer Studio Documentation (from ADS Main window)
• Help > Topics and Index > DesignGuides > DesignGuide Developer Studio (from any ADS program window)

Developer Studio Overview

The DesignGuide Developer Studio is composed of the following tools:

• Main Window/Content Editor
• Menu Editor
• Palette Editor
• Bitmap Editor
• Tab Dialog Editor
• Quick Help Editor
• System Help Editor
  
  Each individual editor saves its information inside a studio file (file extension .stu), so all DesignGuide information is kept in one place for easy saving and loading.

The six main steps in creating a custom DesignGuide follow:

1. Create custom content files using ADS (Schematic, Layout, Display, etc.).
2. Add content files to studio project using the Content Editor.
3. Use the Menu, Tab Dialog, and Palette Editors to control access to content files.
4. Add appropriate help files using System and Quick Help Editors.
5. Use Build to create DesignGuide for use on current computer.
6. Use Package to create packaged files for installation/use on other computers.
   The following section demonstrates how to use the DesignGuide Developer Studio quickly to create a DesignGuide.

Summary of Files and Directories

When you start to use the Developer Studio, it places a studio_files directory in your $HOME directory. The studio_files directory is the location for all project directories for each project (each project has its own folder). Contained in the project folder is the studio file ( xxx.stu ) and the debian file ( xxx.deb ). The xxx.stu file contains the menu definition, the palette definition, the tab dialog definition, and so on. When you package the project, it does the following:

• Copies all of the design files, datasets, data display pages, and so on, to the s tudio_files/<project name> directory
• Creates the xxx.deb file
• Deletes all of the files that went into the xxx.deb file.
  The xxx.deb file is now the archive file, which is transportable and installable in ADS.
  DesignGuide Name is the name of the Debian archive file.
  Build Name is the name of the directory used as the project name in the studio_file directory and in the $HPEESOF_DIR/designguides/projects directory.

To change the DesignGuide Name or Build Name, refer to Preferences.

Custom Design Guides can be stored in the $HOME/hpeesof/designguides/projects directory (for individual users).

Creating a DesignGuide Menu

The following brief tutorial will take you through the steps of creating a very simple DesignGuide menu that will appear on an ADS Schematic window. We recommend that you review the preceding section, Summary of Files and Directories before proceeding.

Creating a Studio Project

1. In ADS, create a new project called MyProject, and a schematic called MySchematic.
2. Start DesignGuide Developer Studio. From the ADS Main window, select DesignGuide Developer Studio > Start DesignGuide Studio.
3. In the Developer Studio, select File > New.
4. Type in a new name ( MyDesignGuide ) and select Create Project.
5. Under Content Browser, click My Content. The new studio project should be displayed as follows:

Adding Content

The next step is to add the user-created content to the Content Editor. Following are the components to a studio project:

To add content to the Content Editor:

1. Select Design from the list of Content Types. A list of projects will appear in the PROJECT FILES box on the right.
2. Open the project MyProject_prj. All .dsn files within the project will be displayed.
3. Select MySchematic.dsn. MySchematic will be added under the Design c ontent type.

Creating a Menu

The next step in creating a DesignGuide is creating a menu to use the new content. To create a menu:

1. Open the Menu Editor by selecting Tools > Menu Editor or the Menu Editor Toolbar item.
2. Replace MyDesignGuide in the Menu Name text area with an appropriate name for the application (shown as Amplifier in this example). This will be the name of the menu in ADS once it is created.
3. In the Menu Item Caption field, enter an appropriate name ( Power-amp in this example).
4. Select Power-amp from the Current Menu Layout box.
5. Select Open Schemati c from the Action list on the right.
6. Select My Content from the Object Group list (this corresponds to the group names in the Content Editor).
7. Select MySchematic from the Object list. The Menu Editor should now look as follows:
   
8. Choose OK.

Building the DesignGuide

The final step in the design process is to build the DesignGuide for use in any ADS Schematic window.

1. Build the studio project by selecting File > Build, or choose the Build toolbar button.
2. Select Yes.
3. To look at the new menu, close Developer Studio, exit and restart ADS, then open a Schematic window
4. The new menu ( My Menu ) is within the DesignGuide menu, with one menu item ( My Menu Item ).
5. Select Power-amp, and the schematic you created will appear.

Main Window/Content Editor

The Content Editor is the first window that opens when the Developer Studio is started. The Content Editor has the following capabilities:

• Create a new studio project.
• Load an existing studio project.
• Add user-created content files to the project.
• Create file dependencies between content files.
• Open the other DesignGuide Developer Studio editors.
• Save and build the current studio project.
• Package the DesignGuide for easy distribution and installation.
• Organize and store previous versions of the studio project as a means of backup.
  In the following, observe the Content Editor toolbar and the actions associated with each button. Each Content Editor component can also be called using the corresponding menu item. (Refer to Content Editor.)

Creating a New Studio Project

The Content Browser box (shown here) contains the current studio project. To create a new Studio Project:

1. Select File > New.
2. Type in the name of the new studio project (or keep the default).
3. Select Create Project

The new studio project appears in the Content Browser area with one group, My Content, already created.

Adding Content

To add content files to the studio project:

1. Select a content type ( Dataset, Design, Display, Subnetwork or templates) from Content Browser.
2. Select a project directory from the Project Files box in the lower right.
3. Select the content files to be added and choose the Add Project File button.
4. The content files are then added to the Content Browser box.
   To remove content, select the content file in the Content Browser box and choose the Remove button.

Building a Project

To build the current DesignGuide for use on the same computer, choose the Build button on the Content Editor. This will create the DesignGuide for use the next time ADS is loaded.

Packaging a Project

The Package utility packages the DesignGuide for installation on other computers. Choose the Package button on the Content Editor (this will also automatically build the DesignGuide) to create a .deb file for installation on other computers.
For more detailed information, refer to Content Editor.

Menu Editor

To open the menu editor, select Tools > Menu Editor from the main window, or push the Menu Editor button on the toolbar. The menu editor has the following capabilities:

• Create menu cascade structures for any ADS window (except data display).
• Attach actions and file objects to menu items.
• Control menu attributes such as license locking, analog/DSP mode, and quick help files.

Menu Editor Components

The Menu Editor is composed of the following components (as shown in the preceding figure).

• Menu Controls. Allow the creation, deletion and renaming of any number of menus for use in ADS windows.
• Menu Item Controls. Allow the creation, deletion and renaming of individual menu items, along with the assigning of actions, objects, and other attributes to each menu item.
• Current Menu Layout. Displays the current menu layout with the menu items arranged in a menu/sub-menu hierarchy.
• Menu Editor Control Buttons. Control buttons to save the menu information, close the editor, test the current menu structure, and open the menu editor documentation.

Creating a Menu

The Menu Editor has a default menu that was created for the Schematic window. To create a sample menu:

1. Push the Insert Menu Item button on the lower right three times. This will add three new menu items to the current menu.
2. Double-click each menu item to change its name.
3. For each menu item, select the left and right arrow buttons to move it to the desired depth of indentation. Each level of indentation represents a level of submenu.
4. Select an action from the Action list for each menu leaf.
5. For each leaf item, select an Object Group from the list, if applicable.
6. Select or input an Object for each leaf from the list or text box.
7. Choose OK at the bottom of the Menu Editor.
   After the studio project has been saved and built, this new menu will appear in the ADS Schematic window. Or pushing the Test button on the Menu Editor will create a window showing the menu and its accompanying actions and objects.
   For more detailed information, refer to Menu Editor.

Bitmap Editor

The Bitmap Editor is functionally independent of the rest of the DesignGuide Developer Studio and can be used without using any other Developer Studio component. When used in connection with the Developer Studio, the bitmap editor has the following capabilities:

• Save 32X32 bitmaps for use as palette buttons or elsewhere.
• Create custom bitmaps using a wide selection of drawing and editing tools in 15 colors.
• Add custom captions to new or existing bitmaps.
• Add ADS Smart Component, or Analog/RF color corners to custom or existing bitmaps.

Saving a Custom Bitmap

To save a user-created bitmap:

1. Select File > Save As.
2. Type in a name for the new bitmap. Bitmaps are saved in standard .bmp format, making them compatible with any other application that uses bitmaps.

Loading a Bitmap

To load a bitmap:

1. Select File > Open or choose the Open toolbar button.
2. Select the file to open.
   

   Note The DesignGuide Developer Studio Bitmap Editor only works with bitmaps that are 32X32, so larger or smaller bitmaps cannot be opened or edited.

   For more detailed information about the Bitmap Editor, refer to Bitmap Editor.

Palette Editor

The Palette Editor has the following capabilities:

• Design any number of custom palettes for use in ADS windows.
• Add custom bitmaps to palette buttons.
• Attach actions and content objects to palette buttons, including custom AEL functions.

Palette Editor Components

The Palette Editor consists of the following components (as shown in the preceding figure).

• Palette Controls allows for the creation and deletion of palettes in the analog/RF, DSP, or layout window.
• Current Palette Layout displays the bitmap image of each palette item as it would appear in an actual palette.
• Palette Function Controls controls the action, objects, quick help windows, and balloon help texts of palette items.
• Palette Item Controls control buttons to save the palette, cancel, test the palette, and display help options.

Creating a Palette

The palette editor has a default palette in the analog/RF window. To create a palette and add items:

1. Push the Insert Palette Item button.
2. Press any of the bitmap icons shown in the window.
3. Chose the Insert button followed by the Close button.
4. Select an action from the Action list.
5. Select an object from the Object list. (Object must be registered in the content editor/main window).
6. Select a quick help text name from the Quickhelp list (Quick help texts must be registered in the Quick Help editor).
7. Choose OK on the bottom of the editor.
   After saving the project, choose the Build button. Open a Schematic window and select the palette you just created in the dropdown palette list. Press the palette button.

Tab Dialog Editor

The Tab Dialog Editor is a powerful tool that allows a number of different content files to be tied into the same menu or palette action, allowing the user to set certain parameters through a separate dialog box.

Creating a Tab Dialog

To create a Tab Dialog item:

1. Type in the desired name in the Dialog text area in the upper left.
2. Select Tab from the Tab Groups list.
3. Choose the Add Tab Group button to add the desired number of tab groups.
4. For each Tab Group, expand its button list, and select the first button.
5. Add the desired number of buttons by choosing the Add Button Item button.
6. Rename each Tab Group and button item using the Name text area at the bottom.
7. Add a Selection item for each content object you want controlled by the Tab Dialog item. (For more information on Selection items, refer to Tab Dialog Editor.
8. Choose OK.

Using a Tab Dialog Item

Once created, the Tab Dialog item can be attached to a menu item by doing the following:

1. Open the Menu Editor.
2. Select the desired menu and menu item.
3. Select Open Tab Dialog from the Action list.
4. Select Tab Dialog from the Object list.
5. Choose OK.

Quick Help Editor

The Quick Help Editor provides an easy way for developers to create a quick help file, that can be activated when a menu or palette item is selected.
To create a quick help file:

1. Choose Add.
2. Select the new file from the file list on the left.
3. Change the name (if desired) in the Name text box on top.
4. Type in a title in the Title text box.
5. Type in the desired text in the large text area.
6. When finished, press OK.

System Help Editor

The System Help Editor allows developers to link documentation files to menu and palette items, allowing users to display documentation without much trouble. System help linking has the following process:

1. Copy all the documentation (.html) files into the /doc/ subdirectory of the studio project directory. Make note of all the HTML references within each file that need to be indexed. All related HTML files can be grouped within subdirectories under /doc.
2. Choose Add to create a new Help System index.
3. Put an HTML reference into the Help File Reference text box.
4. Select the file in which the reference is found with the Help File Name drop down list.
5. Change the Reference Name to the desired name. This is the name that will appear in the Menu and Palette Editor when help files are used.
6. Repeat Steps 2 through 5 for each HTML reference to be linked.
7. Choose OK. This will copy the .html files to the proper place in ADS and create an index file.

   Note While HTML references do not need to be unique, Reference Names should be unique across all help files, as ADS will look through all help file indexes for the given reference name.