HTML for Plug-ins

Structure for the HTML plug-in

<URL Uniform Resource Locator. The global address of documents and other resources on the World Wide Web.>http://gmail.google.com/gmail</URL>

<Publisher>Google</Publisher>

<Description>Launches Google's Gmail Service</Description>

<Menu>Launch GMAIL</Menu>

</Language>

<Name>eegay ale-</Name>

<Publisher>oogle-Gay</Publisher>

<Description>aunches-Lay oogle-Gay’s eegay ale- Urvice-Say</Description>

<Menu>aunch-Lay eegay ale-</Menu>

</Language>

</Description>

</DefaultPos>

</DefaultSize>

</PlugInDef>

</PlugInDefs>

HTML plug-in details

The root node must be PlugInDefs and as the name implies, multiple plug-ins can be installed under one definition file. For each plug-in, there is a PlugInDef. The child nodes for PlugInDef are:

■ URL: The URL for the HTML HyperText Markup Language. The authoring language used to define the structure and layout of a Web document by using a variety of tags and attributes. file or Web site must be http://, https://, or file://.

■ QueryString: The querystring to be tacked on to the end of the URL. Can contain GoldMine field macros that will be evaluated on launch of the plug-in. The macro wrapping structure is <<field>>, like <<&Contact>> or <<Contact1->AccountNo The Account Number field uniquely identifies a contact record and is the common field value that links the Contact1 table to Contact2, Cal, ContSupp, ContHist, and OpMgr.>>.

NOTE: You must XMLEncode the macros as shown in the structure above.

■ Description: The values here describe the item to the user and can contain multiple languages to describe the file, using the locale code associated with the target language. One language structure must be marked as IsDefault and is used in case the target language is not supported by the plug-in. Use XML Acronym for Extensible Markup Language. XML is a universal format that uses tags for exchanging structured documents and data on the Internet. entities in place of extended characters. For example, Ñ would be Ñ.

○ Name: Dialog name used for security.

○ Publisher: Your company name. Creates a sub menu under the Plug-ins menu.

○ Description: Used in the Help > About Plug-ins button.

○ Menu: The text the user sees for a menu item.

■ OnDemand: Determines if the plug-in is added to the plug-ins menu. 1 = True, 0 = False. If false, the item is started up with GoldMine.

■ StartUp: Determines if the item is started up with GoldMine. This is for situations where you want it to start, but if the user closes the window you want them to be able to access the plug-in via a menu. 1 = startup with GoldMine, 0= don’t start with GoldMine.

■ MultipleInstance: Determines if multiple instances of the plug-in are allowed. 1 = allow multiple instances, 0 = false. When false, if the user chooses the menu item for that plug-in, GoldMine will bring that window to the front and give it focus. non-OnDemand, Modal, and non-visible plug-ins are automatically single instance.

■ Modal: Determines if any action can occur outside of the window in GoldMine. 1= Modal, 0 = Modeless. Startup/non-OnDemand items cannot be modal. Modal items are strictly single instance.

■ DefaultPos: The coordinates where your dialog first appears. This is only used the first time the plug-in is run and is ignored for Modal plug-ins, which automatically center in relation to the GoldMine window.

■ DefaultSize: Describes the height and width of the dialog box for first time use or for modal windows, which cannot be resized.

■ Visible: Determines if the user can see the window. Not recommended for HTML-based plug-ins.