In RoboHelp, the Mobile App output preset allows you to generate an Android or iOS mobile application as your project output.
To generate a mobile app using RoboHelp, you require a PhoneGap account. If you don't have a PhoneGap account, you can create one in the PhoneGap ID section of the output preset settings in RoboHelp.
The first step in generating the output of a RoboHelp project is to create an output preset and then configure the various settings of the output preset. You can use the following settings to configure a Mobile App output preset:
Title Specify the title for the generated output.
You can use variables in the title. To do so, type Ctrl + 1 and select a variable from the drop-down list, and then press Enter. Note that if you have provided a variable set in the Content tab > Variable Set field, during output generation, the value of the selected variable is picked from the variable set.
The title, along with the variables if used, appears on the browser tab of the output.
Language Use the drop-down list to specify a language for the output preset if the language of the UI of the generated output needs to be different from the language of the content.
Encoding Use the drop-down list to specify the type of character encoding format to be used for your content.
Post Generation Script To run your custom script after output generation, select the script .js file from the drop-down list.
Table Of Contents Use the drop-down list to select a Table of Contents to be included in the output. This drop-down list displays the Tables of Contents available in your project. The first Table of Contents in this drop-down list is selected by default.
The set of files and their references present in the selected Table of Contents appear in the generated output.
Browse Sequence Use the drop-down list to view the defined browse sequences in your project. You can select more than one browse sequence. The selected browse sequences are then merged for the output. If there is a conflict with the selected browse sequences, the first selection is given preference.
Default Topic Click to select the topic that displays in the Topic panel when you open the output. By default, the first topic in the Table of Contents selected for this output is the default topic.
You can also select the default topic from the merged child projects. The list shown under the merged child projects is read from the selected TOC.
Include Index Select this setting to include the index page in the output.
Glossary Use the drop-down list to select the glossary to be included in the output. The glossary helps your users to quickly retrieve the relevant terms in your project, with the corresponding definitions.
Condition Expression Use the drop-down list to specify the condition expression for your output. This setting allows you to easily include or exclude content depending on the desired type of output or userbase. Click to edit the selected condition expression. You can also select None in the drop-down list to not specify any condition expression.
Dynamic Content Filter Use the drop-down list to select a dynamic content filter so your end users can filter content in the generated output. Click to edit the selected Dynamic Content Filter. Alternatively, select None in the drop-down list to not specify a dynamic content filter.
Variable Set Use the drop-down list to specify the variable set to use in this output. In the drop-down list, you can select <Default Variable Set> to use the project's default variable set. Variable sets allow you to implement output-specific use of variables. For example, you can have different variable sets for generating output for customers and internal users.
Master Page Use the drop-down list to select the master page for the output you are generating.
Skin Use the drop-down list to select a skin to apply in your output.
Show Thumbnail for Images Select this field to show thumbnail for images in output.
- Create Thumbnail for images Select this field to generate image thumbnails from existing images in the output. These images can be enlarged when the user clicks them.
- Style Existing Images as Thumbnails Select this field to style existing images as thumbnails in the output. These images can be enlarged when the user clicks them.
Use topic description as search context Select this setting to display the topic description with the title in search topic results. In Set a Character limit, enter the maximum number of characters to be displayed in the topic description. To set a topic description, right-click a topic in the Contents panel and select Properties. In the Topic Properties dialog box, enter the description in Description and click Apply.
Enable auto complete in search box Select this option to display predictive options for the search query based on the initial characters typed by users.
Auto correct search query Select this option to correct misspelled terms that are typed during search. This setting corrects up to one character in each word typed during search. This ensures that you receive relevant search results, even if you enter a misspelled term.
Show definitions from glossary Select this option to display definitions of search terms from the glossary selected for this output. If the search term matches a glossary term, the definition of the term is displayed.
Select file types to exclude from search You can exclude specific types of files, such as PDF, Word, and Excel, from search. The content from the selected files will not be included during search.
Package Specify a name for the mobile app. A common naming convention is to use your company domain name in reverse followed by the name of the app. For example, com.adobe.myapp. This is used by PhoneGap to uniquely identify the application.
To avoid issues with third-party tools used in PhoneGap, use English letters, the underscore character, and a period as the separator.
Version The PhoneGap version number for the app.
Version Code (Android only) The Android version number for the app. This is a positive integer that increases by one value each time you update the app. When you upload your app to an Android store, such as Google Play, your user will be notified of updates to your app when you update the version number.
Title The name of the mobile app. This is displayed in Google Play Store or App Store and on the mobile device when a user installs the app.
Description Specify the PhoneGap description for the app.
Icon Specify the icon that is associated with the application. This is displayed in Google Play Store or App Store and on the mobile device when a user installs the app.
Splash Screen Specify the splash screen for the app.
User ID Enter the user ID of your PhoneGap account.
Password Enter the password of your PhoneGap account.
Create PhoneGap Account Click this if you don't have a PhoneGap account. You will then be directed to the PhoneGap plans page.
Validate User ID Click this to test your PhoneGap credentials. If this fails, go to phonegap.com and log in with the same credentials. After you log in to phonegap.com, retest the credentials in RoboHelp.
Generate iOS App Select this option to generate an iOS app as your output and specify the following:
- Digital Certificate Upload the digital certificate of the app. Click to do this.
- Certificate Password Enter the password of the digital certificate.
- Provisioning Profile Specify the digital certificate. Click to do this. The digital certificate contains details of the registered testing device. If the APP is not posted on the App store, it can be installed only on registered testing devices.
Generate Android App Select this option to generate an iOS app as your output and specify the following:
- Keystore File Click to upload the keystore file. This is to authenticate your app. When you sign an Android app, it means that you brand your app with your credentials. You can brand multiple applications using the same key.
- Keystore Password Specify the password of your keystore file.
- Certificate Alias Specify the alias name of your keystore.
- Certificate Password Specify the password for the alias name of your keystore.
The settings marked with * are mandatory fields; you need to configure these settings to successfully generate an app.
You can publish your output to FTP, SFTP, or File System. To be able to publish your output, first configure a publish profile for the appropriate server type. For more information, see Configure a publish profile for FTP, SFTP, or File System.
After you save the publish profile, RoboHelp displays the profile in the Publish tab. To publish your output, select the appropriate publish profiles and click .
By default, only modified files are published using the chosen publish profiles since the last publish.
To publish all files, select Republish All and click . To view the publish log, in the Output Presets panel, against the appropriate output preset, choose > View Publish Log.
Click the Generate Preset icon in the Output Presets panel.
You can then view a progress bar next to the selected output preset in the Output Presets panel. Once the output generation is complete, a Success dialog box is visible at the lower-right corner of the screen.
After the output generation is complete, click in the Output Presets panel to view the Mobile App output dialog box. Click Download to download the app to your computer. You can download and allow other users to download the app onto mobile devices by scanning the given QR code or by navigating to the URL on the devices.
iOS apps can only be installed using this URL if your device UDID is added in the mobile provision file.
Alternatively, you can generate the output in the authoring window. Click Quick Generate on the toolbar, select the desired output preset, and click Generate.
You can then view a progress bar in the Quick Generate dialog box. After the output generation is complete, click next to the output preset to view the Mobile App output dialog box. In case the output generation failed, click next to the selected output preset to view the error log.
After you have configured your mobile app settings, you can then generate the app. This app is the uploaded to the PhoneGap server. You can then either download the app to your computer or you can use the QR code to download the app to your mobile device.
To upload the app to the Apple or Android app stores, follow the instructions in the following articles: