SAP NEWS-71-DOCU documentation, setup help and example usage

ABAP Keyword Documentation in Release 7.0 EhP2
For release 7.0 EhP2 , the ABAP keyword documentation has been extended as follows:

1 ABAP Examples
2 Searching in Documentation
3 Syntax Diagrams
4 Downloading the Documentation
5 Independent HTML Versions of the Documentation
6 Hit List of F1 Help in the ABAP Editor
7 Printing Documentation
8 Display Language
9 Internal Performance Improvement


ABAP_MODIFICATION_1 ABAP Examples

The ABAP example library has been integrated into the ABAP keyword documentation. Executable example programs that until now have been called using transaction ABAPDOCU and are still valid, are now in the relevant topic of the tree structure of the ABAP keyword documentation and can be executed, debugged, or displayed in the corresponding editor from there. An alphabetical list of all the example programs can be found under ABAP examples . The example programs are included in index searches of the ABAP keyword documentation. The ABAPDOCU transaction now displays the ABAP keyword documentation.
The ABAP keyword documentation search options now include an option to search within source code in example programs.


ABAP_MODIFICATION_2 Searching in Documentation

The access to the search options in ABAP keyword documentation has been improved:
An input window is permanently shown in the documentation display. This window replaces the toolbar functions used previously.

If Quick Search is chosen (or Enter ), an index search is performed first, followed a full text search for the term entered.

If Extended Search is chosen, a dialog box appears where a search mode can be selected.

The source code of ABAP examples can now also be searched, as well as to using the existing index and full-text searches to search documentation text.
The display window of the search hit list now contains a function for opening the dialog box.
This dialog box allows new searches to be started in the hit list, without needing to return to the previous window.


ABAP_MODIFICATION_3 Syntax Diagrams

The syntax diagrams for the ABAP keywords are now displayed in a completely new way. Selecting a language element in a syntax diagram displays the corresponding documentation.
If a syntax diagram can be displayed for a keyword, a selectable icon is displayed in the title. A complete set of all the syntax diagrams can be found under ABAP Syntax Diagrams .


ABAP_MODIFICATION_4 Downloading the Documentation

The existing option for creating an offline version of the ABAP keyword documentation has been expanded as of SP02 to include the option of downloading nodes with subnodes.
With the previous offline version, all the documents of the ABAP keyword documentation are exported to individual HTML files that are managed by a separate tree display.
When nodes with subnodes are downloaded, the currently selected node, including subnodes, is exported into a single HTML file . Additional files are created only for possible displays. All the links work internally. If there is more than one node, an index is inserted at the beginning. By selecting the uppermost node, it is possible to download the entire ABAP keyword documentation into a file.
With both options, it is possible to specify whether the interactive examples are included in downloads.
When downloading to individual HTML files , it is possible to specify whether the new syntax diagrams are included. At selection, offline versions of the syntax diagrams are loaded into a subdirectory. These can then be selected using an icon as in the online version.


ABAP_MODIFICATION_5 Independent HTML Versions of the Documentation

From Release 7.0, EhP2 , AS ABAP provides the following services to allow the ABAP keyword documentation to be used independently of SAP GUI :
The remote enabled function module
ABAP_DOCU_GET_HTML returns documents of the ABAP keyword documentation as HTML files. Either search terms can be passed to the parameter QUERY or the names of documents to the parameter OBJECT ; passing "*" to OBJECT results in the tree-like documentation structure being sent.

Example :
Refer to the program
ABAP_DOCU_REMOTE_CALL . The loaded files are displayed here using the CL_ABAP_BROWSER class.

Under the node "/sap/public/bc/abap/docu" in transaction SICF , a service is provided to call the ABAP keyword documentation from the Web. On the initial screen , the tree structure of the documentation can be displayed or searches performed. The services "/sap/public/bc/abap/docu" and "/sap/bc/abap/docu" must be activated in transaction SICF . This version can also be used as a provider for OpenSearch.

Example :
Refer to the program
ABAP_DOCU_HTTP_CALL .


ABAP_MODIFICATION_6 Hit List of F1 Help in the ABAP Editor


When the F1 help for keywords is called, the hit list that uses the new ABAP Front-End Editor is more specific than the one that uses the old ABAP Editor. After selecting an operand, the search in the new ABAP Editor evaluates the adjacent ABAP words. As of Release 7.0 EhP2 , the selection of all operands produces a hit list. Previously, selecting = , + , and so on, displayed a dialog box with an input field. The latter also applies to the old ABAP Editor.


ABAP_MODIFICATION_7 Printing Documentation

As of Release 7.0 EhP2 , all documents for printing are formatted in HTML . The individual executable example programs from ABAP examples and the ABAP glossary can now also be printed. In addition, tabular displays are now aligned correctly on printouts.


ABAP_MODIFICATION_8 Display Languages

From Release 7.0 EhP2 , the language in which the documentation is displayed (English or German) can be configured by user, independently of the logon language. Any German developers developing in English, for example, can now display the most up-to-date documentation in its original language, German.
This user-specific setting is made when the documentation is displayed using the Settings for Display Window function, or in the initial window of the transaction ABAPHELP ; the system remembers this setting for each user. Until now, the language setting in the initial screen of ABAPHELP only applied to what was currently being viewed.


ABAP_MODIFICATION_9 Internal Performance Improvement

As of Release 7.0, EhP2 , large and unchangeable datasets of the ABAP keyword documentation, such as the ABAP Index or the ABAP Glossary, are downloaded into the shared memory. Here they are available to all users of the documentation. This leads to improvements in performance with regard to memory use and also improvements in downloading the documentation.