insert-topicref-next-to-context-node

Type: Operation

Inserts a new topicref next to the context node

Inserts the new topicref with the following steps:

  • Determines whether the new ref node should be a 'topicref' or a 'mapref'

  • Inserts the new ref node on the specified side next to the context node

  • Sets the cursor in the referenced document and scrolls it into view

This operation can directly be used as insertOperationName for browser modals. Make sure to also pass the side step data property to the modal step if you do this.

Imported operation data

  1. contextNodeId

    (Required)

    Type: NodeId

    The node next to which the topicref will be inserted

  2. documentId

    (Required)

    The document that the topicref will link to

  3. hierarchyNodeId

    (Optional)

    The ID of the hierarchy node representing the topicref next to which the new topicref will be placed. This disambiguates cases where documents appear in the hierarchy multiple times. For operations invoked from the structure view menu, this will be provided automatically.

  4. side

    (Required)

    Type: String

    Either 'before' or 'after', to indicate where the new topicref will be inserted in relation to the context node.

  5. targetHref

    (Required)

    Type: String

    The value of the href attribute for the new topicref