Show TOC

Entering DocumentationLocate this document in the navigation structure

Use

You can create a long text documentation in the system both for a BSP extension as well as for each BSP element that is contained in this extension. This documentation is of particular importance for the productive usage of the extension in BSP pages because you can include special aspects of the individual BSP elements here.

If you store the documentation in the system, it is then available to users through the context menu in the Tag Browser and also through insertion of the tag into a BSP page - also by pressing F1 in the layout editor.

Prerequisites
  • The BSP extension and the elements to be documented have already been created.

  • There are two different templates available for the BSP extension and the BSP elements. The procedure for creating the documentation is the same, however.

Procedure

To create documentation for a BSP element in SE80:

  1. Select the BSP extension in the Repository Browser.

  2. Double-click the required BSP element in the object list.

    The element editor is displayed.

  3. Go to Change mode.

  4. Click the Documentation pushbutton in the toolbar.

    The SAPScript Editor is called up and displays an empty template with predefined paragraphs.

  5. Write your text into the predefined paragraphs.

  6. Save the SAPScript document as a raw version first.

  7. Test the documentation and make whatever corrections are necessary.

  8. Save the document as active version.

Result

You have created a SAPScript document for the long text documentation of a BSP element and have assigned a transport request to it. If you have saved the document as an active version as well, this will be transported to the translation worklist.

Example

The documentation for all BSP elements is available for the BSP extension HTMLB.