4 Generated Content

This chapter describes the use of generated content.

The following topics are covered:

4.1 About Generated Content

Generated content is made up of two kinds of elements:

  • Text Elements, which allow the user to insert text strings into the output from the template or from the server at the time of conversion.

  • Navigation Elements, which provide links to specific document elements.

4.2 Adding a Text Element

Text elements are a way to insert text specified in the HTML Conversion template directly into the output. Text elements work exactly the same way as custom document properties except text elements cannot be placed in the <head> of the document in a <meta> tag.

By default, no text elements are defined. In order to include them in the output from the conversion, each desired text element must first be defined here. They must then be added to the output from the conversion by inserting them into page layouts defined in the Output Page Layouts.

  1. Navigate to Generated Content > Text Elements. Click Add. The Text Element page is displayed.

    To remove a Text Element, select a defined text element from the list and click Remove. An element may not be removed if it is used by a page layout.

  2. In the Name text box, enter the name to use to reference this text element when creating/editing page layouts. This field is required.
  3. In the Value text box, enter the value to insert into the output when this text element is used in a page layout.
  4. In the Use output format drop-down box, select the name of the output format. This will be used to format the text element when including its value in the output as visible text. Output formats are defined under Output Text Formats.

4.3 Adding a Navigation Element

Navigation elements allow you to generate navigation links in the HTML output. The following sections define how to create the three kinds of navigation elements:

4.3.1 Adding Document Navigation

Document Navigation is a way to link to various items in the source document based on the document's structure. A common example of how one would use this type of navigation is to create links to all the paragraphs marked with outline level 1 (such as "Heading 1" paragraphs) in the document. Before using this form of navigation, link mapping rules must first be added. This is done on the Mapping Rules Tab.

  1. Navigate to Generated Content > Navigation. In the drop-down box, select navigation by . . . and then select either document element navigation, page navigation, or document section navigation. Select document element and click Add to add an element of that type. The Element Navigation page appears.
  2. In the Name field, enter a name by which the page layouts will refer to this navigation element. This is required.
  3. In the Link tag drop-down box, specify whether to use an anchor or option tag (<a> or <option>) to enclose the links in this element.
  4. Place a check in front of Generate parent levels when "orphan" levels are encountered to generate clean outline levels. When creating navigation based on outline levels, problems can arise when the document being converted is "sloppy" in its use of outline levels. An example of such sloppy outlining would be a paragraph tagged with outline level 1 followed later by one tagged with outline level 3 without an outline level 2 paragraph somewhere in between. That outline level 3 paragraph is considered to be an "orphan level."

    By setting this option, the Markup to insert before this set of links and the Markup to insert after this set of links entered in the Custom Attributes Tab from the link set (defined below) are inserted into the output for the orphan level.By default, this option is not set. An example of navigation that does not need to worry about orphan levels would be one where the link set did not need to define any Markup to insert before this set of links or Markup to insert after this set of links.

  5. Place a check in front of Only include links to targets on the same page to generate a small set of links to targets that all appear in the same output HTML page. An example of this would be to break a document up so there is one outline level 1 paragraph in each output HTML page. The user could then set this option as part of creating a line of links across the top of the page that go to all the outline level 2's that appear on the page.

    If this option is not set (the default), then links to targets across the entire document are generated.

  6. Enter a value for Word limit for labels to truncate the label after the specified number of words. The link's label is taken from the text of the document element the link goes to. Some target elements may contain large amounts of text. This can cause problems in the formatting of the list of links.

    Setting this option to 0, the default, causes the entire target element's text to be used as the link label.

  7. In the Link Sets section, you can add a definition (such as outline level 1) for which rules may be defined. Once link sets have been added, their order may be arranged by using the Levels up/down arrows. The order that link sets appear in the window establishes navigation hierarchy. When a link set is moved up or down, its name changes accordingly; for example, if two link sets are defined (Level 1 and Level 2) and the second one is selected and moved up, it becomes the Level 1 link set.
  8. The Link Sets section has four tabs:

    • The Mapping Rules tab allows the template author to define the target of the navigation, either by outline level or (case-sensitive) style name.

    • The Custom Attributes tab allows custom attributes to be applied to the links.

    • On the Markup tab, the tags or other markup for rendering the link set are defined.

    • Finally, the Formatting tab allows the template author to apply styling to the link labels, either directly or via an external CSS class.

  9. In the Mapping Rules Tab, you can mark document content for navigation. Match on either an outline level or style and provide the name in the Value field.
  10. In the Custom Attributes Tab, enter specific HTML tags that you want to appear in the output before and after the link set. Click the Add attribute button to insert a new "name/value" pair. Highlight a row in this table and click the Remove Attribute button to delete custom attributes.
  11. In the Markup Tab, you can specify custom markup that can be inserted before and after each link in the set, and/or between links.
  12. In the Formatting Tab, you can choose one of two ways to specify the formatting for links.

    If you place a check in front of Use external CSS class, then you must enter the name of a class from an external CSS file here. The URL of the external CSS file is specified with the External user stylesheet option set in Output Pages.

    If you choose to use Character Formatting, the types of character level formatting available are evident from the screen. Each type of formatting can be set to one of four values:

    • Always off - Forces the attribute to be always off when formatting the link.

    • Always on - Forces the attribute to be always on when formatting the link.

4.3.2 Adding Page Navigation

This provides a way to link to certain key pages in the output (first page, next page, etc.). It also provides a way to link to external pages (such as to http://www.oracle.com/).

  1. Navigate to Generated Content > Navigation. In the drop-down box, select navigation by page. Click Add to add an element of that type. The Page Navigation page appears.
  2. In the Name field, enter the name by which the page layouts will refer to this navigation element. This is required.
  3. In the Link tag drop-down box, specify whether to use an anchor or option tag (<a> or <option>) to enclose the links in this element.
  4. In the Markup Tab, enter any custom HTML tagging that should be inserted before, between, and/or after this set of links.
  5. In the Formatting Tab, you can choose one of two ways to specify the formatting for links.

    If you place a check in front of Use external CSS class, then you must enter the name of a class from an external CSS file here. The URL of the external CSS file is specified with the External user stylesheet option set in Output Pages.

    If you choose to use Character Formatting, the types of character level formatting available are evident from the screen. Each type of formatting can be set to one of four values:

    • Always off - Forces the attribute to be always off when formatting the link.

    • Always on - Forces the attribute to be always on when formatting the link.

  6. In the Page Link Tab, you can specify navigation links, and then determine their order.

4.3.3 Adding Section Navigation

This provides navigation for multi-section documents, such as spreadsheets and presentations.

  1. Navigate to Generated Content > Navigation. In the drop-down box, select navigate by document section. Click Add to add an element of that type. The Section Navigation page appears.
  2. In the Name field, enter the name by which the page layouts will refer to this navigation element. This is required.
  3. In the Link tag drop-down box, specify whether to use an anchor or option tag (<a> or <option>) to enclose the links in this element.
  4. In the Custom Attributes Tab, enter any custom name/value pair for a new tag attribute.
  5. In the Markup Tab, you can specify custom markup that can be inserted before and after each link in the set, and/or between links.
  6. In the Formatting Tab, you can choose one of two ways to specify the formatting for links.

    If you place a check in front of Use CSS class, then you must enter the name of a class from an external CSS file here. The URL of the external CSS file is specified with the External user stylesheet option set in Output Pages.

    If you choose to use Character Formatting, the types of character level formatting available are evident from the screen. Each type of formatting can be set to one of four values:

    • Always off - Forces the attribute to always be off when formatting the link.

    • Always on - Forces the attribute to always be on when formatting the link.