Adobe AIR layout

You configure the settings for the Help application installer.

 In the General tab of the Adobe AIR dialog box, set the following under the Installer Settings group:

Digital Certificate

A digital signature ensures that the Help system (or its updates) has not been altered or corrupted since it was created. All Adobe AIR applications require a digital signature and can't be installed without one. If your organization has purchased one from a certificate authority, click Browse to select it. Otherwise, click Create to create a self-signed (and reusable) certificate. See Create a self-signed digital certificate.

Password

Enter the password assigned to the digital certificate.

Include Timestamp

Select to include a timestamp on the digital certificate. The timestamp provides information on how long the certificate is valid.

Program Menu Folder

Specify the program menu folder name. For example, on Windows, the string that you specify is appended to form the path Start > Programs > [program menu folder name] > [Help system title].

Create content categories to publish the output as a package of user-centric Help systems (for example, a package of Help systems for different user roles, geographies, products, or platforms).

End users view the output as an integrated package of Help systems and have the flexibility to select the Help system they want to access from a drop-down list. Each Help system has its own TOC, index, browse sequences, and search.

 In the Content Categories tab of the Adobe AIR dialog box, do the following:

• To create a content category, click New and specify a name.

• To rename a content category, select the category. Click Rename and specify another name.

• To delete a content category, select the category and click Delete. Click Yes to confirm.

• To change the order of the content categories in the drop-down list from which users select, use Up or Down keys.

• To specify a content category as the default catgory, click Set As Default.

Appearance settings define the appearance for the Help viewer window.

 In the Adobe AIR dialog box, select the Template group and set the following:

Template

Select a template from the pop-up menu.

Skin

Select a skin from the pop-up menu. Alternatively, click Gallery to select a skin from the skins available for the selected template. You can preview a skin before selecting it.

Copyright

Specify the entity that owns the copyright of the Help application. This entity is usually the name of the company publishing the Help content. The copyright notice appears in the About box (Help > About).

Description

Specify a description for the Help. The description appears in the About box (Help > About).

Favicon

(Browser-based Help) Specify an icon to associate with the Help system. The icon appears in the browser tab.

Width and Height

Set the width and height of the Help window.

Specify Branding options

Click to specify an icon for your Help system in different sizes and specify other branding options.

The following sizes are used by the operating system to display the Help system icon in predefined locations, such as the title bar, the taskbar, and the About box:

• 128x128

• 48x48

• 32x32

• 16x16

If you do not specify your own icon, the operating system defaults are used. For best results, provide an image for each of the specified sizes. In addition, make sure that the icons look presentable in both 16- and 32-bit color modes. Icon files must be in the PNG format.

You can also display your company logo in the top-right corner of the Help application and copyright information or any brand-related information in the status bar. The image size for the logo is 32x32.

In the Adobe AIR dialog box, select the Search group, and set the following:

Enable Highlight Search Results

Select to enable highlighting of search results. Topics that match the search criteria appear with the search term highlighted. Click the Text pop-up menu to set the highlight color.

Show Context In Search Results

Select to have the search results displayed along with the first few lines of the topic.

Enable Substring Search

Select to have search results include not only the exact search string but also text in which the string is embedded. For example, a search for “log” returns topics containing the words “catalog” and “logarithm.” A substring search takes longer than a whole-string search.

Enable External Content Search

Select to display content from identified URLs outside the Help system. For information about how to specify URLs and associate them with search terms, see External content search.

Hide Rank Column In Search Results

Select to not display the Rank column in search results.

Show Total Number Of Search Results

Select to show the number of search results for a specific search string.

Allow AND Search In Output

Select to display only those topics that have all the words that are specified without using quotation marks in the Search box. By default, RoboHelp performs OR search when a user types multiple words without enclosing them in quotation marks. This means that RoboHelp finds all topics that have any of the words specified in the Search box.

Note: AND search can be used in combination with phrase search.

Select the Enable AND Search By Default option if required. If you allow AND search disable it by default, end users have the option to enable it in the output.

Note: In merged projects, child projects inherit the setting of the parent project. In projects with DUCC (content categories), the setting applies to all content categories.

Exclude Baggage Files Types From Search

Select the types of baggage files to exclude from search.

Collaboration settings are available for Adobe AIR Application only.

 In the Adobe AIR dialog box, select the Collaboration group, and set the following:

Enable Topic Rating

Enables users to rate any topic on a scale of 0-5 stars.

Enable Commenting

Select to enable commenting.

Enable Comment Moderation

Select to allow acceptance or rejection of comments by authorized users (moderators).

Note: When you distribute the output, make sure that you share the moderator password. See Distribute Adobe AIR output.

Set Location For Comments And Topic Ratings

Depending on whether you want a trust-based system or user authentication, select one of the following options:

• Select Network Folder. Click Browse to choose the shared network folder where the comments will be stored. Click Add to add locations on Mac and Linux systems if required. See URL formats for Windows, Mac, and Linux.

  Specify the password that moderators need to provide to access the moderation dashboard.

  Select Pending or Accepted to specify how you want to handle unmoderated comments. If you select Pending, unmoderated comments are not displayed to users.

  Storing comments in a shared network folder is suitable in trust-based work environments, where shared reviews by internal stakeholders are part of the content development process.

• Select RoboHelp Server and specify the server URL.

  Storing comments on RoboHelp Server enables you to authenticate users before allowing them to view or post comments.

Configuration File Path

Specify the path and name of the file that stores the configuration for comment syncing and auto-update. When the AIR application is distributed, users can copy the default configuration file from the !SSL folder of the project to the location specified in the configuration file path and modify the default settings according to their preferences. For example, they can disable commenting or change the location of storing comments.

You can enter the path in any of the following formats:

• A relative path (relative to the install folder)

• An absolute location, such as a shared network drive or a file location in the user drive

• A web URL pointing to the location where you’ve posted the XML file

You can directly upload the generated browser-based Help to a server. Consult your system administrator for information about which server to use.

1. Select Server in the Adobe AIR dialog box.

2. Click New. Specify the following options in the New Destination dialog box:

   Descriptive Name

   Name for the server to publish the Help system to. For example, if you are publishing a Help system for internal review, enter “Internal Review Server.”

   Connection Protocols

   Select the protocol for connecting to the server or the sharing platform. Select FTP, HTTP, File System, or SharePoint.

   These are the FTP server connection details:

   Hostname

   Enter the host name of the FTP server.

   Port

   Enter the port number. Typically, FTP connections use the default port, 21.

   User ID and Password

   If your FTP server requires user authentication, enter the user ID and password that your system administrator provided for you.

   Anonymous User

   Select Anonymous User if your FTP server allows anonymous FTP. You do not require a user ID and password for connecting to the FTP server.

   Specify these details for the HTTP server connection:

   Host Name

   Enter the host name of the server.

   Server Directory

   Enter the directory on the HTTP server to place the Help system contents. Some HTTP servers require a trailing slash (/) at the end of the path.

   Select File System and enter the destination path if you have access to a network path where you can directly upload your Help system contents.

   For the File System server connection, specify the destination path.

   For the Microsoft SharePoint server connection, specify the SharePoint directory path. If the SharePoint site path is mapped as a network drive on the system or added in network paths, you can use the browse button to select the network path.

3. Set the following options:

   Check For Deleted Files

   Check for files that have been deleted from the destination.

   Prompt Before Overwriting Files

   Receive a warning before overwriting files on the server.

   Republish All

   Republish all files to the destination, overwriting existing files on the server.

   Note: If you are setting options for a master project, and a copy of the subproject is in the output folder, ensure that Republish All is not selected.

4. To publish Help, click Save And Generate.