Lab Example Summary

This chapter provides a a basic summary of the steps used to develop DesignGuides, using some actual lab examples. The user-created DesignGuide example projects referenced in this chapter include the following:

• dg_budget_pr j (Budget DesignGuide)
• dg_radar_prj (Radar DesignGuide)
• dg_rfic_models_prj (RFIC Model DesignGuide)

To access these examples from the Advanced Design System Main window, select File > Example Project > Training > DesignGuide , and select the example project you want to open.

This chapter is organized as follows:

• Basic information before starting
• Tab Dialog Editor Example (Budget DesignGuide)
• Menu and Palette Editor Example (Radar DesignGuide)
• Advanced Topics (RFIC Model DesignGuide)
• Advanced Topics (Documentation)
  The primary steps in creating a DesignGuide using the Developer Studio are as follows:
• Create DesignGuide structure, using the following:
  • Menu Editor
  • Palette Editor
  • Tab Dialog Editor
  • Bitmap Editor
  • Quick Help Editor
  • System Help
  • Report Problem Summary
• Associate actions to menu selections
  • Open Schematics / Data Displays
  • Display palettes
  • Open Tab dialogs
  • Insert templates, components, and sub-networks
  • Execute custom AEL routines
• Produce DesignGuides for PC or Unix
• Create a Revision History
• Create single file archive for easy distribution via worldwide web or e-mail

Basic Information Before Starting

The following is some basic data that will be helpful before you begin your development process.

Navigating Through the Developer Studio

To access the main dialog box for the Developer Studio, in the ADS Main window, select DesignGuide > DesignGuide Developer Studio > Start DesignGuide Studio .
For a basic introduction to navigating through the DesignGuide menus and commands, refer to Developer Studio Overview.

Important Files and Directories

Following is the DesignGuide directory structure in $HPEESOF_DIR:
$HPEESOF_DIR\designguides\ael\vapi_runtime.atf
$HPEESOF_DIR\designguides\projects\<designguide name>
ael
data
doc
networks
ui

The source files can be any ADS project directory. The ADS project must be located at $HOME. There is no browse capability for the Content Editor of the Developer Studio DesignGuide .

$HOME\<ads_project_name>_prj

The archive files are located in the studio_file directory:
$HOME\Studio_files\<designguide name>\<designguide name>.deb.

Note Once the DesignGuide has been packaged and all changes have been completed you can move the ADS project to another directory.

Creating Tab Dialogs

This section uses the example project dg_budget_prj (Budget DesignGuide) to provide a brief summary of the key steps in creating tab dialogs, including:

• Creating a tab dialog user interface for opening schematics and data displays
• Creating a menu for opening the tab dialog
• Showing the difference between a build and a package

This example begins with a collection of related and similarly named schematics, data displays, and datasets. There are no subcircuits or other dependent files. A matrix of user-selectable categories is determined, and each schematic represents one of the possible selection combination.The key actions in this example include:

1. Choose the Tab Dialog Editor button on the dialog box toolbar.
   
2. From the Action field of the dialog box, do any of the following:
   
3. Define the tab and button groups.
   
4. View the summary of tab definitions, as shown here.
   
   We recommend that you define and create a plan for your tab dialog structure, as shown in the following example.
   

Starting a New Studio File. Following are the basic steps in starting a new studio file.

1. Place a project file ( dg_budget_prj in this example) in the $HOME directory, using the Copy Project command from the Main window.
2. From the Main Window, select DesignGuide > DesignGuide Developer Studio > Start DesignGuide Studio .
3. From the DesignGuide Developer Studio window select File > New .
4. From the New Project dialog box, define the name of the project (for example, Budget) , then select the Create Project button.
   

Registering the Content. The Content Register is used to do the following:

• Define the location of designs, data displays, and datasets
• Map content from multiple ADS projects
• Define dependent files
• The build copies the content to one location
  

1. From the DesignGuide Developer Studio window, in the Content Browser, expand the folder hierarchy of Budget by selecting the + symbol by the name.
2. In the Content Browser window, expand the folder hierarchy of My Content by selecting the + symbol by the name.
3. Select the Design icon in the Content Browser so that it is highlighted. The ADS project files are now listed.
4. In the Project Files window, expand the folder hierarchy of dg_budget_prj by selecting the + symbol by the name of the project.
5. The Windows convention of Shift and Ctrl work for file selection. Select all of the design files by selecting the first design file, scrolling down to the last design files, and hold the shift key down while selecting the last design file.
6. Select Add Project File.
7. Continue the same content registry process for the data displays and the datasets, as shown in the following illustration. It is advisable to save the Studio project. In the DesignGuide Developer Studio window, select File > Save or select the Save icon on the toolbar.
   

Using the Tab Dialog Editor. The steps that follow show the use of the Tab Dialog Editor .

1. From the DesignGuide Developer Studio window toolbar, open the Tab Dialog Editor . Refer to the menu plan introduced previously in this section.
   
2. Define three Tabs by choosing the Add Tab Group button. If you expand one of the inserted tabs, and select this button, the Add Tab Group button changes to Add Button Group .
3. Define three buttons for tab 1 using the Add Button Group button.
4. Define three buttons for tab 2, and four buttons for tab 3.
5. Change the name of the tabs to the following:
   • Tab 1 to Simulation Control
   • Tab 2 to Noise Measurements
   • Tab 3 to Signal Measurements
6. Change the tab 1 button names to the following:
   • Button 1 to AC
   • Button 2 to HB
   • Button 3 to Both AC and HB

     Note The name order of the buttons is important for proper mapping to actions.

7. Change the tab 2 button names to the following:
   • Button 1 to None
   • Button 2 to All Noise Budgets
   • Button 3 to SNR and Noise Power only
8. Change the tab 3 button names to the following:
   Button 1 to None
   Button 2 to All Power Budgets
   Button 3 to Gain Compression only
   Button 4 to IP3 degradation only
   
9. From the Tab Dialog Editor window, after the tabs and buttons have been named, add 13 tab selections (one for each design file) using the Add Selections button.
10. Repeat the following process for each of the 13 tab selections.
    • Select a tab selection in the information window so that it is highlighted.
    • Select the action to open schematic/display .
    • Select the object group My Content.
    • Select the object (start with Budget112 ).
    • Select the combination of buttons that will define the action. For example, the object budget213 refers to button 2 from tab 1, button 1 from tab 2, and button 3 from tab 3.
    • Choose the Test button to see a preview of the tab dialog.
11. When all 13 definitions are complete, close the Tab Dialog Editor window.
12. Save your work.
    

Using the Menu Editor. The steps that follow show the use of the Menu Editor.

1. From the DesignGuide Developer Studio window toolbar, open the Menu Editor.
   
2. Set the Menu Name to Budget . Press Enter when you finish typing in the new name (which will appear in the DesignGuide menu).
   

Defining a menu. The tab dialog needs to be configured into a menu, as explained in the next set of steps.

1. In the Menu Editor window, make sure that the Menu Window Type is set to Schematic .
2. Select the first entry in the Current Menu Layout to define it. Change the Menu Item Caption name to Budget Analysis Configuration .
3. Use the Action pull-down menu to define Open Tab Dialog .
4. Use the Object Group pull-down menu to select My Contents .
5. Use the Object pull-down menu to select the Budget tab dialog.
6. Use the Analog/DSP pull-down menu to select Analog RF .
7. Test the menu. After inspection, close the Menu Editor Window.
8. Save your work.
   

Build Command Definitions. Prior to building the DesignGuide, it's useful to review the build command definitions:

• The Build function copies all content files and UI definitions to the designguides project directory $HPEESOF_DIR/designguides/projects . This is not the same as adding or installing. It does not register the files with ADS in the status file. For example, if you build a DesignGuide and try to remove it using RemoveDesignGuide , you will only see a list of DesignGuides that have been added to your installation. You must use the Unbuild function to remove it. Build is meant to be a quick way for you to check your work and to debug prior to packaging.
• The Unbuild function removes the files and UI definition from the designguides project directory.
• The Package function builds the DesignGuide, then archives it by producing a DEBIAN file. This can then be installed in ADS using the Add DesignGuide selection in the ADS Main window.
  

Building the DesignGuide. The DesignGuide can be built and/or packaged. For this example, we will package the DesignGuide, as it will produce an archive file.

1. From the DesignGuide Developer Studio window, select the Package button from the toolbar.
2. Define the Build Name, DesignGuide Name, version, dependency and description.
3. Select the Package button. The DesignGuide Developer Studio will build a single package that can be installed on a PC or UNIX machine.
4. It's advisable to save the Studio project. Select File > Save from the DesignGuide Developer Studio window, or select the Save icon on the toolbar.

   Note Code Number is used only if Agilent issues a license to secure it to a FlexLM codeword. For more information refer to Preference Variables.

In the Package dialog box, the main fields are defined as follows:

• • Build name is the name of the build directory in $HPEESOF_DIR/designguides/projects.
  • DesignGuideName is the name of the DesignGuide file when it is packaged. (Characters such as underscore (_) can't be used.)
  • Depend defines a dependency on other required DEBIAN packages. The DEBIAN package file is located at $HOME/studio_files/<designguidename> .

Checking the Installation. The DesignGuide needs to be built and/or packaged, then checked.

1. We recommend that you check the DesignGuide by opening a new project file, then opening a schematic page to check the DesignGuide menu. If there are problems with the installation, try shutting down ADS and re-starting ADS.
   
2. To remove a DesignGuide after it has been built, select File > Unbuild from the DesignGuide Developer Studio Window.
3. To remove a DesignGuide after it has been packaged and added to ADS, select the DesignGuide > List/Remove DesignGuide command from the ADS Main window.
4. Save the DesignGuide project file.
   Adding/Removing DesignGuides. DesignGuides are added or removed by selecting DesignGuide > Add Design Guide or DesignGuide > List/Remove DesignGuide , respectively, from the ADS Main window. The definitions are as follows:

• Add DesignGuide installs the DEBIAN archive file for the DesignGuide. This is a substitute for the hpessofpkg -i command. Adding a DesignGuide registers it with ADS. It makes an entry in the status file in $HPEESOF_DIR/tools/lib/dpkg/ . It also keeps a copy of the file list that has been installed for administration purposes (removing it, checking information on who developed it, etc.).
• List/RemoveDesignGuide removes the DesignGuide only when it has been added using the AddDesignGuide command. This is a substitute for the hpessofpkg -r command. It cannot be used with a build DesignGuide.

Working with the Menus and Palette Editor

This section uses the example project dg_radar_pr j (Radar DesignGuide) to provide a brief summary of the following development steps:

• Creating a palette of subnetworks for the schematic
• Creating a menu as an alternate to a palette
• Using the Bitmap Editor
• Showing the use of the Quick Help
  For this example, a single schematic with several subnetworks was used. The subnetworks are configured into a palette of related components. The subnetworks are also configured into a menu.
  Building a New Project. You will need the project (for this example, dg_Radar_prj) to reside in your $HOME directory. This is in the Examples/Training/Designguides directory .

1. From the Main window, select DesignGuide > DesignGuide Developer Studio > Start DesignGuide Studio .
2. From the DesignGuide Developer Studio window, select File > New .
3. In the New Project dialog box, define the name of the project as Radar , then choose the Create Project button.
   

Registering the Content. This section shows the use of the Content Register.

1. From the DesignGuide Developer Studio Window, in the Content Browser, expand the folder hierarchy of Radar by selecting the + symbol by the name.
2. In the Content Browser window, expand the folder hierarchy of My Content by selecting the + symbol by the name.
3. Select the design icon in the Content Browser so that it is highlighted.
4. In the Project Files window, expand the folder hierarchy of dg_radar_prj by selecting the + symbol by the name of the project.
5. Select the top level design file named Doppler_Radar.dsn .
6. Select Add Project File .
   
7. The associated subnetworks are automatically added as dependent files.
   

   Note Use the Shift key while selecting all the design files, then use the Control key to unselect Doppler_Radar.dsn .

   Viewing the Content Summary .
8. From the DesignGuide Developer Studio Window, select Reports > Content Summary to see the content summary report.
   • In Display, add Doppler_Radar.dds .
   • In Dataset, add Doppler_Radar.ds .
     If the Design and Display and Dataset all have the same name, it will work by default. If they have different names, you must map the files as dependent.
9. Select File > Save .
   

Using the Menu Editor. The steps that follow demonstrate use of the Menu Editor.

1. In the DesignGuide Developer Studio Window, open the Menu Editor.
   
2. In the Menu Editor window, the first step is to define whether you need to have DesignGuides added to the Schematic and/or Layout windows. For this example, we do not need DesignGuides in the Layout window
   • In the Menu Window Type, select Layout .
   • Select Delete Menu. The Menu Window Type should show Schematic . Keep this.
   • Set the Menu Name to Radar . Press Enter when you finish typing in the new name.
3. There are two alternatives for performing this step. The first one: From the Menu Editor window, define 20 menu items by choosing the Insert Menu Item button. Define the menu with the following names and structure. Use the arrow buttons to indent the menu names.
   

The alternative action: In the Menu Editor window, define 19 menu items by choosing the Insert Menu Item button. Define the menu with the following names and structure. Use the arrow buttons to indent the menu names. This menu structure will be different from the remainder of the example, but has the benefit of only one submenu level.

Bitmaps and their Objects and the illustration that follows summarize this process.

Bitmaps and their Objects

Bitmap	Object
amp.bmp	Amplifer_Gain.dsn
lna.bmp	Amplifer_LNA.dsn
pa.bmp	Amplifer_Power.dsn
target.bmp	Target.dsn
xmt_ant.bmp	Antenna_XMIT.dsn
rcv_ant.bmp	Antenna_RCV.dsn
cw_source.bmp	Source_CW.dsn
coupler.bmp	Coupler.dsn
downconverter.bmp	DownConverter.dsn
TP_A.bmp	Test_Point_A.dsn
TP_B.bmp	Test_Point_B.dsn
TP_C.bmp	No subcircuit

Using the Define Menu. The steps that follow demonstrate the use of the Define menu.

1. From the Menu Editor window, for each menu selection, select the Action Place Subnetwork for each of the 12 subnetworks (using Group and Object selections for each object). Exceptions include Component Palette , Doppler Radar (open the schematic Doppler_Radar ), and Toggle Quick Help .

   Note Don't map the Component Palette menu until after it is defined in step 3 of the "Using the Bitmap Editor" section.

2. For the Doppler Radar menu option, select the Action Open Schematic/Display for the design object.
3. Map the menu name Toggle Quick Help to the Toggle Quick Help action.
4. From the DesignGuide Developer Studio window, view Reports > Menu Summary to check the menu definition summary.

Using the Quick Help Editor . The steps that follow demonstrate the use of the Quick Help Editor.

1. From the DesignGuide Developer Studio window, open the Quick Help Editor window from the toolbar.
   
2. Define a Quick Help entry for the Radar System examples. This is explanatory text to help the user, which can be assigned to a menu. This is done by selecting add , then changing the name and title, and adding descriptive text. For now, type some arbitrary text for the Quick Help.
   
3. Map the Quick Help to the Menu. From the Menu Editor window, assign the Quick Help for the CW Radar System design that was defined in the previous step to the Doppler Radar menu selection.
   

Using the Palette Editor. The subnetworks for the radar DesignGuide will be added to a palette.

1. From the DesignGuide Developer Studio window, open the Palette Editor .
   
2. From the Palette Editor, select the Insert Palette Item button.
3. From the Insert Palette Item dialog, use the Import button and navigate to the pre-defined icons located at $HOME/dg_radar_prj/ui/pc_bitmaps. The bitmaps were predefined with the Bitmap Editor, and which is not shown as part of this lab.

   Note If you are running the program on UNIX, there is not an Import button. You will have to copy the bitmaps from $HOME/dg_radar_prj/ui/unix_bitmaps to $HOME/studio_files/Radar/bitmaps/palette . For this example, these bitmaps were converted from PC to UNIX using the Bitmap Editor.

4. Select all of the icons (one at a time). As you select them, they will display in the Insert Palette Item Dialog window.
   
5. From the Bitmap dialog box,use the Insert button to place the palette bitmaps.
6. After inserting the bitmaps, if the bitmaps are not in a preferred order, use the arrow buttons to reposition the icons.
   
7. Associate an action to each icon. In each case, the action will be Place Subnetwork . (Refer to the sections that follow for menu subnetwork mapping definition.)
8. Change the palette name to radar_palette . At any time, choose the Test button to review the functionality of the palette.

Using the Bitmap Editor. The steps that follow demonstrate the use of the Bitmap Editor.

1. From the DesignGuide Developer Studio window, or from the Palette Editor, open the Bitmap Editor.
   
2. As an exploration, use the bitmap edit to change one of the icons (such as Test_Point_A, or Target) and change the color, or make entirely new bitmaps. In the bitmap editor window, explore the following commands:
   • View >Caption Guide Display
   • View > Image Guide Display
   • Tools > Add Caption
   • Tools > Add Analog/RF Corner Tab
   • File > Save As

     Note If you are running the program under UNIX, restart ADS to view changes to bitmaps in the Palette Editor.

     

3. From the Menu Editor window, associate the Show Palette action to the Component Palette menu. Use the pull-down menu to select the newly created Radar palette object.

Viewing the Palette Editor Report Summary. The following steps provide an example of the use of the Palette Editor Report Summary.

1. From the DesignGuide Developer Studio window, select Reports > Palette Summary to view the Palette definition summary (as shown here). It's advisable to save the Studio project prior to packaging or building. Select File > Save or select the Save icon on the tool bar.
   
   Optional step: From the DesignGuide Developer Studio window, define the revision information by selecting File > Version . The Version Control dialog box is shown here.
   
2. Package the DesignGuide. Select the Package Studio Product toolbar icon.
   
   The Package dialog box is shown here.
   
   A confirmation message appears when packaging is complete.
   
3. Save the DesignGuide file. (It was also saved in step 1, but this will save any settings made for Packaging.)
   
4. Check the installation by restarting ADS, opening a new project, and checking the DesignGuide menu.
   

Creating Palettes for Schematic and Layout Windows

This section uses the example project dg_rfic_models_prj (RFIC Model DesignGuide) to provide a brief summary of the process of creating palettes for Schematic and Layout windows. The example uses a collection of related subnetworks that pertain to RFIC. Several of the components have both an electrical model and a layout representation., either static footprint or parameterized (GCC). The example is not intended to show how the content of the subnetworks was prepared.
This example does the following:

• Incorporates a previously created collection or library of ADS models
• Shows how to link to models that use GCC for Layout
• Creates a palette for Schematic and Layout windows
• Shows the use of AEL as an action
  

  Note Though this example is designed to demonstrate how to implement a library of subcircuits, it's not a library in the usual sense of the word. When a DesignGuide subcircuit is inserted into the schematic, a copy is made of the original subcircuit and placed in the current ADS project, which becomes disassociated from the original subcircuit. Unlike a real library model, which would be updated if the original version is updated, it does not update the copies contained in the ADS projects.

  Table and the illustration that follow show an overview of the models.

Designs and their Electrical Models

Design Name	Electrical Model	Physical Layout
Bondpad	equivalent ckt	n/a
C_Mlm	equivalent ckt	n/a
D_Schottky	equivalent ckt	n/a
L_Spiral	equivalent ckt	GCC model
R_Gminus	equivalent ckt	n/a
R_Nlchr	equivalent ckt	n/a
R_Nplus	equivalent ckt	n/a
SDD_Diode	SDD model	n/a
Spiral	Momentum data	static layout
Spiral_meas	Measured data	n/a
Substrate_via	equivalent ckt	static layout
dfet_gcc	equivalent ckt	GCC model
square	n/a	static layout
wafer	n/a	GCC model

1. Make sure the dg_rfic_models_prj file is placed in the $HOME directory.
2. From the ADS Main window, select DesignGuide > DesignGuide Developer Studio > Start DesignGuide Studio .
3. From the DesignGuide Developer Studio window, select File > New.
4. From the New Project dialog, define the name of the project as Rfic, then select the Create Project button.

Mapping the Subnetworks

• Select the subnetworks icon in the Content Browser and map all of the design files from the dg_rfic_models_prj directory.
  
  Following is a list of the mapped subnetworks.
  

Mapping the Dataset Files

• From the Content Editor, map the dataset files. The two datasets are from a Momentum simulation of a spiral inductor ( Spiral_a.ds ), and from an NWA measurement of a spiral inductor ( measured.ds ).
  

Using Data-based Models

1. From the Content Editor window, the spiral_mom.dsn subnetwork is a data-based model that uses the S-parameter results from a Momentum simulation.
   
2. Select spiral_mom in the Content Browser, and select SPIRAL_a from the dependent files, and choose Add Dependent Files.
   
3. The Spiral meas sub-network is a data-based model that uses the S-parameter results from a NWA measurement. Select Spiral_meas in the Content Browser, and select measured from the dependent files, and choose Add Dependent Files .
   Using GCC Models

• For any subnetwork that uses GCC for the layout, use the operating system's file manager or appropriate commands to copy the two AEL files for the subnetwork from $HOME/dg_rfic_models_prj/networks directory to the $HOME/studio_files/Rfic/ael directory.
  
  The following AEL files will be needed to support the subnetwork definition in a later step. Copy these files:
  • dfet_gcc.ael
  • dfet_gcc_art.ael
  • interdigit_cap.ael
  • interdigit_cap_art.ael
  • meander_width.ael
  • meander_width_art.ael
  • square.ael
  • square_art.ael
  • wafer.ael
  • wafer_art.ael

Using the Palette Editor

1. In the Palette Editor, select Insert Palette Items , then Import ,
   On UNIX systems, where there is no Import button, copy the files from the ADS project directory to $HOME/studio_files/Rfic/bitmaps/palette . On PCs, use the file browser to navigate to $HOME/dg_rfic_models_prj/ui/pc_bitmaps and select and import (one at a time) the following bitmaps located there:
   • bondpad.bmp
   • bondwire.bmp
   • cap_mim.bmp
   • dfet.bmp
   • diode_sdd.bmp
   • diode_sh.bmp
   • ind_spiral.bmp
   • ind_square_gcc.bmp
   • iinterdgt.bmp
   • meander.bmp
   • preference.bmp
   • res_gminus.bmp
   • res_nichr.bmp
   • res_nplus.bmp
   • via_backside.bmp
   • wafer.bmp
     

     Note The bitmaps can be created using the Bitmap Editor, which is not shown as part of this example. You are encouraged to explore the Bitmap Editor.

     # Place the following bitmaps into the Palette, and arrange them by using the arrow buttons.
2. #* res_nichr.bmp (NiChr)
   • res_nplus.bmp (RES N+)
   • res_gminus.bmp (RES G-)
   • dfet.bmp (DFET)
   • diode_sh.bmp (Diode)
   • diode_sdd.bmp (SDD Diode)
   • via_backside.bmp (VIA)
   • bondpad.bmp (Pad)
   • cap_mim.bmp (MIM CAP)
   • ind_spiral.bmp (IND)
     
3. In the Palette Editor, define the actions for each icon, which is Place Subnetwor k. The following is the mapping of bitmaps to objects:
   • res_nichr.bmp (NiChr)-- R_Nichr
   • res_gminus.bmp (RES G-)-- R_Gminus
   • res_nplus.bmp (RES N+)-- R_Nplus
   • dfet.bmp (DFET)-- dfet_gcc
   • diode_sh.bmp (Diode)-- D_Schottky
   • diode_sdd.bmp (SDD Diode)-- SDD_Diode
   • via_backside.bmp (VIA)-- Substrate_via
   • bondpad.bmp (PAD)-- Bondpad
   • cap_mim.bmp (MIM CAP)-- C_Mim
   • ind_spiral.bmp (IND) – L_Spiral
     

Defining New Bitmaps

1. From the Palette Editor: We want to add two more inductors to the palette. This can be done in two ways: through the Bitmap Editor, or from the Insert Palette Item dialog (not available on UNIX systems). We will do this both ways to illustrate both processes. Select the inductor icon from the Palette Editor, and select the Edit Bitmap button. The icon is now shown in the bitmap editor.
2. From the Bitmap Editor, change the caption by pressing the Caption button, or selecting the Tools > Add Caption command. Change the caption to Measure.
3. Save the bitmap under a new name ind_meas.bmp by selecting File > Save as PC (if you are using a PC; otherwise select File > Save as UNIX ).
   
4. From the Palette Editor: If you are running the program under UNIX, repeat steps 1 and 2 with the caption name Momntm . If you are using the PC, select one of the existing inductor models in the palette. Select the Insert Palette Item button. Enter the new name in the Palette Item Name ( Momntm ), and choose the Insert button. This will change the name on the bitmap and create a new bitmap file.
   

Using the Layout Palette

Note On UNIX systems, if a change is made to a bitmap and saved with the same name, the changes will not show up in the palette until you shut down and restart ADS.

1. In the Palette Editor, change to a new palette for the Layout Window by selecting Layout from the pull-down menu under Palette Window Type .
   
2. Select Create Palette and change the name of the palette to RFIC_Layout.
3. Add the following icons:
   • Wafer.bmp for wafer.dsn. (Wafer has no electrical model, but has a GCC-based layout.)
   • dfet.bmp for dfet_gcc.dsn. (DFET has an electrical equivalent nonlinear circuit model and a GCC-based layout.)
   • ind_mom.bmp for spiral_mom.dsn. (This design has a data-based S-parameter model from Momentum and a static layout footprint.)
   • Ind_square_gcc.bmp for square.dsn. (IND SQR is a data-based model with a GCC-based layout.)
   • via_backside.bmp for substrate_via.dsn. (VIA is the substrate via that has an electrical equivalent linear circuit model and a static layout.)
   • Interdgt.bmp for Interdigit_cap.dsn (No electrical model, GCC-based layout)
   • meander.bmp for meander_width.dsn. (No electrical model, GCC-based layout)
   • Layout Setup will be a set of AEL commands, which in this case set up user preferences.
     
     Shown here is the final RFIC Layout palette.
     

Defining AEL Actions

• From the Palette Editor: For the Layout Setup bitmap, define the action as Execute AEL Function . Type in the following AEL commands.
  • de_change_units(3,4,1);
  • de_set_preference(GRID_SNAP_X_P,1);
  • de_set_preference(GRID_SNAP_Y_P,1);
  • de_set_preference(INST_TEXT_HEIGHT_P,5);
  • de_set_preference(TEXT_HEIGHT_P,5);
  • de_set_preference(PORT_SIZE_P,10);
    These option settings are usually set by selecting Option > Preferences in a Layout window, and these AEL commands can be viewed from the ADS Main window by selecting Options > Command Line.
    

Define the Menu for Schematic

• From the Menu Editor, define a menu for the Schematic window. The first menu item is named RFIC Model Palette . The action is Show Palette . The Object Group is My Content and the Object is RFIC Palette .
  

Defining the Menu for Layout

• From the Menu Editor, select Create Layout Menu . Define the following menu:
  • The menu item is named RFIC Palette . The action is to display the Palette.The Object Group is My Content . The object is Rfic_layout .
    

Packaging the RFIC DesignGuide

1. Close all of the Editor windows prior to saving the project.
2. From the Main Window, save the project.
3. Build and/or package this DesignGuide.
   
4. After building or packaging, save the project again.
5. Exit and re-start ADS. Start a new ADS project and test the RFIC DesignGuide from the Schematic and Layout windows.
   Shown here are the additions made to the Schematic window.
   
   Shown here are the additions made to the Layout window.
   

Linking an HTML Document to a Menu

This section demonstrates how to:

• Link to HTML documentation
• Add a menu to the ADS Main window

  Note If you have already installed the tutorial for DesignGuides in ADS, review this example to see which method was used to install this document, but change the name of the menu since it will overwrite the existing installation. Also, to perform this exercise, you will need to have the DesignGuide Developer Studio tutorial file installed in ADS.

1. From the Main Window, select DesignGuide > DesignGuide Developer Studio > Start DesignGuide Studio .
2. Select File > New.
3. From the New Project dialog, define the name of the project as CustomDoc, then select the Create Project button.
   
   

   Note When you create the content for an HTML document, make sure that it uses relative references, and all of the content is self-contained within a single directory structure. For this example, copy the entire HTML directory structure from $HPEESOF_DIR/designguides/projects/tutorial/doc to $HOME/studio_files/Tutorial/doc .

   *Defining the HTML Document*
4. From the DesignGuide Developer Studio window, open the System Help Editor .
5. From the System Help Editor, select Add , then highlight the entry that now shows in the System Help Names window.
6. Use the Help File Name Browse to select index.html . This is the top-level page for the HTML documentation. This can be created by any method for developing Web content.
   
   

Defining a Menu for the ADS Main Window

1. From the Menu Editor, select the Create Main Menu button to create an entry for Main in Menu Window Type .
2. Define the menu:
   • Menu Item Caption as Open HTML Custom Doc
   • Action as Open Help File
   • Object Group as Help System
   • Object as Custom Documentation (make sure to change Default0 to a unique name)
   • Analog/DSP as Both
     

Packaging the Tutorial DesignGuide

1. From the Content Editor, save the project.
2. Select Package Studio Project.
   
3. Enter the package information, then choose OK .
4. Save the project again.
5. Exit ADS and re-start it.
6. Check for the tutorial under the DesignGuide menu on the ADS Main window. It should start a web browser with the tutorial files and description.