topic Questions about program documentation in Application Development and Automation Discussions

Questions about program documentation

Former Member — Wed, 12 Aug 2009 08:01:58 GMT

Hi there forum fellows,

I'd like to ask about program documentation which I'm able to create in SE38 (radio button 'Documentation')

1) How can I display the the documentation window from code? I mean which function module should I use to make eg.


IF (okcode = 'INFO') .
  display documentation .
ENDIF .

2) When I display the documentation in program there is a string "Report: (reportname)" in the first line, whilst that string is not visible it the documentation-edit mode. How can I get rid of that first line not to be displayed in documentation window?

I will be thankful for help and tips. Greetings. P.

Re: Questions about program documentation

Pawan_Kesari — Wed, 12 Aug 2009 08:10:25 GMT

CALL FUNCTION 'DSYS_SHOW_FOR_F1HELP'
      EXPORTING
           DOKCLASS           = 'RE'
           DOKNAME            = REPORT_NAME
           SHORT_TEXT         = 'X'
      EXCEPTIONS
           OTHERS             = 1.

Re: Questions about program documentation

Former Member — Wed, 12 Aug 2009 08:11:02 GMT

1) For your first requirement you may use call transaction SE38 and skip first screen.

2) The first line of the documentation is actually the title maintained in the program attributes. Since the title is a mandatory field, you cannot remove it. You may only change it to something more suitable.

Re: Questions about program documentation

RaymondGiuseppi — Wed, 12 Aug 2009 08:14:42 GMT

Look at FM DSYS_SHOW_FOR_F1HELP with

- DOKCLASS = 'RE'

- DOKLANGU = sy-langu (or language of the documentation)

- DOKNAME = sy-repid (mapped to another field)

- SHORT_TEXT = 'X' (window mode)

(keep default value for other parameters)

Regards,

Raymond

Re: Questions about program documentation

Former Member — Wed, 12 Aug 2009 08:16:57 GMT

If you create a documention it will just be available in selection-screen: if you press the icon for INFO it will be shown us the documentation.

So u shouldn't need to develop your own code to manage it.

If you need to show the documentation after running the report, there are fm like HLP_DOCULINES_SHOW in order to show it

2. I suppose the system uses it to write the description of the report

Max