Stonefield Query includes extensive HTML-based help (Index.htm in the Help folder) that describes all the functionality and provides a "how to" section. However, it's likely you'll need to customize this help, especially if you change the Application Name or other configuration settings. Fortunately, Stonefield Query Studio can do much of the work for you.

Creating customized help

To create customized help for your Stonefield Query project, do the following:

  • Fill in the Support Contact Information configuration setting if it isn't already.

  • Choose Create Help Files from the File menu or the shortcut menu or click the Create Help Files button in the toolbar.

This creates a subdirectory of the current Stonefield Query project directory called Help and places the help files into this subdirectory. The help files are customized according to the current configuration settings. For example, all references to "Stonefield Query" are changed to the value you specify for the Application Name configuration setting.

If the Support Contact Information configuration setting isn't filled in, the Technical Support help topic won't be complete, so you are prompted whether you want to continue. If you choose No, that setting is automatically selected so you can fill it in and try again.

After generating the help files, Studio prompts if you want to open the help. If you choose Yes, it opens the help in a browser window. You can also display the generated help any time you wish by choosing Display Help from the File menu.

The help doesn't look very good in Internet Explorer 10. We recommend using IE 11 or Chrome.

Further customizing help

Although the Create Help Files function does much of the customization work for you, you may have to customize additional things in the generated help project. Here are the most common topics to customize (topics referred to in the instructions below with "Stonefield Query" in the topic name actually appear as whatever you changed the Application Name property to in your help file):

  • Add any additional information desired to the Technical Support topic under the Stonefield Query heading.

  • If you create a Setup plugin, add a topic under the Using Stonefield Query section describing any additional options you defined in the plugin.

  • You must not remove the Copyright topic under the Stonefield Query heading. Although you may change other text in this topic, you must not remove Stonefield's copyright from this topic. In other words, the following text must remain in this topic:

    © 1996-2016 Stonefield Software Inc. All rights reserved.

    You may add additional copyright marks of your own.

Edit the HTML files for the appropriate help topics using your favorite HTML editor. Note that the names of the HTML files are system-generated names like _0QX0T1ZEU.htm. To find the file to edit for a topic you want to change, hover your mouse over the topic in the topics list and note the name of the file it's linked to.

Help Placeholders

Part of the help customization process is the replacement of placeholders in the help text with the appropriate configuration settings. Here's a list of each placeholder and the associated setting:

PlaceholderSetting
llMultiLanguage Support multi-languages
lcDemoDays Number of days for demo version
lcAppName Application name
lcShortAppName Short application name
lcCompany Company name
lcWebSite Company web site
lcTwitter Company Twitter URL
lcFacebook Company Facebook URL
lcEmail Support email
lcContactInfo Support contact information
lcSupportCenter URL for technical support site
llSupportCenter True if the URL for technical support site setting is filled in
lcKBURL URL for Knowledgebase
llSupportKB True if the URL for Knowledgebase setting is filled in
lcFeedURL URL for news feed
llSupportNews True if the URL for news feed setting is filled in
lcImage Logo image file
llMultiple Allow multiple data sources
llDataGroups True if there are any data groups defined
llUsersCanRegister Users can register on login page
llTenants Support multi-tenant environment
llManageDSN One or more databases have Connection Type set to *User can choose DSN*
llManageConnString One or more databases have Connection Type set to *User can manage connection string*