Skip to main content

FieldLogs

Generating Steps From a Reference Manual

You can add content from a Reference Manual to an already existing Template which is editable.

  1. From the main menu, go to Templates > Your Templates.

    Go_Templates_Your_Templates.png
  2. Select a private Template.

    Select_Editable_Template.png
  3. From the property pane, navigate to the tab Reference manuals.

    GenTemplateFromRefManual2.png
  4. Select a Reference Manual.

    Select_Reference_Manual.png

    Important

    The Reference Manual can be selected using the text filter. The list of Reference Manuals containing the typed text as part of the name is filtered.

    manual_filter.png

    The collapsed structure of the Reference Manual appears.

  5. Expand the structure of the Reference Manual.

    GenTemplateFromRefManualExpandedManual.png

    You can search for the required element or sub-element of the Reference Manual using the following options:

    • Search by code: Allows you to search the Reference Manual content using the Public key of the elements.

      SearchbyCode.png
    • Search by text: Allows you to search the Reference Manual content using keywords.

      SearchbyText.png

      The search highlights the relevant content of the Reference Manual.

  6. Right click on one of the following elements: Page Block, Task or Subtask.

    You can also generate a Step from a sub-element. In the below example Job Set-up, Procedure, and Closing are some sub-elements.

    RightClick.png

    The available options appear.

    AvailableOptions.png
  7. Click Generate Steps.

    ClickGenerateSteps.png
  8. Select where you want to insert the Steps.

    Select_Insertion_Step.png
  9. [Optional] Select a granularity level.

    Select_Granularity_Level_Generate_Steps.png

    Important

    The Default value generated by the system is the recommended value for granularity level.

    Note

    The granularity level defines the maximum number of sub-levels that the system will generate.

    If the reference manual contains more levels of Steps than the value defined here, the content of the child Steps belonging to the inner levels merge with the parent Step at the same level as the granularity level set.

    For example, if you select a granularity level of 3 and the Reference Manual contains 5 levels of Steps, the child Steps of level 4 and 5 are merged with the parent Step at level 3.

    Refmanual5steps.png
    stepsgenGL3.png

    The Granularity level of the Steps generation is available only for the Steps generated from Manuals of format SGML.

  10. [Optional] Expand the Options section and check the Exact links to the referenced content option.

    ExactLinks.png

    When the option is checked, the links in the Step redirect you to the content in the original version of the Reference Manual.

    When the option is not checked, the links in the Step redirect you to the content in the latest version of the Reference Manual.

  11. Click Generate.

    Click_Generate_Steps.png

    The Steps are added to the Template.

    Result_Steps_Generated.png