Skip to content Skip to sidebar Skip to footer
Home / 13. Question in Order to Provide Context-sensitive Help

13. Question in Order to Provide Context-sensitive Help

Post a Comment

Understand the concepts of context-sensitive assistance and larn how to use information technology.

What is context-sensitive help

A context-sensitive help topic provides information nigh the user interface of an application relative to the chore your user performs. For example, context-sensitive assistance topics provide details nearly fields and controls in dialog boxes, descriptions of windows or screen objects, and explanations of messages. Your users access a context-sensitive assist topic past pressing F1, clicking a Aid button, selecting from a menu, or clicking a question-mark icon.

What is a map file

In RoboHelp, you piece of work with context-sensitive assist topics through map files in Output view. Yous can create, assign, unassign, edit, import, and export map files. A pairing of a map ID and map number for each topic is saved in map files.

A map ID and map number pairing inside a map file

Map ID Assign a unique map ID to each topic to display it in the CSH. For instance, ID_SetupScreen.

Map number A numeric value associated with a topic. Map numbers are used with applications to specify a topic for calling context-sensitive aid. For example, 101.

Whether application developers employ map numbers, map IDs, or both depends on the programming language they apply.

Topic Y'all can assign or unassign a topic against a map ID and number. For instance, SetupScreen.

Writer and developer tasks

Map files are used by authors and developers to build a context-sensitive aid for an application.

  • Writer Writes the Help topics that describe how to use application components such as windows, dialog boxes, fields, and controls.
  • Developer Builds the components (windows, dialogs, fields, controls) that make up the application.

An author can generate map files containing map IDs and requite them to the developer. Or, an author tin obtain map files from the developer.

To share map files, you can export a map file every bit a .h file in this format:

#ascertain ID_SetupScreen 101

Create a map file

  1. In the Output toolbar, click Map Files.

  2. In theMap Files panel, click at the pinnacle right corner and and then clickNew Map File.

  3. In theNew Map File dialog box, specify the proper noun of the map file.

    When creating filenames, utilize underscores instead of spaces, and avert using these illegal characters:
    \ / : * ? < > | # " $ & [ ]

  4. ClickWashed.

    RoboHelp places the map file in alphabetical order of filenames in the Map Files panel and opens the map file editor.

Edit a map file

  1. In the Output toolbar, click Map Files.

  2. In theMap Files panel, double-click the map file you desire to edit. Or chooseOptions > Edit against the map file.

    RoboHelp opens the map file editor with Contents console at the left and the fields Map ID, Map No., and Topic at the right.

  3. To map topics, you can follow ii approaches.

    Approach 1: To let RoboHelp automatically assign map IDs and map numbers, from the Contents panel, drag a topic and drop it beneath the field names in the map file editor.

    RoboHelp automatically maps the topic name as map ID. For the outset topic, the default map number is ane. You can edit the map ID and map numbers.

    Map file settings, if specified, are applicable to all topics that are dragged and dropped.

    Approach 2: If you want to specify a custom map ID or map number and separately assign a topic, do the post-obit:

    1. Blazon a map ID in the Map ID field and press Enter.

    2. Type a map number in the Map No. field and press Enter.

    3. Assign a topic by clicking at the correct side of the row.

    4. In the Insert Topic dialog box, search for a topic or select it from the Contents or Recently Used drop-down sections.

    5. Click Insert.

      The topic is assigned to the map ID and number, and the topic filename appears under the Topic field.

      To unassign a topic, click next to the topic name.

      To delete an entire row of map ID, map number, and topic, click in that row.

      Map file settings, if specified, are not applicable to topics that are assigned separately or to mappings defined before the settings were specified.

  4. You can modify both Map ID and Map No. fields.

Specify map file settings

Map file settings apply to topics that are dragged and dropped in the map file editor. To specify map file settings:

  1. In the Output toolbar, click Map Files.

  2. In the Map Files panel, right-click a map file and click Options. Or, against the map file, choose > Options.

  3. In the Mapping Options dialog box, practice the following:

    • Prefix Map ID With To automatically add together a prefix to all new map IDs, specify the prefix in this field.
    • Commencement Map Number From To automatically start map numbers from a specific number, specify the number in this field.
    • Create Map ID in uppercase Select this field to automatically create map IDs in uppercase.

Rename a map file

  1. In the Output toolbar, click Map Files.

  2. In the Map Files panel, right-click a map file and click Rename. Or, against the map file, choose > Rename.

  3. In theRename dialog box, specify a new name for the map file.

  4. Click Done.

    The updated proper name of the map file is shown in the Map Files panel.

Import a map file

Yous tin import a map file received from an writer or a programmer. To import a map file:

  1. In the Output toolbar, click Map Files.

  2. In the Map Files panel, click at the pinnacle right corner and click Import.

  3. In the Import dialog box, select the map file you want to import.

  4. Click Open.

    RoboHelp places the imported map file in alphabetical club of filenames in the Map Files panel.

Map numbers and topics IDs are stored in Map Files. After importing, users can make changes to these Map numbers and Map IDs in the Map Editor.

Consign a map file

You tin can export a map file to share it with an author or a developer. To consign a map file:

  1. In the Output toolbar, click Map Files.

  2. In the Map Files panel, right-click a map file and click Export. Or, confronting the map file, choose > Export.

  3. In the Consign dialog box, select a location at which y'all want to salvage the map file.

  4. Click Save.

    RoboHelp exports the map file at the selected location.

Delete a map file

To delete a map file, printing Delete. Or do the following:

  1. In the Output toolbar, click Map Files.

  2. In the Map Files console, right-click a map file and click Delete. Or, against the map file, cull > Delete.

  3. In theConfirm dialog box, clickYeah to confirm the deletion.

    The map file is deleted.

Locate a map file on your computer

To run into the location of a map file on your computer, do the post-obit:

  1. In the Output toolbar, click Map Files.

  2. In the Map Files console, right-click a map file and click Show in Explorer. Or, against the map file, cull > Show in Explorer.

    Windows Explorer opens to brandish the map file and its location.

hulmetrame1994.blogspot.com

Source: https://helpx.adobe.com/ca/robohelp/using/context-sensitive-help.html

Post a Comment for "13. Question in Order to Provide Context-sensitive Help"