configureAsMapSheetFrame

Type: Function

How to get configureAsMapSheetFrame?

JavaScript

import configureAsMapSheetFrame from 'fontoxml-dita/src/configureAsMapSheetFrame.js'

Configure nodes matching the given selector to be displayed as sheet frames while only rendering specific children as content.

As DITA map and topichead elements contain certain children that should be shown inside the sheet frame (such as their title) and others that should not (such as nested topicrefs), the standard configureAsSheetFrame family does not suffice. This variation on the sheet frame family provides a selector that should be used to specify which children are rendered inside the sheet frame. For example:

Other

configureAsMapSheetFrame(sxModule, 'self::map', 'map', {
    defaultTextContainer: 'title',
    visibleChildSelectorOrNodeSpec: 'self::title',
    ...
});

configureAsMapSheetFrame(sxModule, 'self::topichead', 'topic group', {
    visibleChildSelectorOrNodeSpec: 'self::topicmeta',
    ...
});

Arguments

  1. sxModule

    (Required)

    Type: SxModule

  2. selector

    (Required)

    Type: XPathTest

  3. markupLabel

    (Required)

    Type: String

  4. options

    (Required)

    Properties