Tutorials > Sales Center > Extend a page in an editor

< Previous | Next >

Add infopop help to the new page

In this part of the tutorial, you add an infopop to the extended Order Summary page of the IBM Sales Center client. An infopop is a context-sensitive window that opens when the user interface element has focus and the user presses F1.

In this step, you update the infopop for the Order Summary page to include information about capturing gift message information.

The following screen capture shows the default infopop for the Order Summary page. To display the infopop, select one of the gift message input boxes and press F1:

To change the text in the Order Summary page infopop:

Procedure

1. Determine the context ID of the Order Summary infopop:

   1. In the Plug-ins view, expand the com.ibm.commerce.telesales.ui.infopop package.

   2. Right-click the order-f1_contexts.xml file and select Open With > Text Editor.

   3. Within the XML file, find the following section: <!--Order Payment editor page--> <context >

   4. Make note of the context ID and keep this file open for reference.

2. Extend the org.eclipse.help.contexts extension point:

   1. In the orderEditorExtension plug-in, open the plugin.xml file for editing.

   2. In the Extensions tab, click Add.

   3. From the Available Extension Points list, select org.eclipse.help.contexts. If you do not see this extension point, clear the Show only extension points from the required plug-ins check box and look again.

   4. Click Finish.

   5. Click the plugin.xml tab.

   6. Locate the following text: <extension point="org.eclipse.help.contexts"> </extension>

   7. Add the following line within the extension tag: <contexts file="ExtendedHelpContents.xml"/>. The resulting code follows: <extension point="org.eclipse.help.contexts"> <contexts file="ExtendedHelpContents.xml"/> </extension

   8. Save the changes and keep the file open.

3. Create the new infopop definition:

   1. Right-click on the orderEditorExtension plug-in, and select New > File.

   2. In the file name field, enter ExtendedHelpContents.xml.

   3. Click Finish. The ExtendedHelpContents.xml file opens for editing. Note that the file is directly under the plug-in and in the same directory as the plugin.xml file and not in the src directory.

   4. Add the following text to the ExtendedHelpContents.xml file. Note how this text is similar to the definition you examined in the order-f1_contexts.xml file, with additional information about the gift message information:

      <?xml version="1.0" encoding="UTF-8"?> 
      <?NLS type="org.eclipse.help.contexts"?> 
      <contexts> 
        
      <context > 
            
      <description>Use this page to set the payment options for an order, review the details of the order, submit the order,  and collect gift message information.</description> 
            
      <topic label="Order editor" href="../com.ibm.commerce.telesales.tsr.doc/concepts/ctreditororder.htm"/> 
            
      <topic label="Modifying an order" href="../com.ibm.commerce.telesales.tsr.doc/tasks/ttrmodord.htm"/>           
            
      <topic label="Specifying shipping information" href="../com.ibm.commerce.telesales.tsr.doc/tasks/ttrshippingord.htm"/> 
            
      <topic label="Specifying payment information" href="../com.ibm.commerce.telesales.tsr.doc/tasks/ttrpayinfo.htm"/> 
        
      </context> 
      </contexts>
      

   5. Save the changes.

4. Point to the new infopop definition:

   1. In the orderEditorExtension plug-in, navigate to the config directory.

   2. Open the config.ini file for editing.

   3. Add the following line to the end of the file: com.ibm.commerce.telesales.ui.editor_page_order_summary=orderEditorExtension.editor_page_order_summary. This line indicates that instead of the default editor_page_order_summary definition, the IBM Sales Center should use the definition in the orderEditorExtension plug-in. You examined the editor_page_order_summary definition in a previous step.

   4. Save the changes and close the file.

Test the new infopop

Test your new infopop to ensure it displays properly.

1. Run the IBM Sales Center client by clicking Run > Run.

2. Click Application > Open > IBM Sales Center - Order Management.

3. Click File > Logon.

4. Find and select a store by clicking Store > Select and finding a valid store.

5. Create an order by clicking Order > Create.

6. Click the Payment tab.

7. Click in one of the new fields and then press the F1 key. The user interface is displayed as follows, with the new text:

   

< Previous | Next >

+

Search Tips   |   Advanced Search