Converting FrameMaker content

Convert FrameMaker paragraph formats to RoboHelp styles

By default, RoboHelp converts all paragraph formats from FrameMaker to RoboHelp CSS styles, thus retaining the appearance and behavior of the FrameMaker formats in the RoboHelp project. To ensure consistency of the online Help projects, map the FrameMaker formats to RoboHelp styles and edit them.

1)Select Project > Project Settings.

2)In the Import tab of the Project Settings dialog box, click Edit under FrameMaker Document.

3)On the Conversion Settings panel, select the FrameMaker format from the Paragraph group.

4)From the RoboHelp Style menu, select the RoboHelp style that you want to map to the FrameMaker format. To retain the appearance of FrameMaker text in the online Help format, select [Source].

To edit the selected RoboHelp style, click Edit Style.

5)Select the properties for the mapped RoboHelp style:

Exclude From Output

Select to discard the content in FrameMaker document that is applied with the selected FrameMaker paragraph format.

Pagination (Split into topics based on this style)

Select to create a Help topic at each occurrence for the selected FrameMaker paragraph format. For example, if you select Heading 1 and Pagination (Split into topics based on this style), RoboHelp starts a new topic at every instance of Heading 1.

User Defined HTML Tag

Select or enter a user-defined HTML tag for the selected paragraph format.

If the selected FrameMaker format has auto numbering properties defined, specify how auto numbering is converted.

Convert FrameMaker character formats to RoboHelp styles

You can map the FrameMaker character formats to character styles in RoboHelp.

You can also edit the styles in RoboHelp.

1)Select Project > Project Settings.

2)In the Import tab of the Project Settings dialog box, click Edit under FrameMaker Document.

3)Select the FrameMaker character format from the left pane of the Conversion Settings dialog box.

4)Select the RoboHelp character style from the pop-up menu. Optionally, you can do the following:

To import the FrameMaker character format, select [Source] from the pop-up menu.

To edit the selected RoboHelp style, click Edit Style.

To exclude the text in the FrameMaker document applied with the selected character format, select Exclude From Output.

To apply a user-defined HTML tag to the imported text in HTML output, select User Defined HTML Tag, and select the tag from the pop-up menu. You can also enter a new HTML tag. The custom HTML tag for the character format replaces the <span> tag in the generated HTML file.

Exclude a FrameMaker paragraph format from Help topics

You can exclude the content in FrameMaker documents that has a specified paragraph format from the converted output. Use this option to remove content such as special notices that are not required in online output.

1)Select Project > Project Settings.

2)In the Import tab of the Project Settings dialog box, click Edit under FrameMaker Document.

3)In the project settings, select a FrameMaker paragraph format in the left pane.

4)Click Exclude From Output.

Custom HTML tags

You can define or apply a custom HTML tag instead of the standard <p> tag for paragraph styles and <span> tag for character styles in the HTML output for the formats that you import from FrameMaker. You can define separate HTML tags for each format in the FrameMaker document.

1)Select Project > Project Settings.

2)In the Import tab of the Project Settings dialog box, click Edit under FrameMaker Document.

3)In the Conversion Settings dialog box, select the user-defined HTML tag option.

4)Type the name of the custom HTML tag or select an existing tag to use instead of the default HTML tag.

Autonumber style mapping

Choose the conversion setting for converting autonumber formats in the FrameMaker document to the Help format. If the FrameMaker document contains hierarchical numbered lists, you can choose one of the following:

Ignore Autonumber

Choose this option if the autonumber text is relevant only in print format. The converted para­graph does not contain autonumbering. For example, suppose you ignore autonumbering for the FrameMaker paragraph format "Section2 Level." In this case, "Section 1.1: System Require­ments" in the source appears as "System Requirements" in the RoboHelp topic generated.

Convert Autonumber To Text

Choose this option to retain the appearance of the FrameMaker numbered lists. The auto­number part loses its sequencing properties and appears as part of the paragraph text in Robo­Help topic.

Convert Autonumber To HTML List

Choose this option to convert the autonumber to HTML lists using HTML tags such as <ol>, <ul>, and <li>.

Convert Autonumber To RoboHelp List

Choose this option if you want to edit the generated HTML topics in RoboHelp or use the RoboHelp styles to control the numbering properties.

List-mapping scenarios

RoboHelp allows you to convert list properties of FrameMaker paragraph formats in several ways. Consider the following scenarios:

FrameMaker numbered list mapped to [Source]

The FrameMaker paragraph format autonumber property converts to a list according the auto­number conversion settings you define for that FrameMaker paragraph format.

Ignore Autonumber

The autonumber part of the FrameMaker paragraph format is ignored. The converted para­graph style in the RoboHelp topic doesn't contain the list part.

Convert Autonumber To Text

The autonumber part of the FrameMaker paragraph converts to text and appears as paragraph text in the RoboHelp topic.

Convert Autonumber To HTML List

Autonumber format converts to list items using HTML tags such as <ol>, <ul>, and <li>.

Converted Autonumber To RoboHelp List

Autonumber properties of the paragraph style convert to a RoboHelp list.

Example:

Create a paragraph style "FM_Para1" in FrameMaker with autonumbering defined as <a+> and apply it to paragraphs. The resulting paragraphs are ordered as "a, b, c, ...."

Map the FrameMaker paragraph format "FM_Para1" to [Source].

Generated paragraphs in RoboHelp topics have the list style applied to them, where the list has prop­erties similar to those in the source document.

FrameMaker numbered list mapped to RoboHelp unnumbered style

You can map a FrameMaker paragraph format with autonumbering properties to a RoboHelp para­graph style that is not linked to any list style. In this case, the autonumber is converted to a list according to the autonumber conversion settings you define for the paragraph format.

Ignore Autonumber

The FrameMaker paragraph autonumber is ignored and doesn't appear in the RoboHelp topic. However, the paragraph style is mapped.

Convert Autonumber To Text

The FrameMaker autonumber part is converted to text and appears as a part of paragraph text in RoboHelp topic. The paragraph style is mapped.

Convert Autonumber To HTML List

The FrameMaker paragraph format is converted to HTML list items using HTML tags such as <ol>, <ul>, and <li>.

Convert Autonumber To RoboHelp List

The autonumber properties of the FrameMaker paragraph format are ignored. The paragraph style is mapped.

FrameMaker unnumbered format mapped to RoboHelp numbered style

In this case, the converted paragraph has the RoboHelp paragraph style and inherits the RoboHelp list style. The Autonumber conversion options do not affect the paragraph behavior in the RoboHelp topic.

For example:

In the FrameMaker document, create a paragraph format "FM_Para 1" without autonumber properties.

Define a RoboHelp list style "RH_List1" in the RH style mapping CSS.

Create a paragraph style "RH_Para1" and link the first level of list style "RH_List1" to the para­graph style "RH_Para1".

Map the FrameMaker paragraph style "FM_Para1" to RoboHelp paragraph style "RH_Para1".

The generated paragraph in the RoboHelp topic inherits the properties of the list style "RH_List1".

FrameMaker numbered list mapped to RoboHelp numbered list

The converted paragraph style has the RoboHelp paragraph style and inherits the RoboHelp list style. The Autonumber conversion options do not affect the paragraph behavior in the RoboHelp topic.

For example:

In FrameMaker, create a paragraph format "FM_Para1" with autonumbering defined as <a+> and apply it to a paragraph so that the paragraph has an ordered list such as "a, b, c, …."

Define a numeric list style "RH_List1" in the RoboHelp style mapping CSS with the first level definition as <x>.

In RoboHelp, define a paragraph style "RH_Para1" and link the first level of list style "RH_List1" to the paragraph style "RH_Para1".

Map the FrameMaker paragraph format "FM_Para1" to the RoboHelp paragraph style "RH_Para1".

The generated paragraph in the RoboHelp topic inherits the properties of list style "RH_List1" and displays a list of type "1, 2, 3, ...."

Convert FrameMaker table formats to RoboHelp table styles

You can map FrameMaker table formats to RoboHelp table styles. Alternatively, you can import the table formats from the FrameMaker document. You can also edit the table formats in RoboHelp. Cells in the FrameMaker document that are merged (straddled) cannot be unmerged (unstraddled); however, the straddled cells appear merged in the RoboHelp topic.

If the FrameMaker table formats contained table titles and table footnotes, convert these paragraph formats in FrameMaker to RoboHelp paragraph styles separately. Decide whether you want to retain automatic numbering in the table title styles and specify the autonumbering properties for the mapped RoboHelp paragraph style. For example, if the table title formats in the FrameMaker docu­ments included the chapter number, such as “Table 2-3: Quarterly Results”, you can choose to ignore the autonumbering part and have only “Quarterly Results” appear as the table title. See List-mapping scenarios.

1)Select Project > Project Settings.

2)In the Import tab of the Project Settings dialog box, click Edit under FrameMaker Document.

3)Select the FrameMaker table format from the left pane of the Conversion Settings dialog box.

Image conversion settings

Some FrameMaker documents, especially those optimized for high-quality printing through PDF, contain images in EPS format. Convert EPS images to web-supported image formats such as JPEG, GIF, or PNG for online Help.

You specify the following image conversion settings in the Conversion Settings dialog box:

Use Distiller To Generate Image

Select this option to generate web-friendly image formats from graphics linked and inserted in FrameMaker documents. You should use this option especially if you have vector graphics formats, such as EPS or AI, or graphics with text content in them.

Do Not Regenerate Images

Select this option to save time if you are re-importing FrameMaker documents and don’t need to update the images in the imported content.

Preserve 3D Images

Select this option to convert the 3D graphics as a PDF file, with the 3D rendering intact within the PDF file. To ensure that the 3D image retains its rendering, enable embedding in FrameMaker.

Preferred Dimensions

Specify the dimensions for the images. Select one of the following:

Scale

Scale images as a percentage of the existing size. The aspect ratio of the images is maintained.

Width and Height

Specify the absolute image size as Height and Width, in points. Select Maintain Aspect Ratio to ensure that the images are not skewed.

note:    To convert the images in FrameMaker documents to the actual dimensions of the images, specify the height and width as 0pt. The <img> tag for such images in the generated HTML does not have the height and width values. This conversion is irrespective of the dimensions of the anchored frames that contained the images.

Maximum Dimensions

Set the maximum dimensions for images in online format. Images that exceed the maximum dimensions you specify are automatically scaled down to fit the maximum size you specify. If you scale the images and specify an aspect ratio, RoboHelp scales the images within the maximum dimensions specified and maintains the aspect ratio.

Use this option to avoid large images causing the browser window to scroll horizontally or vertically. For example, if you specify the window size to be 800 x 600 pixels, you can specify the maximum dimensions to be 640 x 480, so that the images do not exceed the window size.

Margins

Set the margins for the images:

Set equal margins on all sides by setting the margin in All Sides.

To set margins on individual sides, set the margins on each side.

Borders

Set a border for the images:

To set a uniform border on all sides, select All from the Border pop-up menu. Alterna­tively, you can specify the side on which you want the border to appear from the pop-up menu.

To set the border style, select the style from the Style pop-up menu.

To set the border color, select the color from the Color pop-up menu.

To set the border width, select it in, in points, from the Width menu.

Format

Define the image format, color depth, and quality settings for the web-supported images that are converted from the images in the FrameMaker document:

As Is

Select this option for retaining the images in the current web-supported format.

JPG

Select this option for multicolor images such as screenshots or photographs. JPG format with a high color depth provides the best online quality, but increases the file size. Select this option for photographs.

GIF

Select this option if the FrameMaker document contains only line art, such as schematic diagrams.

BMP

Select this option only for small images such as icons and logos. BMP format images are large in size and uncompressed but rich in color and quality. Also, these images do not scale or compress well. Hence, this format is not suitable for web.

PNG

Select this option for screenshots.

JPEG Quality

Set the quality percentage for JPG images.

Color Bit Depth

Set the color bit depth for bitmap images. JPG and PNG formats can have either 8- or 24-bit color depth, while BMP images can have color bit depths of 1, 4, 8, 16, 24, or 32. GIF images can have only 8-bit color depth.

Grayscale

Select this option if you want monochrome images.

Preserve converted images

RoboHelp converts the images and anchored frames in the FrameMaker documents each time the topics are updated or generated. You can skip updating the images if the corresponding images or SWF files from the corresponding anchored frames are already present in the RoboHelp project. Use this option in the following cases:

You want to avoid regenerating the images each time the FrameMaker document is updated

You have edited the images in the RoboHelp project using another image-editing tool, and want to prevent overwriting of the edited images

You want to preserve the earlier generated image in the RoboHelp project even though the image in the FrameMaker document has changed

If the order in which the images appear in the document or the image name has changed, you should clear this option and allow RoboHelp to update the images.

1)In the Image tab of the Conversion Settings dialog box, select Do Not Re-Generate Images.

Create alternate text for images

To create accessible content, create alternate text (ALT text) for images so that visually impaired users can access the content through screen readers. If you link or import completed FrameMaker books into RoboHelp for publication, add alternate text to graphics used in the FrameMaker docu­ments. These entries are not visible in PDF files, but they appear in online content when the mouse hovers over the images. See FrameMaker Help to learn about setting alternate text for graphics and images.


September 30, 2016

Legal Notices | Online Privacy Policy