Help Texts for Web Dynpro Applications

Use

There are various ways end users can place short help texts in Web Dynpro applications (in various UI element views), and display longer documentation texts for a whole application or window.

You can also define help texts for Web Dynpro components and controllers in the system for use by developers.

Exception

For S4 HANA, quick help, input help, and Help Center links are not provided in the context menu. Neither is the API available with which the application can call quick help and the Help Center. Long texts of T100 messages cannot be displayed either in the message area or in the message log.

Procedure

Providing Help for Users

  • Quick Help

    You make help texts available directly on the user interface, which the user can display by choosing Show Quick Help in the context menu.

    You can make these quick help texts available as:

    • A separate UI element on your view with UI element Explanation. The text you define for this UI element is only displayed if the user has opted to show quick help.

      More information: Explanation UI Element

    • Additional text of a UI element, which is defined in property explanation of the respective UI element. The UI element is then displayed with a green underscore and when the cursor is placed on it, the relevant text is displayed.

      More information: Explanation Property

  • More Field Help

    You can use classic F1 help, which users can call by choosing "More Field Help" from the context menu.

    More information: Classic F1 Help

  • Help Links in the Help Center

    You make the Help Center available in your Web Dynpro application and set links to help texts in the Knowledge Warehouse.

    More information: Setting Help Links in the Help Center

Providing Help for Developers

In the system you can create developer documentation for Web Dynpro components and controllers. To do this, in the development environment use function Component Documentation or Controller Documentation in the respective component or controller.

Both these documentation classes can also be accessed using the documentation maintenance transaction (SE61) and single object editing.

  • WD

    Abbreviation for the documentation for components/component interfaces.

  • WC

    Abbreviation for the documentation for controllers (including component controllers, custom controllers, view controllers, and window controllers).

As with the other documentation objects in the system, these documentation objects are linked to the transport, correction and translation systems.

Example

You can find an example of this help link in the WDR_TEST_HELP component.

More Information

For more information about maintaining help links and displaying the help documentation, see SAP Notes 1338118 Information published on SAP site and 1253360 Information published on SAP site.

For more information about the Web Dynpro authoring environment, see Web Dynpro Text Browser.

For more information about translation issues, see Internationalization and Translation.

For information about the title in the Business Client see Page Header.