Learn how to customize the publish output format settings like title, favicon, layout, responsive design, table of contents and much more when publishing to HTML5 with Adobe FrameMaker.
The Outputs tab of the Publish Settings dialog provides options to customize publish output format settings such as the title, favicon, layout, and table of contents (for eBook output formats).
The following tables describe all options available in the Outputs tab.
The following options are available in the General tab.
Option |
Description |
Available in |
---|---|---|
Title |
Specify a title for your output. You can use variables to dynamically generate titles. For example, you can use the variables as:
(Default) Name of the output being published.
Name of the FM file/book being published.
Value of variable VarName as defined in the FrameMaker source document/book. Note: VarName cannot contain the / (front-slash) character.
|
|
Favicon |
Specify an icon to associate with the output. The icon appears in the browser tab or the address bar depending on the browser being used. |
|
Language |
Specify the output language for the layout if the language is different from the language of the project. FrameMaker uses this language setting for the UI strings and language-related UI elements in the preview and generated output. |
|
Encoding |
Specify the character encoding format if the web server to which you are publishing has character encoding different from UTF-8. |
|
Manage layout |
Customize or use an existing layout for the published output. The drop-down list provides the following options:
|
|
Use HTML Page Template |
Import a .htt, .htm, or .html template file to define and create a mini TOC in the published output. For details on how to define the HTML page template, see HTML page templates. |
|
Override Styles for This Output |
Import a .css file to override the defined output styles. |
|
Enable Browse Sequence |
Specify whether the output should display browse sequences. |
|
Use Dynamic Content Filter in the Output: |
Assign a dynamic content filter to the current output. For details on how to create a user dynamic content filters, see Dynamic Content. |
|
Table of Content Settings |
A table of content to display in the generated Help. You can choose Index, Glossary, or both. Also, you can specify the positioning of Index and Glossary in the published output. |
|
Validate EPUB 3 Output |
Set FrameMaker to validate the EPUB output using the standard EPUB validation tool EpubCheck. EpubCheck requires Java Runtime 1.5 or above installed on the computer. Note: If the EpubCheck.jar file
is not available on your computer, download it from the link provided
in the EPUB Validation dialog box. Validation messages are available
only in English.
|
|
Embed Fonts |
Embed the selected fonts into the eBook. Use this option, if you are creating content that includes uncommon fonts, or if you are using custom fonts that may not be available on the end-users’ environment. Since the fonts will be included as part of the eBook output, the user experience will be uniform even if some users do not have the font installed. When you check this option, the Embed Font dialog is displayed. In this dialog, you can choose to embed fonts that are currently included in your RoboHelp project. You can also choose embed system fonts that are not currently included. Click the Manage button to open the Embed Fonts dialog to make changes to the currently embedded fonts. |
|
Show KindleGen Logs |
Select to display the errors, warnings, and status messages generated by the KindleGen converter in the Output View panel. |
|
KindleGen Path |
|
|
Add Breadcrumbs Links |
Add breadcrumbs in the topic pages. |
|
Optimize CHM File Size |
Reduces the size of the CHM file. |
|
TOC/Index Settings |
Open the HTML Help – Advanced Settings dialog and configure the following settings: In the Index tab:
The TOC Styles tab has the following options in addition to the options available in the Index tab:
|
|
The following options are available in the Optimization tab.
Option |
Description |
Available in |
---|---|---|
Convert Absolute Image Size to Relative Image Size |
Convert the actual width and height of images into percentages. In this way, you can make images used in your project device-friendly and adapt to different device sizes. |
|
Convert Absolute Table Size to Relative Table Size |
Convert the actual width and height of tables into percentages. By allowing FrameMaker to optimize the tables in this way, you ensure that the tables adapt to different device sizes. |
|
Enable Zoom On iOS Devices |
Enable or disable pinch zoom on the iPad and the iPhone. When this option is enabled, users can zoom in on a FrameMaker output displayed on an iPad or iPhone by pinching the device screen. |
|
Convert SVG to Raster Image |
Convert the SVG images in the document to rasterized images. By default, FrameMaker embeds the entire SVG code in the final Responsive HTML5 output. SVG images retain their image quality regardless of the screen size and resolution of the device on which they are being viewed. |
|
Original image referencing: FrameMaker maintains all image formats supported on web pages in your unstructured documents as-is in the HTML5 output for them. The images do not undergo any conversion process and the quality and specified size of your images is maintained. Other image formats that are not supported on web pages like .bmp and .tiff are converted to .jpg, but the image quality is improved for them. The original names of the referenced images are retained as-is when they are published into the HTML5 format.
The following options are available in the Search tab.
Option |
Description |
Available in |
---|---|---|
Enable Substring Search |
If you enable this feature, a search for “log” returns topics containing the words “catalog” and “logarithm.” Substring search takes longer than whole-string search. |
|
Show Context in Search Results |
Select to have the search results displayed along with the first specified number of characters of the topic. |
|
Number of Characters in Search Context |
Number of characters to display as defined in Show Context in Search Results. |
|
Number of Results on a Page |
The number of search results to display on each page. |
|
Generate XML Sitemap |
Select to generate a sitemap for your published output. In the published output, you will find the sitemap.xml file, which contains the sitemap of your published output. You can submit the sitemap.xml file to your search engine to improve the search results for your site. As different search engines use different process for sitemap.xml submission, ensure you follow the correct process as described in the search engine’s documentation. |
|
Base URL of the Help System |
Specify the base URL of your site where you plan to host the published output. If your base URL is different from your primary domain, then you must add the location of the sitemap.xml file in the robots.txt file. For example, if your site's primary domain is www.example.com and you plan to keep the sitemap.xml file at the www.example.com/ProductName/help/ location, then you must add an entry of the sitemap.xml file in the robots.txt file. Else, if the sitemap.xml file is saved at the same location as robots.txt, then you do not need to make any changes in the robots.txt file. |
|
Content Change Frequency |
Select the frequency at which you intend to update your help system or website. Search engines can use this information to revisit your site for indexing updated content. |
|
The following options are available in the Server tab of the Responsive HTML5 output.
Option |
Description |
---|---|
Servers |
Click New to add details of the RoboHelp Server where you want to publish your project. In the New Destination dialog, specify the following details:
Click Edit to make changes to an existing RoboHelp Server configuration. Click Delete to remove the saved configuration. |
Check for Deleted files |
When selected, FrameMaker checks for files that have been deleted from the destination location and republishes them. |
Prompt before Overwriting files (no overwriting when batch generating) |
When selected, FrameMaker prompts before overwriting files. However, it will not overwrite files in case you are generating the output using the batch generate feature. |
Republish All |
Select this option to republish all files at the destination, overwriting existing files. Note: If
you have updated any document in your book, you will have to regenerate the
updated content locally. However, only the updated documents are published
on RoboHelp Server.
|
The following options are available in the Meta Information tab of the EPUB and Kindle output formats.
Option |
Description |
---|---|
Author(s) |
The name of the author. To specify multiple author names, use comma as the separator. |
Publisher(s) |
The name of the entity responsible for making the output available, for example, the author or the organization. |
Rights |
A statement about rights, for example, a copyright notice. |
Description |
A description of the content. |
Publication Identifier |
An identifier conforming to specifications, such as ISBN. |
Publish Date |
The date of publishing the output. Follow the format specified in Dublin Core™ Metadata Element Set and W3C Date and Time Formats. |
Cover Image |
Specify the path for a JPG, JPEG, or PNG image that you want to use as the cover page of the eBook and the dimensions. Use percentage values to allow browsers to optimize display for different-sized screens. You can also specify a GIF image. However, in the case of a GIF animation, only the first frame is used as the cover page. Note: If you do
not specify a cover image, FrameMaker uses the first topic in the
TOC as the cover page.
|
Custom Metadata |
Specify additional EPUB 3-specific metadata in XML format. For more information on specifying metadata for EPUB, refer to section The metadata Element in the EPUB Publications 3.0 specification. For example, if you want to add the identifier type (ISBN, UUID, DOI, etc.) for a Publication Identifier, you can use the XML format below:
|