Customizing output specific settings

The Output tab of the Publish Settings dialog provides options to customize publish output settings such as the title, favicon, layout, and table of contents (for ebook output formats).

  1. To customize the output settings, open the Publish dialog.

  2. Click the Default button and choose Edit settings.

  3. In the Publish Settings dialog, go to the Outputs tab.

    The Outputs tabs displays the list of available output formats. You can customize the output settings individually for each of the output formats.

  4. To customize the output settings for a specific format, select the format in the Output format list.

Customize the Responsive HTML5 output settings

The Responsive HTML5 section of the Output tab allows you to customize the following settings:

In the General tab:

Title:
Specify a title for your HTML output. You can use variables to dynamically generate titles - for example to display the current document name:

Variable

Definition

<OutputName>

(Default) Name of the output being published.

<SourceFile ame>

Name of the FM file/book being published.

<$VarName>

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.

Layout -> Edit:
Customize the Layout
  1. The Layout Customization dialog displays a preview of the look-and-feel of the layout.

    Alternatively, to open the Layout Customization dialog, go to the Project Set-up pod:

    • Right-click on Responsive_with_Logo and choose Edit.

    • Click the Pencil icon on the Project toolbar.

    View full size graphic
    Layout Customization dialog
  2. Select a layout component from the Layout Components list.

    Each component has a set of customizable properties associated with the component.

  3. To edit a property, go to the property value in the Properties pane.

  4. You can go to a property in the Property pane by clicking the property in the Property pane and editing the value of the property.

    Alternatively, notice the Component preview pane displays the preview of the component. In addition, the preview pane displays buttons pointing to each property in the preview pane.

    You can click a property button in the preview pane to go to the property in the Properties pane.

    This will allow you to identify from the preview, the property that you are editing.

  5. To save your changes:

    • Click Save and Preview to save the updates and preview the changes.

    • Click Save to save the updates without preview.

  6. To reset all the component properties, click Reset component.

  7. To reset a specific component property, select the component (either from the Property pane or from the preview pane) and click Reset property.

  8. After you have completed the layout customization, click Close.

Layout -> Gallery:
Create a screen layout
  1. Select a screen layout from the available list in the gallery.

  2. Specify a name and description.

  3. Click OK.

HTML Page Template:
Import a .htt, .htm, or .html template file to define and create a mini-TOC in the published Responsive HTML5 output. For details on how to define the HTML page template, see Using HTML page templates.

Override Style:
Import a .css file to override the defined output styles.

Enable Browse Sequence:
Specify whether the output should display browse sequences.

In the Optimization tab:

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 RoboHelp 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.

In the Search tab:
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 above.

Number of Results on a Page
The number of search results to display on each page.

Customize the WebHelp output settings

The WebHelp section of the Output tab allows you to customize the following settings:

In the General tab:

The WebHelp General tab provides the most of the same options as provided in the General tab of Responsive HTML5 described above except the following option:

Use Lowercase File Names:
Create filenames that use only lowercase letters. This option is recommended for UNIX users.

In the Navigation tab:

Skin Selection:
(Optional) Apply skins to the publish output to customize the colors, buttons, text, fonts, and icons in the output.
In the Skin Selection drop-down list, choose:
Default:
To use the FrameMaker default skin

Traditional style - no skin:
To use no skin.

Alternatively, click Gallery to choose from a list of skins that are shipped with the FrameMaker publishing solution.

In the Skin Gallery dialog, choose:

Preview:
To preview the skin in a separate window.

OK
To use the skin.

You can also import WebHelp or compressed WebHelp skins defined in .skn or .zkn files, respectively. To import a skin, click Import and then select the .skn or .zkn file from the file system.

For more details, see the Skins section in the Using RoboHelp guide.

Toolbar Buttons:
Select navigation toolbar buttons to appear in the left pane.

Synchronize Table Of Contents:
Synchronize the TOC with the topic in the right pane so that users see where they are in the structure.
  • To synchronize the TOC automatically, click the pop-up menu and select Automatically.

  • To add a button that users can click to synchronize the TOC, click the pop-up menu and select Manually.

Note: If you use custom skins, provide a button icon in the WebHelp Skin Editor.

Add Breadcrumbs Links:
Add breadcrumbs in the topic pages.

Format:
Change the format of breadcrumbs.

Enable Browse Sequence:
Specify whether the output should display browse sequences.

Show Navigation Pane Link In Topics:
Select to include a link to the navigation pane in topics that are opened through the context-sensitive Help calls.

Search Input Field In Toolbar:
Include a search field in the main toolbar.

Add About Box:
Set up information that appears in a dynamic window when users click the image in the main toolbar.

In the Search tab:
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.

Enable Highlighting In Search Results:
Select to enable highlighting of search results. From the pop-up menu, select a color for the highlight.

Show Context In Search Results:
Select to have the search results displayed along with the first few lines of the topic.

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.

Show 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, FrameMaker performs OR search when a user types multiple words without enclosing them in quotation marks. This means that FrameMaker 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.

Customize the ePub and Kindle output settings

The ePub and Kindle sections of the Output tabs allow you to customize the following settings:

In the General tab:

The Title, Language, and Override Style options are described above in the General tab of the Responsive HTML5 settings.

The Convert Absolute Image Size To Relative Image Size and Convert Absolute Table Size To Relative Table Size options are described above in the Optimization tab of the Responsive HTML5 settings.

Table Of Content Settings:
A table of contents to display in the generated Help.

Validate EPUB 3 Output:
(ePub format) 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.

Show KindleGen Logs
Select to display the errors, warnings, and status messages generated by the KindleGen converter in the Output View pod.

In the Meta Information tab, specify metadata to conform to the Open Packaging Format (OPF) specification:

Title:
A title for the output. By default, RoboHelp displays the project name.

Author(s):
(Optional) The name of the author. To specify multiple author names, use comma as the separator.

Publisher(s):
(Optional) The name of the entity responsible for making the output available, for example, the author or the organization.

Rights:
(Optional) A statement about rights, for example, a copyright notice.

Description:
(Optional) A description of the content.

Publication Identifier:
An identifier conforming to specifications such as ISBN.

Language:
The language in which the content is written. For information about the format, see Dublin Core Metadata Element Set.

Publish Date:
(Optional) The date of publishing the output. Follow the format specified in Date and Time Formats.

Cover Image:
(Optional) 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, RoboHelp 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 EPUB 3 specification for metadata.

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:

<dc:identifier id="pub-id">urn:doi:10.1016/j.iheduc.2008.03.001</dc:identifier> 
<meta refines="#pub-id" property="identifier-type" scheme="onix:codelist5">06</meta>

Customize the Microsoft HTML Help output settings

The ePub and Kindle sections of the Output tabs allow you to customize the following settings:

The Title, Language, and Override Style options are described above in the General tab of the Responsive HTML5 settings.
Add Breadcrumbs Links:
Add breadcrumbs in the topic pages.

Format:
Change the format of breadcrumbs.

Optimize CHM File Size:
Reduces the size of the CHM file.

TOC/Index Settings:
Open the HTML Help - Advanced Settings dialog

In the Index tab:

Default Window:
To display the topic in a custom window, select the window name.

Default Frame:
To display the topic in a custom frame, select the frameset name.

Font:
Use Select Font to choose a font. Click Default Font to set the selected font as the default font.

In the TOC Styles tab:

Border:
Add a border around the table of contents.

Dialog Frame:
Add a frame around the table of contents.

Lines From Root
Displays lines connecting books and pages starting at root.

Plus/Minus Squares
Display plus and minus icons that open and close books.

Always Show Selection
Display the topic selected from the Contents tab (even if this tab is not the left-pane focus).

Folders Instead Of Books
Display folder icons instead of book icons.

Lines Between Items
Add lines between books and pages.

Single-Click To Open Book
Enable books to open with one click.

Raised Edge or Sunken Edge
Create a three-dimensional appearance.

Binary TOC
Create a binary TOC.
Note: The binary TOC option is recommended only for large Help systems. It requires compiled HTML Help and does not support customization or external TOC files.